Created
March 6, 2025 20:23
-
-
Save mherman22/351d8c16307b806cebc0f74ac5817856 to your computer and use it in GitHub Desktop.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "swagger" : "2.0", | |
| "info" : { | |
| "description" : "OpenMRS RESTful API documentation generated by Swagger", | |
| "version" : "2.8.0-42ce79", | |
| "title" : "OpenMRS API Docs", | |
| "contact" : { | |
| "name" : "OpenMRS", | |
| "url" : "http://openmrs.org" | |
| }, | |
| "license" : { | |
| "name" : "MPL-2.0 w/ HD", | |
| "url" : "http://openmrs.org/license" | |
| } | |
| }, | |
| "host" : "localhost:8080", | |
| "basePath" : "/openmrs/ws/rest/v1", | |
| "schemes" : [ "http" ], | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "security" : [ { | |
| "basic_auth" : [ ] | |
| }, { | |
| "basic_auth" : [ ] | |
| } ], | |
| "paths" : { | |
| "/hl7" : { | |
| "get" : { | |
| "tags" : [ "hl7" ], | |
| "summary" : "Fetch all non-retired hl7 resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllHL7Messages", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "hl7 response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/Hl7Get" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "hl7" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createHL7Message", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/Hl7Create" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "hl7 response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/conceptclass" : { | |
| "get" : { | |
| "tags" : [ "conceptclass" ], | |
| "summary" : "Fetch all non-retired conceptclass resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllConceptClasses", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "conceptclass response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ConceptclassGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "conceptclass" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createConceptClass", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ConceptclassCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "conceptclass response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/conceptclass/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "conceptclass" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getConceptClass", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "conceptclass response", | |
| "schema" : { | |
| "$ref" : "#/definitions/ConceptclassGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "conceptclass" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updateConceptClass", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ConceptclassUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "conceptclass response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "conceptclass" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteConceptClass", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/locationattributetype" : { | |
| "get" : { | |
| "tags" : [ "locationattributetype" ], | |
| "summary" : "Fetch all non-retired locationattributetype resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllLocationAttributeTypes", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "locationattributetype response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/LocationattributetypeGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "locationattributetype" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createLocationAttributeType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/LocationattributetypeCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "locationattributetype response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/locationattributetype/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "locationattributetype" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getLocationAttributeType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "locationattributetype response", | |
| "schema" : { | |
| "$ref" : "#/definitions/LocationattributetypeGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "locationattributetype" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updateLocationAttributeType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/LocationattributetypeUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "locationattributetype response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "locationattributetype" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteLocationAttributeType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/ordergroup" : { | |
| "get" : { | |
| "tags" : [ "ordergroup" ], | |
| "summary" : "Fetch all non-retired ordergroup resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllOrderGroups", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "ordergroup response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/OrdergroupGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "ordergroup" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createOrderGroup", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/OrdergroupCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "ordergroup response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/ordergroup/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "ordergroup" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getOrderGroup", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "ordergroup response", | |
| "schema" : { | |
| "$ref" : "#/definitions/OrdergroupGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "ordergroup" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updateOrderGroup", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/OrdergroupUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "ordergroup response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "ordergroup" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteOrderGroup", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/workflow" : { | |
| "get" : { | |
| "tags" : [ "workflow" ], | |
| "summary" : "Fetch all non-retired workflow resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllProgramWorkflows", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "workflow response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/WorkflowGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "workflow" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createProgramWorkflow", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/WorkflowCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "workflow response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/workflow/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "workflow" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getProgramWorkflow", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "workflow response", | |
| "schema" : { | |
| "$ref" : "#/definitions/WorkflowGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "workflow" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updateProgramWorkflow", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/WorkflowUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "workflow response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "workflow" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteProgramWorkflow", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/administrationlinks" : { | |
| "get" : { | |
| "tags" : [ "administrationlinks" ], | |
| "summary" : "Fetch all non-retired", | |
| "operationId" : "getAllAdministrationLinkses", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "administrationlinks response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/AdministrationlinksGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/administrationlinks/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "administrationlinks" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getAdministrationLinks", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "administrationlinks response", | |
| "schema" : { | |
| "$ref" : "#/definitions/AdministrationlinksGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/orderable" : { | |
| "get" : { | |
| "tags" : [ "orderable" ], | |
| "summary" : "Search for orderable", | |
| "description" : "At least one search parameter must be specified", | |
| "operationId" : "getAllOrderables", | |
| "produces" : [ "application/json", "application/xml" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "orderable response", | |
| "schema" : { | |
| "$ref" : "#/definitions/FetchAll" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/serverlog" : { | |
| "get" : { | |
| "tags" : [ "serverlog" ], | |
| "summary" : "Fetch all non-retired", | |
| "operationId" : "getAllServerLogs", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "serverlog response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ServerlogGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/serverlog/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "serverlog" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getServerLog", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "serverlog response", | |
| "schema" : { | |
| "$ref" : "#/definitions/ServerlogGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/drugreferencemap" : { | |
| "get" : { | |
| "tags" : [ "drugreferencemap" ], | |
| "summary" : "Fetch all non-retired drugreferencemap resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllDrugReferenceMaps", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "drugreferencemap response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/DrugreferencemapGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "drugreferencemap" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createDrugReferenceMap", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/DrugreferencemapCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "drugreferencemap response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/drugreferencemap/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "drugreferencemap" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getDrugReferenceMap", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "drugreferencemap response", | |
| "schema" : { | |
| "$ref" : "#/definitions/DrugreferencemapGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "drugreferencemap" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updateDrugReferenceMap", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/DrugreferencemapUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "drugreferencemap response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "drugreferencemap" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteDrugReferenceMap", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/concept" : { | |
| "get" : { | |
| "tags" : [ "concept" ], | |
| "summary" : "Fetch all non-retired concept resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllConcepts", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "code", | |
| "in" : "query", | |
| "description" : "Must be used with source", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "references", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "searchType", | |
| "in" : "query", | |
| "description" : "Must be used with name", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "name", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "term", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "source", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "class", | |
| "in" : "query", | |
| "description" : "Must be used with name", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "concept response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ConceptGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "concept" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createConcept", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ConceptCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "concept response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/concept/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "concept" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getConcept", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "concept response", | |
| "schema" : { | |
| "$ref" : "#/definitions/ConceptGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "concept" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updateConcept", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ConceptUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "concept response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "concept" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteConcept", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/conceptsource" : { | |
| "get" : { | |
| "tags" : [ "conceptsource" ], | |
| "summary" : "Fetch all non-retired conceptsource resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllConceptSources", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "conceptsource response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ConceptsourceGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "conceptsource" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createConceptSource", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ConceptsourceCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "conceptsource response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/conceptsource/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "conceptsource" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getConceptSource", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "conceptsource response", | |
| "schema" : { | |
| "$ref" : "#/definitions/ConceptsourceGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "conceptsource" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updateConceptSource", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ConceptsourceUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "conceptsource response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "conceptsource" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteConceptSource", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/hl7source" : { | |
| "get" : { | |
| "tags" : [ "hl7source" ], | |
| "summary" : "Fetch all non-retired hl7source resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllHL7Sources", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "hl7source response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/Hl7sourceGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "hl7source" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createHL7Source", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/Hl7sourceCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "hl7source response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/hl7source/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "hl7source" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getHL7Source", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "hl7source response", | |
| "schema" : { | |
| "$ref" : "#/definitions/Hl7sourceGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "hl7source" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updateHL7Source", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/Hl7sourceUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "hl7source response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "hl7source" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteHL7Source", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/moduleaction" : { | |
| "post" : { | |
| "tags" : [ "moduleaction" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createModuleAction", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ModuleactionCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "moduleaction response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/encounterrole" : { | |
| "get" : { | |
| "tags" : [ "encounterrole" ], | |
| "summary" : "Fetch all non-retired encounterrole resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllEncounterRoles", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "encounterrole response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/EncounterroleGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "encounterrole" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createEncounterRole", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/EncounterroleCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "encounterrole response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/encounterrole/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "encounterrole" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getEncounterRole", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "encounterrole response", | |
| "schema" : { | |
| "$ref" : "#/definitions/EncounterroleGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "encounterrole" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updateEncounterRole", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/EncounterroleUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "encounterrole response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "encounterrole" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteEncounterRole", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/conceptmaptype" : { | |
| "get" : { | |
| "tags" : [ "conceptmaptype" ], | |
| "summary" : "Fetch all non-retired conceptmaptype resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllConceptMapTypes", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "conceptmaptype response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ConceptmaptypeGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "conceptmaptype" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createConceptMapType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ConceptmaptypeCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "conceptmaptype response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/conceptmaptype/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "conceptmaptype" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getConceptMapType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "conceptmaptype response", | |
| "schema" : { | |
| "$ref" : "#/definitions/ConceptmaptypeGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "conceptmaptype" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updateConceptMapType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ConceptmaptypeUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "conceptmaptype response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "conceptmaptype" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteConceptMapType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/caresetting" : { | |
| "get" : { | |
| "tags" : [ "caresetting" ], | |
| "summary" : "Fetch all non-retired caresetting resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllCareSettings", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "caresetting response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/CaresettingGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/caresetting/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "caresetting" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getCareSetting", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "caresetting response", | |
| "schema" : { | |
| "$ref" : "#/definitions/CaresettingGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "caresetting" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteCareSetting", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/databasechange" : { | |
| "get" : { | |
| "tags" : [ "databasechange" ], | |
| "summary" : "Fetch all non-retired", | |
| "operationId" : "getAllDatabaseChanges", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "databasechange response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/DatabasechangeGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/databasechange/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "databasechange" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getDatabaseChange", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "databasechange response", | |
| "schema" : { | |
| "$ref" : "#/definitions/DatabasechangeGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/customdatatype" : { | |
| "get" : { | |
| "tags" : [ "customdatatype" ], | |
| "summary" : "Fetch all non-retired customdatatype resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllCustomDatatypes", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "customdatatype response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/CustomdatatypeGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/customdatatype/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "customdatatype" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getCustomDatatype", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "customdatatype response", | |
| "schema" : { | |
| "$ref" : "#/definitions/CustomdatatypeGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "customdatatype" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteCustomDatatype", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/module" : { | |
| "get" : { | |
| "tags" : [ "module" ], | |
| "summary" : "Fetch all non-retired", | |
| "operationId" : "getAllModules", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "module response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ModuleGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/module/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "module" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getModule", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "module response", | |
| "schema" : { | |
| "$ref" : "#/definitions/ModuleGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/conceptstateconversion" : { | |
| "get" : { | |
| "tags" : [ "conceptstateconversion" ], | |
| "summary" : "Fetch all non-retired conceptstateconversion resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllConceptStateConversions", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "conceptstateconversion response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ConceptstateconversionGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "conceptstateconversion" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createConceptStateConversion", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ConceptstateconversionCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "conceptstateconversion response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/conceptstateconversion/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "conceptstateconversion" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getConceptStateConversion", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "conceptstateconversion response", | |
| "schema" : { | |
| "$ref" : "#/definitions/ConceptstateconversionGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "conceptstateconversion" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updateConceptStateConversion", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ConceptstateconversionUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "conceptstateconversion response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "conceptstateconversion" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteConceptStateConversion", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/systemsetting" : { | |
| "get" : { | |
| "tags" : [ "systemsetting" ], | |
| "summary" : "Fetch all non-retired systemsetting resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllSystemSettings", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "systemsetting response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/SystemsettingGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "systemsetting" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createSystemSetting", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/SystemsettingCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "systemsetting response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/systemsetting/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "systemsetting" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getSystemSetting", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "systemsetting response", | |
| "schema" : { | |
| "$ref" : "#/definitions/SystemsettingGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "systemsetting" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updateSystemSetting", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/SystemsettingUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "systemsetting response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "systemsetting" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteSystemSetting", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/location" : { | |
| "get" : { | |
| "tags" : [ "location" ], | |
| "summary" : "Fetch all non-retired location resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllLocations", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "location response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/LocationGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "location" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createLocation", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/LocationCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "location response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/location/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "location" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getLocation", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "location response", | |
| "schema" : { | |
| "$ref" : "#/definitions/LocationGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "location" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updateLocation", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/LocationUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "location response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "location" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteLocation", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/conceptproposal" : { | |
| "get" : { | |
| "tags" : [ "conceptproposal" ], | |
| "summary" : "Fetch all non-retired conceptproposal resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllConceptProposals", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "conceptproposal response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ConceptproposalGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "conceptproposal" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createConceptProposal", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ConceptproposalCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "conceptproposal response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/conceptproposal/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "conceptproposal" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getConceptProposal", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "conceptproposal response", | |
| "schema" : { | |
| "$ref" : "#/definitions/ConceptproposalGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "conceptproposal" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updateConceptProposal", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ConceptproposalUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "conceptproposal response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "conceptproposal" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteConceptProposal", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/form" : { | |
| "get" : { | |
| "tags" : [ "form" ], | |
| "summary" : "Fetch all non-retired form resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllForms", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "published", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "form response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/FormGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "form" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createForm", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/FormCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "form response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/form/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "form" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getForm", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "form response", | |
| "schema" : { | |
| "$ref" : "#/definitions/FormGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "form" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updateForm", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/FormUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "form response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "form" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteForm", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/programattributetype" : { | |
| "get" : { | |
| "tags" : [ "programattributetype" ], | |
| "summary" : "Fetch all non-retired programattributetype resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllProgramAttributeTypes", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "programattributetype response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ProgramattributetypeGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "programattributetype" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createProgramAttributeType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ProgramattributetypeCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "programattributetype response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/programattributetype/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "programattributetype" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getProgramAttributeType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "programattributetype response", | |
| "schema" : { | |
| "$ref" : "#/definitions/ProgramattributetypeGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "programattributetype" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updateProgramAttributeType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ProgramattributetypeUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "programattributetype response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "programattributetype" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteProgramAttributeType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/visittype" : { | |
| "get" : { | |
| "tags" : [ "visittype" ], | |
| "summary" : "Fetch all non-retired visittype resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllVisitTypes", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "visittype response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/VisittypeGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "visittype" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createVisitType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/VisittypeCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "visittype response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/visittype/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "visittype" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getVisitType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "visittype response", | |
| "schema" : { | |
| "$ref" : "#/definitions/VisittypeGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "visittype" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updateVisitType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/VisittypeUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "visittype response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "visittype" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteVisitType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/orderfrequency" : { | |
| "get" : { | |
| "tags" : [ "orderfrequency" ], | |
| "summary" : "Fetch all non-retired orderfrequency resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllOrderFrequencies", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "orderfrequency response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/OrderfrequencyGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "orderfrequency" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createOrderFrequency", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/OrderfrequencyCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "orderfrequency response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/orderfrequency/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "orderfrequency" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getOrderFrequency", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "orderfrequency response", | |
| "schema" : { | |
| "$ref" : "#/definitions/OrderfrequencyGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "orderfrequency" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updateOrderFrequency", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/OrderfrequencyUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "orderfrequency response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "orderfrequency" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteOrderFrequency", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/user" : { | |
| "get" : { | |
| "tags" : [ "user" ], | |
| "summary" : "Fetch all non-retired user resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllUsers", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "username", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "user response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/UserGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "user" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createUser", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/UserCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "user response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/user/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "user" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getUser", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "user response", | |
| "schema" : { | |
| "$ref" : "#/definitions/UserGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "user" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updateUser", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/UserUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "user response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "user" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteUser", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/programenrollment" : { | |
| "get" : { | |
| "tags" : [ "programenrollment" ], | |
| "summary" : "Fetch all non-retired programenrollment resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllProgramEnrollments", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "programenrollment response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ProgramenrollmentGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "programenrollment" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createProgramEnrollment", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ProgramenrollmentCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "programenrollment response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/programenrollment/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "programenrollment" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getProgramEnrollment", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "programenrollment response", | |
| "schema" : { | |
| "$ref" : "#/definitions/ProgramenrollmentGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "programenrollment" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updateProgramEnrollment", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ProgramenrollmentUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "programenrollment response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "programenrollment" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteProgramEnrollment", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/visitattributetype" : { | |
| "get" : { | |
| "tags" : [ "visitattributetype" ], | |
| "summary" : "Fetch all non-retired visitattributetype resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllVisitAttributeTypes", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "visitattributetype response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/VisitattributetypeGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "visitattributetype" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createVisitAttributeType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/VisitattributetypeCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "visitattributetype response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/visitattributetype/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "visitattributetype" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getVisitAttributeType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "visitattributetype response", | |
| "schema" : { | |
| "$ref" : "#/definitions/VisitattributetypeGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "visitattributetype" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updateVisitAttributeType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/VisitattributetypeUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "visitattributetype response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "visitattributetype" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteVisitAttributeType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/patient" : { | |
| "get" : { | |
| "tags" : [ "patient" ], | |
| "summary" : "Fetch all non-retired patient resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllPatients", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "identifier", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "includeDead", | |
| "in" : "query", | |
| "description" : "Must be used with q", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "searchType", | |
| "in" : "query", | |
| "description" : "Must be used with identifier", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "patient response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/PatientGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "patient" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createPatient", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/PatientCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "patient response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/patient/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "patient" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getPatient", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "patient response", | |
| "schema" : { | |
| "$ref" : "#/definitions/PatientGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "patient" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updatePatient", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/PatientUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "patient response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "patient" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deletePatient", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/cohort" : { | |
| "get" : { | |
| "tags" : [ "cohort" ], | |
| "summary" : "Fetch all non-retired cohort resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllCohorts", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "cohort response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/CohortGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "cohort" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createCohort", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/CohortCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "cohort response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/cohort/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "cohort" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getCohort", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "cohort response", | |
| "schema" : { | |
| "$ref" : "#/definitions/CohortGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "cohort" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updateCohort", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/CohortUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "cohort response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "cohort" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteCohort", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/fieldtype" : { | |
| "get" : { | |
| "tags" : [ "fieldtype" ], | |
| "summary" : "Fetch all non-retired fieldtype resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllFieldTypes", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "fieldtype response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/FieldtypeGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "fieldtype" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createFieldType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/FieldtypeCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "fieldtype response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/fieldtype/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "fieldtype" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getFieldType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "fieldtype response", | |
| "schema" : { | |
| "$ref" : "#/definitions/FieldtypeGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "fieldtype" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updateFieldType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/FieldtypeUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "fieldtype response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "fieldtype" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteFieldType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/patientdiagnoses" : { | |
| "get" : { | |
| "tags" : [ "patientdiagnoses" ], | |
| "summary" : "Fetch all non-retired patientdiagnoses resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllDiagnoses", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "patientdiagnoses response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/PatientdiagnosesGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "patientdiagnoses" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createDiagnosis", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/PatientdiagnosesCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "patientdiagnoses response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/patientdiagnoses/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "patientdiagnoses" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getDiagnosis", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "patientdiagnoses response", | |
| "schema" : { | |
| "$ref" : "#/definitions/PatientdiagnosesGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "patientdiagnoses" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updateDiagnosis", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/PatientdiagnosesUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "patientdiagnoses response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "patientdiagnoses" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteDiagnosis", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/taskdefinition" : { | |
| "get" : { | |
| "tags" : [ "taskdefinition" ], | |
| "summary" : "Fetch all non-retired taskdefinition resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllTaskDefinitions", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "taskdefinition response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/TaskdefinitionGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "taskdefinition" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createTaskDefinition", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/TaskdefinitionCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "taskdefinition response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/taskdefinition/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "taskdefinition" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getTaskDefinition", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "taskdefinition response", | |
| "schema" : { | |
| "$ref" : "#/definitions/TaskdefinitionGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "taskdefinition" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updateTaskDefinition", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/TaskdefinitionUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "taskdefinition response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "taskdefinition" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteTaskDefinition", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/drug" : { | |
| "get" : { | |
| "tags" : [ "drug" ], | |
| "summary" : "Fetch all non-retired drug resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllDrugs", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "code", | |
| "in" : "query", | |
| "description" : "Must be used with source", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "preferredMapTypes", | |
| "in" : "query", | |
| "description" : "Must be used with source", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "source", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "locale", | |
| "in" : "query", | |
| "description" : "Must be used with q", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "exactLocale", | |
| "in" : "query", | |
| "description" : "Must be used with q", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "drug response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/DrugGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "drug" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createDrug", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/DrugCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "drug response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/drug/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "drug" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getDrug", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "drug response", | |
| "schema" : { | |
| "$ref" : "#/definitions/DrugGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "drug" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updateDrug", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/DrugUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "drug response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "drug" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteDrug", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/relationship" : { | |
| "get" : { | |
| "tags" : [ "relationship" ], | |
| "summary" : "Fetch all non-retired relationship resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllRelationships", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "personB", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "personA", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "person", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "relation", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "relatedPerson", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "relationship response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/RelationshipGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "relationship" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createRelationship", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/RelationshipCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "relationship response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/relationship/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "relationship" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getRelationship", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "relationship response", | |
| "schema" : { | |
| "$ref" : "#/definitions/RelationshipGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "relationship" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updateRelationship", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/RelationshipUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "relationship response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "relationship" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteRelationship", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/privilege" : { | |
| "get" : { | |
| "tags" : [ "privilege" ], | |
| "summary" : "Fetch all non-retired privilege resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllPrivileges", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "privilege response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/PrivilegeGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "privilege" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createPrivilege", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/PrivilegeCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "privilege response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/privilege/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "privilege" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getPrivilege", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "privilege response", | |
| "schema" : { | |
| "$ref" : "#/definitions/PrivilegeGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "privilege" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updatePrivilege", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/PrivilegeUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "privilege response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "privilege" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deletePrivilege", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/personattributetype" : { | |
| "get" : { | |
| "tags" : [ "personattributetype" ], | |
| "summary" : "Fetch all non-retired personattributetype resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllPersonAttributeTypes", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "personattributetype response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/PersonattributetypeGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "personattributetype" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createPersonAttributeType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/PersonattributetypeCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "personattributetype response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/personattributetype/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "personattributetype" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getPersonAttributeType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "personattributetype response", | |
| "schema" : { | |
| "$ref" : "#/definitions/PersonattributetypeGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "personattributetype" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updatePersonAttributeType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/PersonattributetypeUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "personattributetype response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "personattributetype" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deletePersonAttributeType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/conceptreferencetermmap" : { | |
| "get" : { | |
| "tags" : [ "conceptreferencetermmap" ], | |
| "summary" : "Fetch all non-retired conceptreferencetermmap resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllConceptReferenceTermMaps", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "maps", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "termB", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "termA", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "maptype", | |
| "in" : "query", | |
| "description" : "Must be used with maps", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "to", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "conceptreferencetermmap response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ConceptreferencetermmapGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "conceptreferencetermmap" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createConceptReferenceTermMap", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ConceptreferencetermmapCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "conceptreferencetermmap response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/conceptreferencetermmap/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "conceptreferencetermmap" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getConceptReferenceTermMap", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "conceptreferencetermmap response", | |
| "schema" : { | |
| "$ref" : "#/definitions/ConceptreferencetermmapGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "conceptreferencetermmap" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updateConceptReferenceTermMap", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ConceptreferencetermmapUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "conceptreferencetermmap response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "conceptreferencetermmap" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteConceptReferenceTermMap", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/encounter" : { | |
| "get" : { | |
| "tags" : [ "encounter" ], | |
| "summary" : "Fetch all non-retired encounter resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllEncounters", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "obsConcept", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "obsValues", | |
| "in" : "query", | |
| "description" : "Must be used with patient and obsConcept", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "todate", | |
| "in" : "query", | |
| "description" : "Must be used with patient", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "patient", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "visit", | |
| "in" : "query", | |
| "description" : "Must be used with patient", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "totalCount", | |
| "in" : "query", | |
| "description" : "Must be used with patient", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "encounterType", | |
| "in" : "query", | |
| "description" : "Must be used with patient", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "fromdate", | |
| "in" : "query", | |
| "description" : "Must be used with patient", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "order", | |
| "in" : "query", | |
| "description" : "Must be used with patient", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "encounter response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/EncounterGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "encounter" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createEncounter", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/EncounterCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "encounter response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/encounter/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "encounter" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getEncounter", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "encounter response", | |
| "schema" : { | |
| "$ref" : "#/definitions/EncounterGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "encounter" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updateEncounter", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/EncounterUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "encounter response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "encounter" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteEncounter", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/obstree" : { | |
| "get" : { | |
| "tags" : [ "obstree" ], | |
| "summary" : "Search for obstree", | |
| "description" : "At least one search parameter must be specified", | |
| "operationId" : "getAllObsTrees", | |
| "produces" : [ "application/json", "application/xml" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "obstree response", | |
| "schema" : { | |
| "$ref" : "#/definitions/FetchAll" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/field" : { | |
| "get" : { | |
| "tags" : [ "field" ], | |
| "summary" : "Fetch all non-retired field resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllFields", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "field response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/FieldGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "field" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createField", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/FieldCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "field response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/field/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "field" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getField", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "field response", | |
| "schema" : { | |
| "$ref" : "#/definitions/FieldGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "field" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updateField", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/FieldUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "field response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "field" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteField", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/ordertype" : { | |
| "get" : { | |
| "tags" : [ "ordertype" ], | |
| "summary" : "Fetch all non-retired ordertype resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllOrderTypes", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "ordertype response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/OrdertypeGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "ordertype" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createOrderType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/OrdertypeCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "ordertype response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/ordertype/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "ordertype" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getOrderType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "ordertype response", | |
| "schema" : { | |
| "$ref" : "#/definitions/OrdertypeGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "ordertype" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updateOrderType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/OrdertypeUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "ordertype response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "ordertype" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteOrderType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/condition" : { | |
| "get" : { | |
| "tags" : [ "condition" ], | |
| "summary" : "Fetch all non-retired condition resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllConditions", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "condition response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ConditionGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "condition" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createCondition", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ConditionCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "condition response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/condition/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "condition" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getCondition", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "condition response", | |
| "schema" : { | |
| "$ref" : "#/definitions/ConditionGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "condition" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updateCondition", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ConditionUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "condition response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "condition" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteCondition", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/providerattributetype" : { | |
| "get" : { | |
| "tags" : [ "providerattributetype" ], | |
| "summary" : "Fetch all non-retired providerattributetype resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllProviderAttributeTypes", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "providerattributetype response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ProviderattributetypeGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "providerattributetype" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createProviderAttributeType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ProviderattributetypeCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "providerattributetype response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/providerattributetype/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "providerattributetype" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getProviderAttributeType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "providerattributetype response", | |
| "schema" : { | |
| "$ref" : "#/definitions/ProviderattributetypeGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "providerattributetype" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updateProviderAttributeType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ProviderattributetypeUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "providerattributetype response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "providerattributetype" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteProviderAttributeType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/conceptdatatype" : { | |
| "get" : { | |
| "tags" : [ "conceptdatatype" ], | |
| "summary" : "Fetch all non-retired conceptdatatype resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllConceptDatatypes", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "conceptdatatype response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ConceptdatatypeGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/conceptdatatype/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "conceptdatatype" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getConceptDatatype", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "conceptdatatype response", | |
| "schema" : { | |
| "$ref" : "#/definitions/ConceptdatatypeGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "conceptdatatype" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteConceptDatatype", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/conceptreferenceterm" : { | |
| "get" : { | |
| "tags" : [ "conceptreferenceterm" ], | |
| "summary" : "Fetch all non-retired conceptreferenceterm resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllConceptReferenceTerms", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "codeOrName", | |
| "in" : "query", | |
| "description" : "Must be used with ", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "searchType", | |
| "in" : "query", | |
| "description" : "Must be used with ", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "source", | |
| "in" : "query", | |
| "description" : "Must be used with ", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "conceptreferenceterm response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ConceptreferencetermGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "conceptreferenceterm" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createConceptReferenceTerm", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ConceptreferencetermCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "conceptreferenceterm response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/conceptreferenceterm/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "conceptreferenceterm" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getConceptReferenceTerm", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "conceptreferenceterm response", | |
| "schema" : { | |
| "$ref" : "#/definitions/ConceptreferencetermGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "conceptreferenceterm" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updateConceptReferenceTerm", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ConceptreferencetermUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "conceptreferenceterm response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "conceptreferenceterm" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteConceptReferenceTerm", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/locationtag" : { | |
| "get" : { | |
| "tags" : [ "locationtag" ], | |
| "summary" : "Fetch all non-retired locationtag resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllLocationTags", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "locationtag response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/LocationtagGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "locationtag" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createLocationTag", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/LocationtagCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "locationtag response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/locationtag/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "locationtag" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getLocationTag", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "locationtag response", | |
| "schema" : { | |
| "$ref" : "#/definitions/LocationtagGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "locationtag" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updateLocationTag", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/LocationtagUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "locationtag response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "locationtag" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteLocationTag", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/conceptstopword" : { | |
| "get" : { | |
| "tags" : [ "conceptstopword" ], | |
| "summary" : "Fetch all non-retired conceptstopword resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllConceptStopwords", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "conceptstopword response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ConceptstopwordGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "conceptstopword" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createConceptStopword", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ConceptstopwordCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "conceptstopword response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/conceptstopword/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "conceptstopword" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getConceptStopword", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "conceptstopword response", | |
| "schema" : { | |
| "$ref" : "#/definitions/ConceptstopwordGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "conceptstopword" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updateConceptStopword", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ConceptstopwordUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "conceptstopword response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "conceptstopword" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteConceptStopword", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/person" : { | |
| "get" : { | |
| "tags" : [ "person" ], | |
| "summary" : "Fetch all non-retired person resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllPersons", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "person response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/PersonGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "person" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createPerson", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/PersonCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "person response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/person/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "person" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getPerson", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "person response", | |
| "schema" : { | |
| "$ref" : "#/definitions/PersonGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "person" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updatePerson", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/PersonUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "person response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "person" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deletePerson", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/orderset" : { | |
| "get" : { | |
| "tags" : [ "orderset" ], | |
| "summary" : "Fetch all non-retired orderset resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllOrderSets", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "orderset response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/OrdersetGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "orderset" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createOrderSet", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/OrdersetCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "orderset response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/orderset/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "orderset" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getOrderSet", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "orderset response", | |
| "schema" : { | |
| "$ref" : "#/definitions/OrdersetGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "orderset" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updateOrderSet", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/OrdersetUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "orderset response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "orderset" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteOrderSet", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/provider" : { | |
| "get" : { | |
| "tags" : [ "provider" ], | |
| "summary" : "Fetch all non-retired provider resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllProviders", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "user", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "provider response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ProviderGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "provider" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createProvider", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ProviderCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "provider response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/provider/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "provider" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getProvider", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "provider response", | |
| "schema" : { | |
| "$ref" : "#/definitions/ProviderGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "provider" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updateProvider", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ProviderUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "provider response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "provider" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteProvider", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/obs" : { | |
| "get" : { | |
| "tags" : [ "obs" ], | |
| "summary" : "Fetch all non-retired obs resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllObses", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "concepts", | |
| "in" : "query", | |
| "description" : "Must be used with patient", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "patient", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "concept", | |
| "in" : "query", | |
| "description" : "Must be used with patient", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "groupingConcepts", | |
| "in" : "query", | |
| "description" : "Must be used with patient", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "answers", | |
| "in" : "query", | |
| "description" : "Must be used with patient", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "obs response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ObsGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "obs" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createObs", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ObsCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "obs response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/obs/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "obs" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getObs", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "obs response", | |
| "schema" : { | |
| "$ref" : "#/definitions/ObsGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "obs" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updateObs", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ObsUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "obs response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "obs" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteObs", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/relationshiptype" : { | |
| "get" : { | |
| "tags" : [ "relationshiptype" ], | |
| "summary" : "Fetch all non-retired relationshiptype resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllRelationShipTypes", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "relationshiptype response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/RelationshiptypeGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "relationshiptype" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createRelationShipType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/RelationshiptypeCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "relationshiptype response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/relationshiptype/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "relationshiptype" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getRelationShipType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "relationshiptype response", | |
| "schema" : { | |
| "$ref" : "#/definitions/RelationshiptypeGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "relationshiptype" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updateRelationShipType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/RelationshiptypeUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "relationshiptype response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "relationshiptype" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteRelationShipType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/conceptattributetype" : { | |
| "get" : { | |
| "tags" : [ "conceptattributetype" ], | |
| "summary" : "Fetch all non-retired conceptattributetype resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllConceptAttributeTypes", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "conceptattributetype response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ConceptattributetypeGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "conceptattributetype" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createConceptAttributeType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ConceptattributetypeCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "conceptattributetype response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/conceptattributetype/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "conceptattributetype" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getConceptAttributeType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "conceptattributetype response", | |
| "schema" : { | |
| "$ref" : "#/definitions/ConceptattributetypeGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "conceptattributetype" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updateConceptAttributeType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ConceptattributetypeUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "conceptattributetype response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "conceptattributetype" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteConceptAttributeType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/taskaction" : { | |
| "post" : { | |
| "tags" : [ "taskaction" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createTaskAction", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/TaskactionCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "taskaction response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/taskaction/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "taskaction" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getTaskAction", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "taskaction response", | |
| "schema" : { | |
| "$ref" : "#/definitions/TaskactionGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/encountertype" : { | |
| "get" : { | |
| "tags" : [ "encountertype" ], | |
| "summary" : "Fetch all non-retired encountertype resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllEncounterTypes", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "encountertype response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/EncountertypeGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "encountertype" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createEncounterType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/EncountertypeCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "encountertype response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/encountertype/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "encountertype" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getEncounterType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "encountertype response", | |
| "schema" : { | |
| "$ref" : "#/definitions/EncountertypeGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "encountertype" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updateEncounterType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/EncountertypeUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "encountertype response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "encountertype" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteEncounterType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/program" : { | |
| "get" : { | |
| "tags" : [ "program" ], | |
| "summary" : "Fetch all non-retired program resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllPrograms", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "program response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ProgramGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "program" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createProgram", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ProgramCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "program response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/program/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "program" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getProgram", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "program response", | |
| "schema" : { | |
| "$ref" : "#/definitions/ProgramGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "program" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updateProgram", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ProgramUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "program response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "program" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteProgram", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/order" : { | |
| "get" : { | |
| "tags" : [ "order" ], | |
| "summary" : "Fetch all non-retired order resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllOrders", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "t", | |
| "in" : "query", | |
| "description" : "The type of Subclass Resource to return", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "orderNumber", | |
| "in" : "query", | |
| "description" : "Must be used with ", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "isStopped", | |
| "in" : "query", | |
| "description" : "Must be used with ", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "includeVoided", | |
| "in" : "query", | |
| "description" : "Must be used with ", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "excludeDiscontinueOrders", | |
| "in" : "query", | |
| "description" : "Must be used with ", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "accessionNumber", | |
| "in" : "query", | |
| "description" : "Must be used with ", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "fulfillerStatus", | |
| "in" : "query", | |
| "description" : "Must be used with ", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "excludeCanceledAndExpired", | |
| "in" : "query", | |
| "description" : "Must be used with ", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "careSetting", | |
| "in" : "query", | |
| "description" : "Must be used with ", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "concepts", | |
| "in" : "query", | |
| "description" : "Must be used with ", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "autoExpireOnOrBeforeDate", | |
| "in" : "query", | |
| "description" : "Must be used with ", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "patient", | |
| "in" : "query", | |
| "description" : "Must be used with ", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "orderTypes", | |
| "in" : "query", | |
| "description" : "Must be used with ", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "activatedOnOrBeforeDate", | |
| "in" : "query", | |
| "description" : "Must be used with ", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "action", | |
| "in" : "query", | |
| "description" : "Must be used with ", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "canceledOrExpiredOnOrBeforeDate", | |
| "in" : "query", | |
| "description" : "Must be used with ", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "includeNullFulfillerStatus", | |
| "in" : "query", | |
| "description" : "Must be used with ", | |
| "required" : false, | |
| "type" : "string" | |
| }, { | |
| "name" : "activatedOnOrAfterDate", | |
| "in" : "query", | |
| "description" : "Must be used with ", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "order response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/OrderGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "order" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createOrder", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/OrderCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "order response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/order/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "order" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getOrder", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "order response", | |
| "schema" : { | |
| "$ref" : "#/definitions/OrderGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "order" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteOrder", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/visit" : { | |
| "get" : { | |
| "tags" : [ "visit" ], | |
| "summary" : "Fetch all non-retired visit resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllVisits", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "visit response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/VisitGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "visit" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createVisit", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/VisitCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "visit response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/visit/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "visit" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getVisit", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "visit response", | |
| "schema" : { | |
| "$ref" : "#/definitions/VisitGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "visit" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updateVisit", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/VisitUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "visit response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "visit" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteVisit", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/patientidentifiertype" : { | |
| "get" : { | |
| "tags" : [ "patientidentifiertype" ], | |
| "summary" : "Fetch all non-retired patientidentifiertype resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllPatientIdentifierTypes", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "patientidentifiertype response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/PatientidentifiertypeGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "patientidentifiertype" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createPatientIdentifierType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/PatientidentifiertypeCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "patientidentifiertype response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/patientidentifiertype/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "patientidentifiertype" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getPatientIdentifierType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "patientidentifiertype response", | |
| "schema" : { | |
| "$ref" : "#/definitions/PatientidentifiertypeGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "patientidentifiertype" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updatePatientIdentifierType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/PatientidentifiertypeUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "patientidentifiertype response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "patientidentifiertype" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deletePatientIdentifierType", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/alert" : { | |
| "get" : { | |
| "tags" : [ "alert" ], | |
| "summary" : "Fetch all non-retired alert resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllAlerts", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "alert response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/AlertGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "alert" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createAlert", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/AlertCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "alert response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/alert/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "alert" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getAlert", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "alert response", | |
| "schema" : { | |
| "$ref" : "#/definitions/AlertGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "alert" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updateAlert", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/AlertUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "alert response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "alert" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteAlert", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/role" : { | |
| "get" : { | |
| "tags" : [ "role" ], | |
| "summary" : "Fetch all non-retired role resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllRoles", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "role response", | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/RoleGet" | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "role" ], | |
| "summary" : "Create with properties in request", | |
| "operationId" : "createRole", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/RoleCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "role response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/role/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "role" ], | |
| "summary" : "Fetch by uuid", | |
| "operationId" : "getRole", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "role response", | |
| "schema" : { | |
| "$ref" : "#/definitions/RoleGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "role" ], | |
| "summary" : "Edit with given uuid, only modifying properties in request", | |
| "operationId" : "updateRole", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/RoleUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "role response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "role" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteRole", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/order/{parent-uuid}/fulfillerdetails" : { | |
| "post" : { | |
| "tags" : [ "order" ], | |
| "summary" : "Create fulfillerdetails subresource with properties in request", | |
| "operationId" : "createFulfillerDetails", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/OrderFulfillerdetailsCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "fulfillerdetails response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/concept/{parent-uuid}/name" : { | |
| "get" : { | |
| "tags" : [ "concept" ], | |
| "summary" : "Fetch all non-retired name subresources", | |
| "operationId" : "getAllConceptNames", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "name response", | |
| "schema" : { | |
| "type" : "object", | |
| "properties" : { | |
| "results" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ConceptNameGet" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "concept" ], | |
| "summary" : "Create name subresource with properties in request", | |
| "operationId" : "createConceptName", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ConceptNameCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "name response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/concept/{parent-uuid}/name/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "concept" ], | |
| "summary" : "Fetch name subresources by uuid", | |
| "operationId" : "getConceptName", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "name response", | |
| "schema" : { | |
| "$ref" : "#/definitions/ConceptNameGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "concept" ], | |
| "summary" : "edit name subresource with given uuid, only modifying properties in request", | |
| "operationId" : "updateConceptName", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ConceptNameUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "name response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "concept" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteConceptName", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/concept/{parent-uuid}/attribute" : { | |
| "get" : { | |
| "tags" : [ "concept" ], | |
| "summary" : "Fetch all non-retired attribute subresources", | |
| "operationId" : "getAllConceptAttributes", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "attribute response", | |
| "schema" : { | |
| "type" : "object", | |
| "properties" : { | |
| "results" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ConceptAttributeGet" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "concept" ], | |
| "summary" : "Create attribute subresource with properties in request", | |
| "operationId" : "createConceptAttribute", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ConceptAttributeCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "attribute response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/concept/{parent-uuid}/attribute/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "concept" ], | |
| "summary" : "Fetch attribute subresources by uuid", | |
| "operationId" : "getConceptAttribute", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "attribute response", | |
| "schema" : { | |
| "$ref" : "#/definitions/ConceptAttributeGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "concept" ], | |
| "summary" : "edit attribute subresource with given uuid, only modifying properties in request", | |
| "operationId" : "updateConceptAttribute", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ConceptAttributeUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "attribute response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "concept" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteConceptAttribute", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/person/{parent-uuid}/address" : { | |
| "get" : { | |
| "tags" : [ "person" ], | |
| "summary" : "Fetch all non-retired address subresources", | |
| "operationId" : "getAllPersonAddresses", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "address response", | |
| "schema" : { | |
| "type" : "object", | |
| "properties" : { | |
| "results" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/PersonAddressGet" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "person" ], | |
| "summary" : "Create address subresource with properties in request", | |
| "operationId" : "createPersonAddress", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/PersonAddressCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "address response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/person/{parent-uuid}/address/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "person" ], | |
| "summary" : "Fetch address subresources by uuid", | |
| "operationId" : "getPersonAddress", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "address response", | |
| "schema" : { | |
| "$ref" : "#/definitions/PersonAddressGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "person" ], | |
| "summary" : "edit address subresource with given uuid, only modifying properties in request", | |
| "operationId" : "updatePersonAddress", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/PersonAddressUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "address response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "person" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deletePersonAddress", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/form/{parent-uuid}/resource" : { | |
| "get" : { | |
| "tags" : [ "form" ], | |
| "summary" : "Fetch all non-retired resource subresources", | |
| "operationId" : "getAllFormResources", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "resource response", | |
| "schema" : { | |
| "type" : "object", | |
| "properties" : { | |
| "results" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/FormResourceGet" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "form" ], | |
| "summary" : "Create resource subresource with properties in request", | |
| "operationId" : "createFormResource", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/FormResourceCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "resource response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/form/{parent-uuid}/resource/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "form" ], | |
| "summary" : "Fetch resource subresources by uuid", | |
| "operationId" : "getFormResource", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "resource response", | |
| "schema" : { | |
| "$ref" : "#/definitions/FormResourceGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "form" ], | |
| "summary" : "edit resource subresource with given uuid, only modifying properties in request", | |
| "operationId" : "updateFormResource", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/FormResourceUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "resource response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "form" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteFormResource", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/location/{parent-uuid}/attribute" : { | |
| "get" : { | |
| "tags" : [ "location" ], | |
| "summary" : "Fetch all non-retired attribute resources or perform search", | |
| "description" : "All search parameters are optional", | |
| "operationId" : "getAllLocationAttributes", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| }, { | |
| "name" : "q", | |
| "in" : "query", | |
| "description" : "The search query", | |
| "required" : false, | |
| "type" : "string" | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "attribute response", | |
| "schema" : { | |
| "type" : "object", | |
| "properties" : { | |
| "results" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/LocationAttributeGet" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "location" ], | |
| "summary" : "Create attribute subresource with properties in request", | |
| "operationId" : "createLocationAttribute", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/LocationAttributeCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "attribute response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/location/{parent-uuid}/attribute/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "location" ], | |
| "summary" : "Fetch attribute subresources by uuid", | |
| "operationId" : "getLocationAttribute", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "attribute response", | |
| "schema" : { | |
| "$ref" : "#/definitions/LocationAttributeGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "location" ], | |
| "summary" : "edit attribute subresource with given uuid, only modifying properties in request", | |
| "operationId" : "updateLocationAttribute", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/LocationAttributeUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "attribute response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "location" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteLocationAttribute", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/cohort/{parent-uuid}/membership" : { | |
| "get" : { | |
| "tags" : [ "cohort" ], | |
| "summary" : "Fetch all non-retired membership subresources", | |
| "operationId" : "getAllCohortMemberships", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "membership response", | |
| "schema" : { | |
| "type" : "object", | |
| "properties" : { | |
| "results" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/CohortMembershipGet" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "cohort" ], | |
| "summary" : "Create membership subresource with properties in request", | |
| "operationId" : "createCohortMembership", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/CohortMembershipCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "membership response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/cohort/{parent-uuid}/membership/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "cohort" ], | |
| "summary" : "Fetch membership subresources by uuid", | |
| "operationId" : "getCohortMembership", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "membership response", | |
| "schema" : { | |
| "$ref" : "#/definitions/CohortMembershipGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "cohort" ], | |
| "summary" : "edit membership subresource with given uuid, only modifying properties in request", | |
| "operationId" : "updateCohortMembership", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/CohortMembershipUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "membership response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "cohort" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteCohortMembership", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/person/{parent-uuid}/attribute" : { | |
| "get" : { | |
| "tags" : [ "person" ], | |
| "summary" : "Fetch all non-retired attribute subresources", | |
| "operationId" : "getAllPersonAttributes", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "attribute response", | |
| "schema" : { | |
| "type" : "object", | |
| "properties" : { | |
| "results" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/PersonAttributeGet" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "person" ], | |
| "summary" : "Create attribute subresource with properties in request", | |
| "operationId" : "createPersonAttribute", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/PersonAttributeCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "attribute response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/person/{parent-uuid}/attribute/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "person" ], | |
| "summary" : "Fetch attribute subresources by uuid", | |
| "operationId" : "getPersonAttribute", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "attribute response", | |
| "schema" : { | |
| "$ref" : "#/definitions/PersonAttributeGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "person" ], | |
| "summary" : "edit attribute subresource with given uuid, only modifying properties in request", | |
| "operationId" : "updatePersonAttribute", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/PersonAttributeUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "attribute response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "person" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deletePersonAttribute", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/patient/{parent-uuid}/identifier" : { | |
| "get" : { | |
| "tags" : [ "patient" ], | |
| "summary" : "Fetch all non-retired identifier subresources", | |
| "operationId" : "getAllPatientIdentifiers", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "identifier response", | |
| "schema" : { | |
| "type" : "object", | |
| "properties" : { | |
| "results" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/PatientIdentifierGet" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "patient" ], | |
| "summary" : "Create identifier subresource with properties in request", | |
| "operationId" : "createPatientIdentifier", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/PatientIdentifierCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "identifier response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/patient/{parent-uuid}/identifier/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "patient" ], | |
| "summary" : "Fetch identifier subresources by uuid", | |
| "operationId" : "getPatientIdentifier", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "identifier response", | |
| "schema" : { | |
| "$ref" : "#/definitions/PatientIdentifierGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "patient" ], | |
| "summary" : "edit identifier subresource with given uuid, only modifying properties in request", | |
| "operationId" : "updatePatientIdentifier", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/PatientIdentifierUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "identifier response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "patient" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deletePatientIdentifier", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/concept/{parent-uuid}/description" : { | |
| "get" : { | |
| "tags" : [ "concept" ], | |
| "summary" : "Fetch all non-retired description subresources", | |
| "operationId" : "getAllConceptDescriptions", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "description response", | |
| "schema" : { | |
| "type" : "object", | |
| "properties" : { | |
| "results" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ConceptDescriptionGet" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "concept" ], | |
| "summary" : "Create description subresource with properties in request", | |
| "operationId" : "createConceptDescription", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ConceptDescriptionCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "description response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/concept/{parent-uuid}/description/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "concept" ], | |
| "summary" : "Fetch description subresources by uuid", | |
| "operationId" : "getConceptDescription", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "description response", | |
| "schema" : { | |
| "$ref" : "#/definitions/ConceptDescriptionGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "concept" ], | |
| "summary" : "edit description subresource with given uuid, only modifying properties in request", | |
| "operationId" : "updateConceptDescription", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ConceptDescriptionUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "description response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "concept" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteConceptDescription", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/concept/{parent-uuid}/mapping" : { | |
| "get" : { | |
| "tags" : [ "concept" ], | |
| "summary" : "Fetch all non-retired mapping subresources", | |
| "operationId" : "getAllConceptMaps", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "mapping response", | |
| "schema" : { | |
| "type" : "object", | |
| "properties" : { | |
| "results" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ConceptMappingGet" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "concept" ], | |
| "summary" : "Create mapping subresource with properties in request", | |
| "operationId" : "createConceptMap", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ConceptMappingCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "mapping response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/concept/{parent-uuid}/mapping/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "concept" ], | |
| "summary" : "Fetch mapping subresources by uuid", | |
| "operationId" : "getConceptMap", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "mapping response", | |
| "schema" : { | |
| "$ref" : "#/definitions/ConceptMappingGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "concept" ], | |
| "summary" : "edit mapping subresource with given uuid, only modifying properties in request", | |
| "operationId" : "updateConceptMap", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ConceptMappingUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "mapping response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "concept" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteConceptMap", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/alert/{parent-uuid}/recipient" : { | |
| "get" : { | |
| "tags" : [ "alert" ], | |
| "summary" : "Fetch all non-retired recipient subresources", | |
| "operationId" : "getAllAlertRecipients", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "recipient response", | |
| "schema" : { | |
| "type" : "object", | |
| "properties" : { | |
| "results" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/AlertRecipientGet" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "alert" ], | |
| "summary" : "Create recipient subresource with properties in request", | |
| "operationId" : "createAlertRecipient", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/AlertRecipientCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "recipient response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/alert/{parent-uuid}/recipient/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "alert" ], | |
| "summary" : "Fetch recipient subresources by uuid", | |
| "operationId" : "getAlertRecipient", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "recipient response", | |
| "schema" : { | |
| "$ref" : "#/definitions/AlertRecipientGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "alert" ], | |
| "summary" : "edit recipient subresource with given uuid, only modifying properties in request", | |
| "operationId" : "updateAlertRecipient", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/AlertRecipientUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "recipient response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "alert" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteAlertRecipient", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/customdatatype/{parent-uuid}/handlers" : { | |
| "get" : { | |
| "tags" : [ "customdatatype" ], | |
| "summary" : "Fetch all non-retired handlers subresources", | |
| "operationId" : "getAllCustomDatatypeHandlers", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "handlers response", | |
| "schema" : { | |
| "type" : "object", | |
| "properties" : { | |
| "results" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/CustomdatatypeHandlersGet" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/person/{parent-uuid}/name" : { | |
| "get" : { | |
| "tags" : [ "person" ], | |
| "summary" : "Fetch all non-retired name subresources", | |
| "operationId" : "getAllPersonNames", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "name response", | |
| "schema" : { | |
| "type" : "object", | |
| "properties" : { | |
| "results" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/PersonNameGet" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "person" ], | |
| "summary" : "Create name subresource with properties in request", | |
| "operationId" : "createPersonName", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/PersonNameCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "name response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/person/{parent-uuid}/name/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "person" ], | |
| "summary" : "Fetch name subresources by uuid", | |
| "operationId" : "getPersonName", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "name response", | |
| "schema" : { | |
| "$ref" : "#/definitions/PersonNameGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "person" ], | |
| "summary" : "edit name subresource with given uuid, only modifying properties in request", | |
| "operationId" : "updatePersonName", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/PersonNameUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "name response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "person" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deletePersonName", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/visit/{parent-uuid}/attribute" : { | |
| "get" : { | |
| "tags" : [ "visit" ], | |
| "summary" : "Fetch all non-retired attribute subresources", | |
| "operationId" : "getAllVisitAttributes", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "attribute response", | |
| "schema" : { | |
| "type" : "object", | |
| "properties" : { | |
| "results" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/VisitAttributeGet" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "visit" ], | |
| "summary" : "Create attribute subresource with properties in request", | |
| "operationId" : "createVisitAttribute", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/VisitAttributeCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "attribute response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/visit/{parent-uuid}/attribute/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "visit" ], | |
| "summary" : "Fetch attribute subresources by uuid", | |
| "operationId" : "getVisitAttribute", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "attribute response", | |
| "schema" : { | |
| "$ref" : "#/definitions/VisitAttributeGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "visit" ], | |
| "summary" : "edit attribute subresource with given uuid, only modifying properties in request", | |
| "operationId" : "updateVisitAttribute", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/VisitAttributeUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "attribute response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "visit" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteVisitAttribute", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/orderset/{parent-uuid}/ordersetmember" : { | |
| "get" : { | |
| "tags" : [ "orderset" ], | |
| "summary" : "Fetch all non-retired ordersetmember subresources", | |
| "operationId" : "getAllOrderSetMembers", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "ordersetmember response", | |
| "schema" : { | |
| "type" : "object", | |
| "properties" : { | |
| "results" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/OrdersetOrdersetmemberGet" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "orderset" ], | |
| "summary" : "Create ordersetmember subresource with properties in request", | |
| "operationId" : "createOrderSetMember", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/OrdersetOrdersetmemberCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "ordersetmember response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/orderset/{parent-uuid}/ordersetmember/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "orderset" ], | |
| "summary" : "Fetch ordersetmember subresources by uuid", | |
| "operationId" : "getOrderSetMember", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "ordersetmember response", | |
| "schema" : { | |
| "$ref" : "#/definitions/OrdersetOrdersetmemberGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "orderset" ], | |
| "summary" : "edit ordersetmember subresource with given uuid, only modifying properties in request", | |
| "operationId" : "updateOrderSetMember", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/OrdersetOrdersetmemberUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "ordersetmember response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "orderset" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteOrderSetMember", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/programenrollment/{parent-uuid}/state" : { | |
| "post" : { | |
| "tags" : [ "programenrollment" ], | |
| "summary" : "Create state subresource with properties in request", | |
| "operationId" : "createPatientState", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ProgramenrollmentStateCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "state response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/programenrollment/{parent-uuid}/state/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "programenrollment" ], | |
| "summary" : "Fetch state subresources by uuid", | |
| "operationId" : "getPatientState", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "state response", | |
| "schema" : { | |
| "$ref" : "#/definitions/ProgramenrollmentStateGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "programenrollment" ], | |
| "summary" : "edit state subresource with given uuid, only modifying properties in request", | |
| "operationId" : "updatePatientState", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ProgramenrollmentStateUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "state response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "programenrollment" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deletePatientState", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/workflow/{parent-uuid}/state" : { | |
| "get" : { | |
| "tags" : [ "workflow" ], | |
| "summary" : "Fetch all non-retired state subresources", | |
| "operationId" : "getAllProgramWorkflowStates", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "state response", | |
| "schema" : { | |
| "type" : "object", | |
| "properties" : { | |
| "results" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/WorkflowStateGet" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "workflow" ], | |
| "summary" : "Create state subresource with properties in request", | |
| "operationId" : "createProgramWorkflowState", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/WorkflowStateCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "state response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/workflow/{parent-uuid}/state/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "workflow" ], | |
| "summary" : "Fetch state subresources by uuid", | |
| "operationId" : "getProgramWorkflowState", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "state response", | |
| "schema" : { | |
| "$ref" : "#/definitions/WorkflowStateGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "workflow" ], | |
| "summary" : "edit state subresource with given uuid, only modifying properties in request", | |
| "operationId" : "updateProgramWorkflowState", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/WorkflowStateUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "state response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "workflow" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteProgramWorkflowState", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/patient/{parent-uuid}/allergy" : { | |
| "post" : { | |
| "tags" : [ "patient" ], | |
| "summary" : "Create allergy subresource with properties in request", | |
| "operationId" : "createPatientAllergy", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/PatientAllergyCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "allergy response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/patient/{parent-uuid}/allergy/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "patient" ], | |
| "summary" : "Fetch allergy subresources by uuid", | |
| "operationId" : "getPatientAllergy", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "allergy response", | |
| "schema" : { | |
| "$ref" : "#/definitions/PatientAllergyGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "patient" ], | |
| "summary" : "edit allergy subresource with given uuid, only modifying properties in request", | |
| "operationId" : "updatePatientAllergy", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/PatientAllergyUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "allergy response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "patient" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deletePatientAllergy", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/drug/{parent-uuid}/ingredient" : { | |
| "get" : { | |
| "tags" : [ "drug" ], | |
| "summary" : "Fetch all non-retired ingredient subresources", | |
| "operationId" : "getAllDrugIngredients", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "ingredient response", | |
| "schema" : { | |
| "type" : "object", | |
| "properties" : { | |
| "results" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/DrugIngredientGet" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "drug" ], | |
| "summary" : "Create ingredient subresource with properties in request", | |
| "operationId" : "createDrugIngredient", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/DrugIngredientCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "ingredient response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/drug/{parent-uuid}/ingredient/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "drug" ], | |
| "summary" : "Fetch ingredient subresources by uuid", | |
| "operationId" : "getDrugIngredient", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "ingredient response", | |
| "schema" : { | |
| "$ref" : "#/definitions/DrugIngredientGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "drug" ], | |
| "summary" : "edit ingredient subresource with given uuid, only modifying properties in request", | |
| "operationId" : "updateDrugIngredient", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/DrugIngredientUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "ingredient response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "drug" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteDrugIngredient", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/encounter/{parent-uuid}/encounterprovider" : { | |
| "get" : { | |
| "tags" : [ "encounter" ], | |
| "summary" : "Fetch all non-retired encounterprovider subresources", | |
| "operationId" : "getAllEncounterProviders", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "encounterprovider response", | |
| "schema" : { | |
| "type" : "object", | |
| "properties" : { | |
| "results" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/EncounterEncounterproviderGet" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "encounter" ], | |
| "summary" : "Create encounterprovider subresource with properties in request", | |
| "operationId" : "createEncounterProvider", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/EncounterEncounterproviderCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "encounterprovider response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/encounter/{parent-uuid}/encounterprovider/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "encounter" ], | |
| "summary" : "Fetch encounterprovider subresources by uuid", | |
| "operationId" : "getEncounterProvider", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "encounterprovider response", | |
| "schema" : { | |
| "$ref" : "#/definitions/EncounterEncounterproviderGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "encounter" ], | |
| "summary" : "edit encounterprovider subresource with given uuid, only modifying properties in request", | |
| "operationId" : "updateEncounterProvider", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/EncounterEncounterproviderUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "encounterprovider response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "encounter" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteEncounterProvider", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/field/{parent-uuid}/answer" : { | |
| "get" : { | |
| "tags" : [ "field" ], | |
| "summary" : "Fetch all non-retired answer subresources", | |
| "operationId" : "getAllFieldAnswers", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "answer response", | |
| "schema" : { | |
| "type" : "object", | |
| "properties" : { | |
| "results" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/FieldAnswerGet" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "field" ], | |
| "summary" : "Create answer subresource with properties in request", | |
| "operationId" : "createFieldAnswer", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/FieldAnswerCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "answer response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/field/{parent-uuid}/answer/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "field" ], | |
| "summary" : "Fetch answer subresources by uuid", | |
| "operationId" : "getFieldAnswer", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "answer response", | |
| "schema" : { | |
| "$ref" : "#/definitions/FieldAnswerGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "field" ], | |
| "summary" : "edit answer subresource with given uuid, only modifying properties in request", | |
| "operationId" : "updateFieldAnswer", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/FieldAnswerUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "answer response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "field" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteFieldAnswer", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/provider/{parent-uuid}/attribute" : { | |
| "get" : { | |
| "tags" : [ "provider" ], | |
| "summary" : "Fetch all non-retired attribute subresources", | |
| "operationId" : "getAllProviderAttributes", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "attribute response", | |
| "schema" : { | |
| "type" : "object", | |
| "properties" : { | |
| "results" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ProviderAttributeGet" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "provider" ], | |
| "summary" : "Create attribute subresource with properties in request", | |
| "operationId" : "createProviderAttribute", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ProviderAttributeCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "attribute response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/provider/{parent-uuid}/attribute/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "provider" ], | |
| "summary" : "Fetch attribute subresources by uuid", | |
| "operationId" : "getProviderAttribute", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "attribute response", | |
| "schema" : { | |
| "$ref" : "#/definitions/ProviderAttributeGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "provider" ], | |
| "summary" : "edit attribute subresource with given uuid, only modifying properties in request", | |
| "operationId" : "updateProviderAttribute", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ProviderAttributeUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "attribute response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "provider" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteProviderAttribute", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/programenrollment/{parent-uuid}/attribute" : { | |
| "get" : { | |
| "tags" : [ "programenrollment" ], | |
| "summary" : "Fetch all non-retired attribute subresources", | |
| "operationId" : "getAllPatientProgramAttributes", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "attribute response", | |
| "schema" : { | |
| "type" : "object", | |
| "properties" : { | |
| "results" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ProgramenrollmentAttributeGet" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "programenrollment" ], | |
| "summary" : "Create attribute subresource with properties in request", | |
| "operationId" : "createPatientProgramAttribute", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ProgramenrollmentAttributeCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "attribute response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/programenrollment/{parent-uuid}/attribute/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "programenrollment" ], | |
| "summary" : "Fetch attribute subresources by uuid", | |
| "operationId" : "getPatientProgramAttribute", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "attribute response", | |
| "schema" : { | |
| "$ref" : "#/definitions/ProgramenrollmentAttributeGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "programenrollment" ], | |
| "summary" : "edit attribute subresource with given uuid, only modifying properties in request", | |
| "operationId" : "updatePatientProgramAttribute", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/ProgramenrollmentAttributeUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "attribute response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "programenrollment" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deletePatientProgramAttribute", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/form/{parent-uuid}/formfield" : { | |
| "get" : { | |
| "tags" : [ "form" ], | |
| "summary" : "Fetch all non-retired formfield subresources", | |
| "operationId" : "getAllFormFields", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "limit", | |
| "in" : "query", | |
| "description" : "The number of results to return", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "startIndex", | |
| "in" : "query", | |
| "description" : "The offset at which to start", | |
| "required" : false, | |
| "type" : "integer" | |
| }, { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "formfield response", | |
| "schema" : { | |
| "type" : "object", | |
| "properties" : { | |
| "results" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/FormFormfieldGet" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "form" ], | |
| "summary" : "Create formfield subresource with properties in request", | |
| "operationId" : "createFormField", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource to create", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/FormFormfieldCreate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "formfield response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| }, | |
| "/form/{parent-uuid}/formfield/{uuid}" : { | |
| "get" : { | |
| "tags" : [ "form" ], | |
| "summary" : "Fetch formfield subresources by uuid", | |
| "operationId" : "getFormField", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to filter by", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "v", | |
| "in" : "query", | |
| "description" : "The representation to return (ref, default, full or custom)", | |
| "required" : false, | |
| "type" : "string", | |
| "enum" : [ "ref", "default", "full", "custom" ] | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "formfield response", | |
| "schema" : { | |
| "$ref" : "#/definitions/FormFormfieldGet" | |
| } | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "form" ], | |
| "summary" : "edit formfield subresource with given uuid, only modifying properties in request", | |
| "operationId" : "updateFormField", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid of resource to update", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "in" : "body", | |
| "name" : "resource", | |
| "description" : "Resource properties to update", | |
| "required" : true, | |
| "schema" : { | |
| "$ref" : "#/definitions/FormFormfieldUpdate" | |
| } | |
| } ], | |
| "responses" : { | |
| "201" : { | |
| "description" : "formfield response" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "form" ], | |
| "summary" : "Delete or purge resource by uuid", | |
| "description" : "The resource will be voided/retired unless purge = 'true'", | |
| "operationId" : "deleteFormField", | |
| "consumes" : [ "application/json" ], | |
| "produces" : [ "application/json" ], | |
| "parameters" : [ { | |
| "name" : "parent-uuid", | |
| "in" : "path", | |
| "description" : "parent resource uuid", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "uuid", | |
| "in" : "path", | |
| "description" : "uuid to delete", | |
| "required" : true, | |
| "type" : "string" | |
| }, { | |
| "name" : "purge", | |
| "in" : "query", | |
| "required" : false, | |
| "type" : "boolean" | |
| } ], | |
| "responses" : { | |
| "204" : { | |
| "description" : "Delete successful" | |
| }, | |
| "404" : { | |
| "description" : "Resource with given uuid doesn't exist" | |
| }, | |
| "401" : { | |
| "description" : "User not logged in" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "securityDefinitions" : { | |
| "basic_auth" : { | |
| "type" : "basic" | |
| } | |
| }, | |
| "definitions" : { | |
| "Hl7Get" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "messageState" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| } | |
| }, | |
| "Hl7GetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "Hl7GetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "source" : { | |
| "type" : "string" | |
| }, | |
| "sourceKey" : { | |
| "type" : "string" | |
| }, | |
| "data" : { | |
| "type" : "string" | |
| }, | |
| "messageState" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| } | |
| }, | |
| "Hl7Create" : { | |
| "properties" : { | |
| "hl7" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "Hl7CreateFull" : { | |
| "properties" : { | |
| "hl7" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptclassGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptclassGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "ConceptclassGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptclassCreate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptclassCreateFull" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptclassUpdate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "LocationattributetypeGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "minOccurs" : { | |
| "type" : "string" | |
| }, | |
| "maxOccurs" : { | |
| "type" : "string" | |
| }, | |
| "datatypeClassname" : { | |
| "type" : "string" | |
| }, | |
| "preferredHandlerClassname" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "LocationattributetypeGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "LocationattributetypeGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "minOccurs" : { | |
| "type" : "string" | |
| }, | |
| "maxOccurs" : { | |
| "type" : "string" | |
| }, | |
| "datatypeClassname" : { | |
| "type" : "string" | |
| }, | |
| "datatypeConfig" : { | |
| "type" : "string" | |
| }, | |
| "preferredHandlerClassname" : { | |
| "type" : "string" | |
| }, | |
| "handlerConfig" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "LocationattributetypeCreate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "datatypeClassname" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "minOccurs" : { | |
| "type" : "string" | |
| }, | |
| "maxOccurs" : { | |
| "type" : "string" | |
| }, | |
| "datatypeConfig" : { | |
| "type" : "string" | |
| }, | |
| "preferredHandlerClassname" : { | |
| "type" : "string" | |
| }, | |
| "handlerConfig" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "LocationattributetypeCreateFull" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "datatypeClassname" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "minOccurs" : { | |
| "type" : "string" | |
| }, | |
| "maxOccurs" : { | |
| "type" : "string" | |
| }, | |
| "datatypeConfig" : { | |
| "type" : "string" | |
| }, | |
| "preferredHandlerClassname" : { | |
| "type" : "string" | |
| }, | |
| "handlerConfig" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "LocationattributetypeUpdate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "datatypeClassname" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "minOccurs" : { | |
| "type" : "string" | |
| }, | |
| "maxOccurs" : { | |
| "type" : "string" | |
| }, | |
| "datatypeConfig" : { | |
| "type" : "string" | |
| }, | |
| "preferredHandlerClassname" : { | |
| "type" : "string" | |
| }, | |
| "handlerConfig" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "OrdergroupGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| }, | |
| "patient" : { | |
| "type" : "string" | |
| }, | |
| "encounter" : { | |
| "type" : "string" | |
| }, | |
| "orders" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/OrderGet" | |
| } | |
| }, | |
| "orderSet" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "OrdergroupGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "OrdergroupGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| }, | |
| "patient" : { | |
| "type" : "string" | |
| }, | |
| "encounter" : { | |
| "type" : "string" | |
| }, | |
| "orders" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/OrderGetFull" | |
| } | |
| }, | |
| "orderSet" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "OrdergroupCreate" : { | |
| "properties" : { | |
| "patient" : { | |
| "type" : "string" | |
| }, | |
| "encounter" : { | |
| "type" : "string" | |
| }, | |
| "orders" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/OrderCreate" | |
| } | |
| }, | |
| "orderSet" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "OrdergroupCreateFull" : { | |
| "properties" : { | |
| "patient" : { | |
| "type" : "string" | |
| }, | |
| "encounter" : { | |
| "type" : "string" | |
| }, | |
| "orders" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/OrderCreateFull" | |
| } | |
| }, | |
| "orderSet" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "OrdergroupUpdate" : { | |
| "properties" : { | |
| "orders" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/OrderUpdate" | |
| } | |
| } | |
| } | |
| }, | |
| "WorkflowGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| }, | |
| "concept" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "states" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/WorkflowStateGet" | |
| } | |
| } | |
| } | |
| }, | |
| "WorkflowGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| }, | |
| "concept" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "states" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/WorkflowStateGetRef" | |
| } | |
| } | |
| } | |
| }, | |
| "WorkflowGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "concept" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "states" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/WorkflowStateGetFull" | |
| } | |
| } | |
| } | |
| }, | |
| "WorkflowCreate" : { | |
| "properties" : { | |
| "program" : { | |
| "type" : "string" | |
| }, | |
| "concept" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "WorkflowCreateFull" : { | |
| "properties" : { | |
| "program" : { | |
| "type" : "string" | |
| }, | |
| "concept" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "WorkflowUpdate" : { | |
| "properties" : { | |
| "program" : { | |
| "type" : "string" | |
| }, | |
| "concept" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "AdministrationlinksGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "title" : { | |
| "type" : "string" | |
| }, | |
| "administrationLinks" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "AdministrationlinksGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "title" : { | |
| "type" : "string" | |
| }, | |
| "administrationLinks" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "AdministrationlinksGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "title" : { | |
| "type" : "string" | |
| }, | |
| "administrationLinks" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ServerlogGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| }, | |
| "serverLog" : { | |
| "type" : "array" | |
| } | |
| } | |
| }, | |
| "ServerlogGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| }, | |
| "serverLog" : { | |
| "type" : "array" | |
| } | |
| } | |
| }, | |
| "ServerlogGetFull" : { | |
| "properties" : { | |
| "serverLog" : { | |
| "type" : "array" | |
| } | |
| } | |
| }, | |
| "DrugreferencemapGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "drug" : { | |
| "type" : "string" | |
| }, | |
| "conceptReferenceTerm" : { | |
| "type" : "string" | |
| }, | |
| "conceptMapType" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "DrugreferencemapGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "DrugreferencemapGetFull" : { | |
| "properties" : { | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| }, | |
| "drug" : { | |
| "type" : "string" | |
| }, | |
| "conceptReferenceTerm" : { | |
| "type" : "string" | |
| }, | |
| "conceptMapType" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "DrugreferencemapCreate" : { | |
| "properties" : { | |
| "conceptReferenceTerm" : { | |
| "type" : "string" | |
| }, | |
| "conceptMapType" : { | |
| "type" : "string" | |
| }, | |
| "drug" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "DrugreferencemapCreateFull" : { | |
| "properties" : { | |
| "conceptReferenceTerm" : { | |
| "type" : "string" | |
| }, | |
| "conceptMapType" : { | |
| "type" : "string" | |
| }, | |
| "drug" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "DrugreferencemapUpdate" : { | |
| "properties" : { | |
| "conceptReferenceTerm" : { | |
| "type" : "string" | |
| }, | |
| "conceptMapType" : { | |
| "type" : "string" | |
| }, | |
| "drug" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "datatype" : { | |
| "type" : "string" | |
| }, | |
| "conceptClass" : { | |
| "$ref" : "#/definitions/ConceptclassGet" | |
| }, | |
| "set" : { | |
| "type" : "boolean" | |
| }, | |
| "version" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "boolean" | |
| }, | |
| "names" : { | |
| "type" : "object" | |
| }, | |
| "descriptions" : { | |
| "type" : "object" | |
| }, | |
| "mappings" : { | |
| "type" : "string" | |
| }, | |
| "answers" : { | |
| "type" : "object" | |
| }, | |
| "setMembers" : { | |
| "type" : "string" | |
| }, | |
| "attributes" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ConceptAttributeGet" | |
| } | |
| } | |
| } | |
| }, | |
| "ConceptGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "ConceptGetFull" : { }, | |
| "ConceptCreate" : { | |
| "properties" : { | |
| "names" : { | |
| "type" : "object" | |
| }, | |
| "datatype" : { | |
| "type" : "string" | |
| }, | |
| "conceptClass" : { | |
| "$ref" : "#/definitions/ConceptclassCreate" | |
| }, | |
| "descriptions" : { | |
| "type" : "object" | |
| }, | |
| "set" : { | |
| "type" : "boolean" | |
| }, | |
| "version" : { | |
| "type" : "string" | |
| }, | |
| "mappings" : { | |
| "type" : "string" | |
| }, | |
| "answers" : { | |
| "type" : "object" | |
| }, | |
| "setMembers" : { | |
| "type" : "string" | |
| }, | |
| "hiNormal" : { | |
| "type" : "string" | |
| }, | |
| "hiAbsolute" : { | |
| "type" : "string" | |
| }, | |
| "hiCritical" : { | |
| "type" : "string" | |
| }, | |
| "lowNormal" : { | |
| "type" : "string" | |
| }, | |
| "lowAbsolute" : { | |
| "type" : "string" | |
| }, | |
| "lowCritical" : { | |
| "type" : "string" | |
| }, | |
| "units" : { | |
| "type" : "string" | |
| }, | |
| "allowDecimal" : { | |
| "type" : "string" | |
| }, | |
| "displayPrecision" : { | |
| "type" : "string" | |
| }, | |
| "attributes" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ConceptAttributeCreate" | |
| } | |
| } | |
| } | |
| }, | |
| "ConceptCreateFull" : { | |
| "properties" : { | |
| "names" : { | |
| "type" : "object" | |
| }, | |
| "datatype" : { | |
| "type" : "string" | |
| }, | |
| "conceptClass" : { | |
| "$ref" : "#/definitions/ConceptclassCreateFull" | |
| }, | |
| "descriptions" : { | |
| "type" : "object" | |
| }, | |
| "set" : { | |
| "type" : "boolean" | |
| }, | |
| "version" : { | |
| "type" : "string" | |
| }, | |
| "mappings" : { | |
| "type" : "string" | |
| }, | |
| "answers" : { | |
| "type" : "object" | |
| }, | |
| "setMembers" : { | |
| "type" : "string" | |
| }, | |
| "hiNormal" : { | |
| "type" : "string" | |
| }, | |
| "hiAbsolute" : { | |
| "type" : "string" | |
| }, | |
| "hiCritical" : { | |
| "type" : "string" | |
| }, | |
| "lowNormal" : { | |
| "type" : "string" | |
| }, | |
| "lowAbsolute" : { | |
| "type" : "string" | |
| }, | |
| "lowCritical" : { | |
| "type" : "string" | |
| }, | |
| "units" : { | |
| "type" : "string" | |
| }, | |
| "allowDecimal" : { | |
| "type" : "string" | |
| }, | |
| "displayPrecision" : { | |
| "type" : "string" | |
| }, | |
| "attributes" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ConceptAttributeCreateFull" | |
| } | |
| } | |
| } | |
| }, | |
| "ConceptUpdate" : { | |
| "properties" : { | |
| "names" : { | |
| "type" : "object" | |
| }, | |
| "datatype" : { | |
| "type" : "string" | |
| }, | |
| "conceptClass" : { | |
| "$ref" : "#/definitions/ConceptclassUpdate" | |
| }, | |
| "descriptions" : { | |
| "type" : "object" | |
| }, | |
| "set" : { | |
| "type" : "boolean" | |
| }, | |
| "version" : { | |
| "type" : "string" | |
| }, | |
| "mappings" : { | |
| "type" : "string" | |
| }, | |
| "answers" : { | |
| "type" : "object" | |
| }, | |
| "setMembers" : { | |
| "type" : "string" | |
| }, | |
| "hiNormal" : { | |
| "type" : "string" | |
| }, | |
| "hiAbsolute" : { | |
| "type" : "string" | |
| }, | |
| "hiCritical" : { | |
| "type" : "string" | |
| }, | |
| "lowNormal" : { | |
| "type" : "string" | |
| }, | |
| "lowAbsolute" : { | |
| "type" : "string" | |
| }, | |
| "lowCritical" : { | |
| "type" : "string" | |
| }, | |
| "units" : { | |
| "type" : "string" | |
| }, | |
| "allowDecimal" : { | |
| "type" : "string" | |
| }, | |
| "displayPrecision" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "attributes" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ConceptAttributeUpdate" | |
| } | |
| } | |
| } | |
| }, | |
| "ConceptsourceGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "hl7Code" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "uniqueId" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptsourceGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "ConceptsourceGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "hl7Code" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| }, | |
| "uniqueId" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptsourceCreate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "hl7Code" : { | |
| "type" : "string" | |
| }, | |
| "uniqueId" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptsourceCreateFull" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "hl7Code" : { | |
| "type" : "string" | |
| }, | |
| "uniqueId" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptsourceUpdate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "hl7Code" : { | |
| "type" : "string" | |
| }, | |
| "uniqueId" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "Hl7sourceGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "Hl7sourceGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "Hl7sourceGetFull" : { }, | |
| "Hl7sourceCreate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "Hl7sourceCreateFull" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "Hl7sourceUpdate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ModuleactionCreate" : { | |
| "properties" : { | |
| "modules" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ModuleCreate" | |
| } | |
| }, | |
| "allModules" : { | |
| "type" : "boolean" | |
| }, | |
| "installUri" : { | |
| "type" : "string" | |
| }, | |
| "action" : { | |
| "type" : "string", | |
| "enum" : [ "START", "STOP", "RESTART", "UNLOAD", "INSTALL" ] | |
| } | |
| } | |
| }, | |
| "ModuleactionCreateFull" : { | |
| "properties" : { | |
| "modules" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ModuleCreateFull" | |
| } | |
| }, | |
| "allModules" : { | |
| "type" : "boolean" | |
| }, | |
| "installUri" : { | |
| "type" : "string" | |
| }, | |
| "action" : { | |
| "type" : "string", | |
| "enum" : [ "START", "STOP", "RESTART", "UNLOAD", "INSTALL" ] | |
| } | |
| } | |
| }, | |
| "EncounterroleGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "EncounterroleGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "EncounterroleGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "EncounterroleCreate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "EncounterroleCreateFull" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "EncounterroleUpdate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptmaptypeGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "isHidden" : { | |
| "type" : "boolean" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptmaptypeGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "ConceptmaptypeGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "isHidden" : { | |
| "type" : "boolean" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptmaptypeCreate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "isHidden" : { | |
| "type" : "boolean" | |
| } | |
| } | |
| }, | |
| "ConceptmaptypeCreateFull" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "isHidden" : { | |
| "type" : "boolean" | |
| } | |
| } | |
| }, | |
| "ConceptmaptypeUpdate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "isHidden" : { | |
| "type" : "boolean" | |
| } | |
| } | |
| }, | |
| "CaresettingGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "careSettingType" : { | |
| "type" : "string", | |
| "enum" : [ "OUTPATIENT", "INPATIENT" ] | |
| } | |
| } | |
| }, | |
| "CaresettingGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "CaresettingGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "careSettingType" : { | |
| "type" : "string", | |
| "enum" : [ "OUTPATIENT", "INPATIENT" ] | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "DatabasechangeGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "author" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "runStatus" : { | |
| "type" : "object" | |
| } | |
| } | |
| }, | |
| "DatabasechangeGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "DatabasechangeGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "author" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "runStatus" : { | |
| "type" : "object" | |
| }, | |
| "comments" : { | |
| "type" : "string" | |
| }, | |
| "ranDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| } | |
| } | |
| }, | |
| "CustomdatatypeGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "datatypeClassname" : { | |
| "type" : "string" | |
| }, | |
| "handlers" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/CustomdatatypeHandlersGet" | |
| } | |
| } | |
| } | |
| }, | |
| "CustomdatatypeGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "CustomdatatypeGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "datatypeClassname" : { | |
| "type" : "string" | |
| }, | |
| "handlers" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/CustomdatatypeHandlersGetFull" | |
| } | |
| } | |
| } | |
| }, | |
| "ModuleGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "version" : { | |
| "type" : "string" | |
| }, | |
| "started" : { | |
| "type" : "string" | |
| }, | |
| "startupErrorMessage" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ModuleGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ModuleGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "packageName" : { | |
| "type" : "string" | |
| }, | |
| "author" : { | |
| "type" : "string" | |
| }, | |
| "version" : { | |
| "type" : "string" | |
| }, | |
| "started" : { | |
| "type" : "string" | |
| }, | |
| "startupErrorMessage" : { | |
| "type" : "string" | |
| }, | |
| "requireOpenmrsVersion" : { | |
| "type" : "string" | |
| }, | |
| "awareOfModules" : { | |
| "type" : "string" | |
| }, | |
| "requiredModules" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptstateconversionGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptGet" | |
| }, | |
| "programWorkflow" : { | |
| "$ref" : "#/definitions/WorkflowGet" | |
| }, | |
| "programWorkflowState" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptstateconversionGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptGetRef" | |
| }, | |
| "programWorkflow" : { | |
| "$ref" : "#/definitions/WorkflowGetRef" | |
| }, | |
| "programWorkflowState" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptstateconversionGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptGetFull" | |
| }, | |
| "programWorkflow" : { | |
| "$ref" : "#/definitions/WorkflowGetFull" | |
| }, | |
| "programWorkflowState" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptstateconversionCreate" : { | |
| "properties" : { | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptCreate" | |
| }, | |
| "programWorkflow" : { | |
| "$ref" : "#/definitions/WorkflowCreate" | |
| }, | |
| "programWorkflowState" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptstateconversionCreateFull" : { | |
| "properties" : { | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptCreateFull" | |
| }, | |
| "programWorkflow" : { | |
| "$ref" : "#/definitions/WorkflowCreateFull" | |
| }, | |
| "programWorkflowState" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptstateconversionUpdate" : { | |
| "properties" : { | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptUpdate" | |
| }, | |
| "programWorkflow" : { | |
| "$ref" : "#/definitions/WorkflowUpdate" | |
| }, | |
| "programWorkflowState" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "SystemsettingGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "property" : { | |
| "type" : "string" | |
| }, | |
| "value" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "SystemsettingGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "SystemsettingGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "property" : { | |
| "type" : "string" | |
| }, | |
| "value" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "datatypeClassname" : { | |
| "type" : "string" | |
| }, | |
| "datatypeConfig" : { | |
| "type" : "string" | |
| }, | |
| "preferredHandlerClassname" : { | |
| "type" : "string" | |
| }, | |
| "handlerConfig" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "SystemsettingCreate" : { | |
| "properties" : { | |
| "property" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "datatypeClassname" : { | |
| "type" : "string" | |
| }, | |
| "datatypeConfig" : { | |
| "type" : "string" | |
| }, | |
| "preferredHandlerClassname" : { | |
| "type" : "string" | |
| }, | |
| "handlerConfig" : { | |
| "type" : "string" | |
| }, | |
| "value" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "SystemsettingCreateFull" : { | |
| "properties" : { | |
| "property" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "datatypeClassname" : { | |
| "type" : "string" | |
| }, | |
| "datatypeConfig" : { | |
| "type" : "string" | |
| }, | |
| "preferredHandlerClassname" : { | |
| "type" : "string" | |
| }, | |
| "handlerConfig" : { | |
| "type" : "string" | |
| }, | |
| "value" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "SystemsettingUpdate" : { | |
| "properties" : { | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "datatypeClassname" : { | |
| "type" : "string" | |
| }, | |
| "datatypeConfig" : { | |
| "type" : "string" | |
| }, | |
| "preferredHandlerClassname" : { | |
| "type" : "string" | |
| }, | |
| "handlerConfig" : { | |
| "type" : "string" | |
| }, | |
| "value" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "LocationGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "address1" : { | |
| "type" : "string" | |
| }, | |
| "address2" : { | |
| "type" : "string" | |
| }, | |
| "cityVillage" : { | |
| "type" : "string" | |
| }, | |
| "stateProvince" : { | |
| "type" : "string" | |
| }, | |
| "country" : { | |
| "type" : "string" | |
| }, | |
| "postalCode" : { | |
| "type" : "string" | |
| }, | |
| "latitude" : { | |
| "type" : "string" | |
| }, | |
| "longitude" : { | |
| "type" : "string" | |
| }, | |
| "countyDistrict" : { | |
| "type" : "string" | |
| }, | |
| "address3" : { | |
| "type" : "string" | |
| }, | |
| "address4" : { | |
| "type" : "string" | |
| }, | |
| "address5" : { | |
| "type" : "string" | |
| }, | |
| "address6" : { | |
| "type" : "string" | |
| }, | |
| "tags" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/LocationtagGet" | |
| } | |
| }, | |
| "parentLocation" : { | |
| "$ref" : "#/definitions/LocationGet" | |
| }, | |
| "childLocations" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/LocationGet" | |
| } | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "attributes" : { | |
| "type" : "string" | |
| }, | |
| "address7" : { | |
| "type" : "string" | |
| }, | |
| "address8" : { | |
| "type" : "string" | |
| }, | |
| "address9" : { | |
| "type" : "string" | |
| }, | |
| "address10" : { | |
| "type" : "string" | |
| }, | |
| "address11" : { | |
| "type" : "string" | |
| }, | |
| "address12" : { | |
| "type" : "string" | |
| }, | |
| "address13" : { | |
| "type" : "string" | |
| }, | |
| "address14" : { | |
| "type" : "string" | |
| }, | |
| "address15" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "LocationGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "LocationGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "address1" : { | |
| "type" : "string" | |
| }, | |
| "address2" : { | |
| "type" : "string" | |
| }, | |
| "cityVillage" : { | |
| "type" : "string" | |
| }, | |
| "stateProvince" : { | |
| "type" : "string" | |
| }, | |
| "country" : { | |
| "type" : "string" | |
| }, | |
| "postalCode" : { | |
| "type" : "string" | |
| }, | |
| "latitude" : { | |
| "type" : "string" | |
| }, | |
| "longitude" : { | |
| "type" : "string" | |
| }, | |
| "countyDistrict" : { | |
| "type" : "string" | |
| }, | |
| "address3" : { | |
| "type" : "string" | |
| }, | |
| "address4" : { | |
| "type" : "string" | |
| }, | |
| "address5" : { | |
| "type" : "string" | |
| }, | |
| "address6" : { | |
| "type" : "string" | |
| }, | |
| "tags" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/LocationtagGetFull" | |
| } | |
| }, | |
| "parentLocation" : { | |
| "$ref" : "#/definitions/LocationGetFull" | |
| }, | |
| "childLocations" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/LocationGetFull" | |
| } | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| }, | |
| "attributes" : { | |
| "type" : "string" | |
| }, | |
| "address7" : { | |
| "type" : "string" | |
| }, | |
| "address8" : { | |
| "type" : "string" | |
| }, | |
| "address9" : { | |
| "type" : "string" | |
| }, | |
| "address10" : { | |
| "type" : "string" | |
| }, | |
| "address11" : { | |
| "type" : "string" | |
| }, | |
| "address12" : { | |
| "type" : "string" | |
| }, | |
| "address13" : { | |
| "type" : "string" | |
| }, | |
| "address14" : { | |
| "type" : "string" | |
| }, | |
| "address15" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "LocationCreate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "address1" : { | |
| "type" : "string" | |
| }, | |
| "address2" : { | |
| "type" : "string" | |
| }, | |
| "cityVillage" : { | |
| "type" : "string" | |
| }, | |
| "stateProvince" : { | |
| "type" : "string" | |
| }, | |
| "country" : { | |
| "type" : "string" | |
| }, | |
| "postalCode" : { | |
| "type" : "string" | |
| }, | |
| "latitude" : { | |
| "type" : "string" | |
| }, | |
| "longitude" : { | |
| "type" : "string" | |
| }, | |
| "countyDistrict" : { | |
| "type" : "string" | |
| }, | |
| "address3" : { | |
| "type" : "string" | |
| }, | |
| "address4" : { | |
| "type" : "string" | |
| }, | |
| "address5" : { | |
| "type" : "string" | |
| }, | |
| "address6" : { | |
| "type" : "string" | |
| }, | |
| "tags" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/LocationtagCreate" | |
| } | |
| }, | |
| "parentLocation" : { | |
| "$ref" : "#/definitions/LocationCreate" | |
| }, | |
| "childLocations" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/LocationCreate" | |
| } | |
| }, | |
| "attributes" : { | |
| "type" : "string" | |
| }, | |
| "address7" : { | |
| "type" : "string" | |
| }, | |
| "address8" : { | |
| "type" : "string" | |
| }, | |
| "address9" : { | |
| "type" : "string" | |
| }, | |
| "address10" : { | |
| "type" : "string" | |
| }, | |
| "address11" : { | |
| "type" : "string" | |
| }, | |
| "address12" : { | |
| "type" : "string" | |
| }, | |
| "address13" : { | |
| "type" : "string" | |
| }, | |
| "address14" : { | |
| "type" : "string" | |
| }, | |
| "address15" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "LocationCreateFull" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "address1" : { | |
| "type" : "string" | |
| }, | |
| "address2" : { | |
| "type" : "string" | |
| }, | |
| "cityVillage" : { | |
| "type" : "string" | |
| }, | |
| "stateProvince" : { | |
| "type" : "string" | |
| }, | |
| "country" : { | |
| "type" : "string" | |
| }, | |
| "postalCode" : { | |
| "type" : "string" | |
| }, | |
| "latitude" : { | |
| "type" : "string" | |
| }, | |
| "longitude" : { | |
| "type" : "string" | |
| }, | |
| "countyDistrict" : { | |
| "type" : "string" | |
| }, | |
| "address3" : { | |
| "type" : "string" | |
| }, | |
| "address4" : { | |
| "type" : "string" | |
| }, | |
| "address5" : { | |
| "type" : "string" | |
| }, | |
| "address6" : { | |
| "type" : "string" | |
| }, | |
| "tags" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/LocationtagCreateFull" | |
| } | |
| }, | |
| "parentLocation" : { | |
| "$ref" : "#/definitions/LocationCreateFull" | |
| }, | |
| "childLocations" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/LocationCreateFull" | |
| } | |
| }, | |
| "attributes" : { | |
| "type" : "string" | |
| }, | |
| "address7" : { | |
| "type" : "string" | |
| }, | |
| "address8" : { | |
| "type" : "string" | |
| }, | |
| "address9" : { | |
| "type" : "string" | |
| }, | |
| "address10" : { | |
| "type" : "string" | |
| }, | |
| "address11" : { | |
| "type" : "string" | |
| }, | |
| "address12" : { | |
| "type" : "string" | |
| }, | |
| "address13" : { | |
| "type" : "string" | |
| }, | |
| "address14" : { | |
| "type" : "string" | |
| }, | |
| "address15" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "LocationUpdate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "address1" : { | |
| "type" : "string" | |
| }, | |
| "address2" : { | |
| "type" : "string" | |
| }, | |
| "cityVillage" : { | |
| "type" : "string" | |
| }, | |
| "stateProvince" : { | |
| "type" : "string" | |
| }, | |
| "country" : { | |
| "type" : "string" | |
| }, | |
| "postalCode" : { | |
| "type" : "string" | |
| }, | |
| "latitude" : { | |
| "type" : "string" | |
| }, | |
| "longitude" : { | |
| "type" : "string" | |
| }, | |
| "countyDistrict" : { | |
| "type" : "string" | |
| }, | |
| "address3" : { | |
| "type" : "string" | |
| }, | |
| "address4" : { | |
| "type" : "string" | |
| }, | |
| "address5" : { | |
| "type" : "string" | |
| }, | |
| "address6" : { | |
| "type" : "string" | |
| }, | |
| "tags" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/LocationtagUpdate" | |
| } | |
| }, | |
| "parentLocation" : { | |
| "$ref" : "#/definitions/LocationUpdate" | |
| }, | |
| "childLocations" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/LocationUpdate" | |
| } | |
| }, | |
| "attributes" : { | |
| "type" : "string" | |
| }, | |
| "address7" : { | |
| "type" : "string" | |
| }, | |
| "address8" : { | |
| "type" : "string" | |
| }, | |
| "address9" : { | |
| "type" : "string" | |
| }, | |
| "address10" : { | |
| "type" : "string" | |
| }, | |
| "address11" : { | |
| "type" : "string" | |
| }, | |
| "address12" : { | |
| "type" : "string" | |
| }, | |
| "address13" : { | |
| "type" : "string" | |
| }, | |
| "address14" : { | |
| "type" : "string" | |
| }, | |
| "address15" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptproposalGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "encounter" : { | |
| "type" : "string" | |
| }, | |
| "originalText" : { | |
| "type" : "string" | |
| }, | |
| "finalText" : { | |
| "type" : "string" | |
| }, | |
| "state" : { | |
| "type" : "string" | |
| }, | |
| "comments" : { | |
| "type" : "string" | |
| }, | |
| "occurrences" : { | |
| "type" : "string" | |
| }, | |
| "creator" : { | |
| "type" : "string" | |
| }, | |
| "dateCreated" : { | |
| "type" : "string", | |
| "format" : "date" | |
| } | |
| } | |
| }, | |
| "ConceptproposalGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "encounter" : { | |
| "type" : "string" | |
| }, | |
| "originalText" : { | |
| "type" : "string" | |
| }, | |
| "state" : { | |
| "type" : "string" | |
| }, | |
| "occurrences" : { | |
| "type" : "string" | |
| }, | |
| "creator" : { | |
| "type" : "string" | |
| }, | |
| "dateCreated" : { | |
| "type" : "string", | |
| "format" : "date" | |
| } | |
| } | |
| }, | |
| "ConceptproposalGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "encounter" : { | |
| "type" : "string" | |
| }, | |
| "obsConcept" : { | |
| "$ref" : "#/definitions/ConceptGetFull" | |
| }, | |
| "obs" : { | |
| "type" : "string" | |
| }, | |
| "mappedConcept" : { | |
| "$ref" : "#/definitions/ConceptGetFull" | |
| }, | |
| "originalText" : { | |
| "type" : "string" | |
| }, | |
| "finalText" : { | |
| "type" : "string" | |
| }, | |
| "state" : { | |
| "type" : "string" | |
| }, | |
| "comments" : { | |
| "type" : "string" | |
| }, | |
| "occurrences" : { | |
| "type" : "string" | |
| }, | |
| "creator" : { | |
| "type" : "string" | |
| }, | |
| "dateCreated" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "changedBy" : { | |
| "type" : "string" | |
| }, | |
| "dateChanged" : { | |
| "type" : "string", | |
| "format" : "date" | |
| } | |
| } | |
| }, | |
| "ConceptproposalCreate" : { | |
| "properties" : { | |
| "originalText" : { | |
| "type" : "string" | |
| }, | |
| "mappedConcept" : { | |
| "$ref" : "#/definitions/ConceptCreate" | |
| }, | |
| "encounter" : { | |
| "type" : "string" | |
| }, | |
| "obsConcept" : { | |
| "$ref" : "#/definitions/ConceptCreate" | |
| } | |
| } | |
| }, | |
| "ConceptproposalCreateFull" : { | |
| "properties" : { | |
| "originalText" : { | |
| "type" : "string" | |
| }, | |
| "mappedConcept" : { | |
| "$ref" : "#/definitions/ConceptCreateFull" | |
| }, | |
| "encounter" : { | |
| "type" : "string" | |
| }, | |
| "obsConcept" : { | |
| "$ref" : "#/definitions/ConceptCreateFull" | |
| } | |
| } | |
| }, | |
| "ConceptproposalUpdate" : { | |
| "properties" : { | |
| "finalText" : { | |
| "type" : "string" | |
| }, | |
| "encounter" : { | |
| "type" : "string" | |
| }, | |
| "obsConcept" : { | |
| "$ref" : "#/definitions/ConceptUpdate" | |
| }, | |
| "mappedConcept" : { | |
| "$ref" : "#/definitions/ConceptUpdate" | |
| }, | |
| "comments" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "FormGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "encounterType" : { | |
| "type" : "string" | |
| }, | |
| "version" : { | |
| "type" : "string" | |
| }, | |
| "build" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| }, | |
| "published" : { | |
| "type" : "boolean" | |
| }, | |
| "formFields" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/FormFormfieldGet" | |
| } | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "resources" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "FormGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "FormGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "encounterType" : { | |
| "type" : "string" | |
| }, | |
| "version" : { | |
| "type" : "string" | |
| }, | |
| "build" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| }, | |
| "published" : { | |
| "type" : "boolean" | |
| }, | |
| "formFields" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/FormFormfieldGetFull" | |
| } | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| }, | |
| "resources" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "FormCreate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "version" : { | |
| "type" : "string" | |
| }, | |
| "encounterType" : { | |
| "type" : "string" | |
| }, | |
| "build" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| }, | |
| "published" : { | |
| "type" : "boolean" | |
| }, | |
| "formFields" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/FormFormfieldCreate" | |
| } | |
| }, | |
| "xslt" : { | |
| "type" : "string" | |
| }, | |
| "template" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "FormCreateFull" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "version" : { | |
| "type" : "string" | |
| }, | |
| "encounterType" : { | |
| "type" : "string" | |
| }, | |
| "build" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| }, | |
| "published" : { | |
| "type" : "boolean" | |
| }, | |
| "formFields" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/FormFormfieldCreateFull" | |
| } | |
| }, | |
| "xslt" : { | |
| "type" : "string" | |
| }, | |
| "template" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "FormUpdate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "version" : { | |
| "type" : "string" | |
| }, | |
| "encounterType" : { | |
| "type" : "string" | |
| }, | |
| "build" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| }, | |
| "published" : { | |
| "type" : "boolean" | |
| }, | |
| "xslt" : { | |
| "type" : "string" | |
| }, | |
| "template" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ProgramattributetypeGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "minOccurs" : { | |
| "type" : "string" | |
| }, | |
| "maxOccurs" : { | |
| "type" : "string" | |
| }, | |
| "datatypeClassname" : { | |
| "type" : "string" | |
| }, | |
| "preferredHandlerClassname" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ProgramattributetypeGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ProgramattributetypeGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "minOccurs" : { | |
| "type" : "string" | |
| }, | |
| "maxOccurs" : { | |
| "type" : "string" | |
| }, | |
| "datatypeClassname" : { | |
| "type" : "string" | |
| }, | |
| "datatypeConfig" : { | |
| "type" : "string" | |
| }, | |
| "preferredHandlerClassname" : { | |
| "type" : "string" | |
| }, | |
| "handlerConfig" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ProgramattributetypeCreate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "datatypeClassname" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "minOccurs" : { | |
| "type" : "string" | |
| }, | |
| "maxOccurs" : { | |
| "type" : "string" | |
| }, | |
| "datatypeConfig" : { | |
| "type" : "string" | |
| }, | |
| "preferredHandlerClassname" : { | |
| "type" : "string" | |
| }, | |
| "handlerConfig" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ProgramattributetypeCreateFull" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "datatypeClassname" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "minOccurs" : { | |
| "type" : "string" | |
| }, | |
| "maxOccurs" : { | |
| "type" : "string" | |
| }, | |
| "datatypeConfig" : { | |
| "type" : "string" | |
| }, | |
| "preferredHandlerClassname" : { | |
| "type" : "string" | |
| }, | |
| "handlerConfig" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ProgramattributetypeUpdate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "datatypeClassname" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "minOccurs" : { | |
| "type" : "string" | |
| }, | |
| "maxOccurs" : { | |
| "type" : "string" | |
| }, | |
| "datatypeConfig" : { | |
| "type" : "string" | |
| }, | |
| "preferredHandlerClassname" : { | |
| "type" : "string" | |
| }, | |
| "handlerConfig" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "VisittypeGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "VisittypeGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "VisittypeGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "VisittypeCreate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "VisittypeCreateFull" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "VisittypeUpdate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "OrderfrequencyGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "frequencyPerDay" : { | |
| "type" : "number", | |
| "format" : "double" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptGet" | |
| } | |
| } | |
| }, | |
| "OrderfrequencyGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "OrderfrequencyGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "frequencyPerDay" : { | |
| "type" : "number", | |
| "format" : "double" | |
| }, | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptGetFull" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "OrderfrequencyCreate" : { | |
| "properties" : { | |
| "frequencyPerDay" : { | |
| "type" : "number", | |
| "format" : "double" | |
| }, | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptCreate" | |
| } | |
| } | |
| }, | |
| "OrderfrequencyCreateFull" : { | |
| "properties" : { | |
| "frequencyPerDay" : { | |
| "type" : "number", | |
| "format" : "double" | |
| }, | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptCreateFull" | |
| } | |
| } | |
| }, | |
| "OrderfrequencyUpdate" : { | |
| "properties" : { | |
| "frequencyPerDay" : { | |
| "type" : "number", | |
| "format" : "double" | |
| }, | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptUpdate" | |
| } | |
| } | |
| }, | |
| "UserGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "username" : { | |
| "type" : "string" | |
| }, | |
| "systemId" : { | |
| "type" : "string" | |
| }, | |
| "userProperties" : { | |
| "type" : "string" | |
| }, | |
| "person" : { | |
| "type" : "string" | |
| }, | |
| "privileges" : { | |
| "type" : "string" | |
| }, | |
| "roles" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "UserGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "UserGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "username" : { | |
| "type" : "string" | |
| }, | |
| "systemId" : { | |
| "type" : "string" | |
| }, | |
| "userProperties" : { | |
| "type" : "string" | |
| }, | |
| "person" : { | |
| "type" : "string" | |
| }, | |
| "privileges" : { | |
| "type" : "string" | |
| }, | |
| "roles" : { | |
| "type" : "string" | |
| }, | |
| "allRoles" : { | |
| "type" : "string" | |
| }, | |
| "proficientLocales" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "UserCreate" : { | |
| "properties" : { | |
| "username" : { | |
| "type" : "string" | |
| }, | |
| "password" : { | |
| "type" : "string" | |
| }, | |
| "person" : { | |
| "type" : "string" | |
| }, | |
| "systemId" : { | |
| "type" : "string" | |
| }, | |
| "userProperties" : { | |
| "type" : "string" | |
| }, | |
| "roles" : { | |
| "type" : "string" | |
| }, | |
| "proficientLocales" : { | |
| "type" : "string" | |
| }, | |
| "secretQuestion" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "UserCreateFull" : { | |
| "properties" : { | |
| "username" : { | |
| "type" : "string" | |
| }, | |
| "password" : { | |
| "type" : "string" | |
| }, | |
| "person" : { | |
| "type" : "string" | |
| }, | |
| "systemId" : { | |
| "type" : "string" | |
| }, | |
| "userProperties" : { | |
| "type" : "string" | |
| }, | |
| "roles" : { | |
| "type" : "string" | |
| }, | |
| "proficientLocales" : { | |
| "type" : "string" | |
| }, | |
| "secretQuestion" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "UserUpdate" : { | |
| "properties" : { | |
| "username" : { | |
| "type" : "string" | |
| }, | |
| "password" : { | |
| "type" : "string" | |
| }, | |
| "person" : { | |
| "type" : "string" | |
| }, | |
| "systemId" : { | |
| "type" : "string" | |
| }, | |
| "userProperties" : { | |
| "type" : "string" | |
| }, | |
| "roles" : { | |
| "type" : "string" | |
| }, | |
| "proficientLocales" : { | |
| "type" : "string" | |
| }, | |
| "secretQuestion" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ProgramenrollmentGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "patient" : { | |
| "type" : "string" | |
| }, | |
| "program" : { | |
| "type" : "string" | |
| }, | |
| "dateEnrolled" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "dateCompleted" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "location" : { | |
| "$ref" : "#/definitions/LocationGet" | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| }, | |
| "outcome" : { | |
| "$ref" : "#/definitions/ConceptGet" | |
| }, | |
| "states" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ProgramenrollmentStateGet" | |
| } | |
| }, | |
| "attributes" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ProgramenrollmentAttributeGet" | |
| } | |
| } | |
| } | |
| }, | |
| "ProgramenrollmentGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "ProgramenrollmentGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "patient" : { | |
| "type" : "string" | |
| }, | |
| "program" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "dateEnrolled" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "dateCompleted" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "location" : { | |
| "$ref" : "#/definitions/LocationGetFull" | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| }, | |
| "outcome" : { | |
| "$ref" : "#/definitions/ConceptGetFull" | |
| }, | |
| "states" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ProgramenrollmentStateGetFull" | |
| } | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| }, | |
| "attributes" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ProgramenrollmentAttributeGetFull" | |
| } | |
| } | |
| } | |
| }, | |
| "ProgramenrollmentCreate" : { | |
| "properties" : { | |
| "patient" : { | |
| "type" : "string" | |
| }, | |
| "program" : { | |
| "type" : "string" | |
| }, | |
| "dateEnrolled" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "dateCompleted" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "states" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ProgramenrollmentStateCreate" | |
| } | |
| }, | |
| "outcome" : { | |
| "$ref" : "#/definitions/ConceptCreate" | |
| }, | |
| "location" : { | |
| "$ref" : "#/definitions/LocationCreate" | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| }, | |
| "attributes" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ProgramenrollmentAttributeCreate" | |
| } | |
| } | |
| } | |
| }, | |
| "ProgramenrollmentCreateFull" : { | |
| "properties" : { | |
| "patient" : { | |
| "type" : "string" | |
| }, | |
| "program" : { | |
| "type" : "string" | |
| }, | |
| "dateEnrolled" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "dateCompleted" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "states" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ProgramenrollmentStateCreateFull" | |
| } | |
| }, | |
| "outcome" : { | |
| "$ref" : "#/definitions/ConceptCreateFull" | |
| }, | |
| "location" : { | |
| "$ref" : "#/definitions/LocationCreateFull" | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| }, | |
| "attributes" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ProgramenrollmentAttributeCreateFull" | |
| } | |
| } | |
| } | |
| }, | |
| "ProgramenrollmentUpdate" : { | |
| "properties" : { | |
| "dateEnrolled" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "states" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ProgramenrollmentStateUpdate" | |
| } | |
| }, | |
| "outcome" : { | |
| "$ref" : "#/definitions/ConceptUpdate" | |
| }, | |
| "location" : { | |
| "$ref" : "#/definitions/LocationUpdate" | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| }, | |
| "dateCompleted" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "attributes" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ProgramenrollmentAttributeUpdate" | |
| } | |
| } | |
| } | |
| }, | |
| "VisitattributetypeGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "minOccurs" : { | |
| "type" : "string" | |
| }, | |
| "maxOccurs" : { | |
| "type" : "string" | |
| }, | |
| "datatypeClassname" : { | |
| "type" : "string" | |
| }, | |
| "preferredHandlerClassname" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "VisitattributetypeGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "VisitattributetypeGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "minOccurs" : { | |
| "type" : "string" | |
| }, | |
| "maxOccurs" : { | |
| "type" : "string" | |
| }, | |
| "datatypeClassname" : { | |
| "type" : "string" | |
| }, | |
| "datatypeConfig" : { | |
| "type" : "string" | |
| }, | |
| "preferredHandlerClassname" : { | |
| "type" : "string" | |
| }, | |
| "handlerConfig" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "VisitattributetypeCreate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "datatypeClassname" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "minOccurs" : { | |
| "type" : "string" | |
| }, | |
| "maxOccurs" : { | |
| "type" : "string" | |
| }, | |
| "datatypeConfig" : { | |
| "type" : "string" | |
| }, | |
| "preferredHandlerClassname" : { | |
| "type" : "string" | |
| }, | |
| "handlerConfig" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "VisitattributetypeCreateFull" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "datatypeClassname" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "minOccurs" : { | |
| "type" : "string" | |
| }, | |
| "maxOccurs" : { | |
| "type" : "string" | |
| }, | |
| "datatypeConfig" : { | |
| "type" : "string" | |
| }, | |
| "preferredHandlerClassname" : { | |
| "type" : "string" | |
| }, | |
| "handlerConfig" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "VisitattributetypeUpdate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "datatypeClassname" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "minOccurs" : { | |
| "type" : "string" | |
| }, | |
| "maxOccurs" : { | |
| "type" : "string" | |
| }, | |
| "datatypeConfig" : { | |
| "type" : "string" | |
| }, | |
| "preferredHandlerClassname" : { | |
| "type" : "string" | |
| }, | |
| "handlerConfig" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "PatientGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "identifiers" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/PatientIdentifierGet" | |
| } | |
| }, | |
| "person" : { | |
| "type" : "string" | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "PatientGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "PatientGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "identifiers" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/PatientIdentifierGetFull" | |
| } | |
| }, | |
| "person" : { | |
| "type" : "string" | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "PatientCreate" : { | |
| "properties" : { | |
| "person" : { | |
| "type" : "string" | |
| }, | |
| "identifiers" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/PatientIdentifierCreate" | |
| } | |
| } | |
| } | |
| }, | |
| "PatientCreateFull" : { | |
| "properties" : { | |
| "person" : { | |
| "type" : "string" | |
| }, | |
| "identifiers" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/PatientIdentifierCreateFull" | |
| } | |
| } | |
| } | |
| }, | |
| "PatientUpdate" : { | |
| "properties" : { | |
| "person" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "CohortGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| }, | |
| "size" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "CohortGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "CohortGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| }, | |
| "size" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "CohortCreate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "memberIds" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "CohortCreateFull" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "memberIds" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "CohortUpdate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "FieldtypeGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "isSet" : { | |
| "type" : "boolean" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "FieldtypeGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "FieldtypeGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "isSet" : { | |
| "type" : "boolean" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "FieldtypeCreate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "isSet" : { | |
| "type" : "boolean" | |
| } | |
| } | |
| }, | |
| "FieldtypeCreateFull" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "isSet" : { | |
| "type" : "boolean" | |
| } | |
| } | |
| }, | |
| "FieldtypeUpdate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "isSet" : { | |
| "type" : "boolean" | |
| } | |
| } | |
| }, | |
| "PatientdiagnosesGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "diagnosis" : { | |
| "type" : "string" | |
| }, | |
| "condition" : { | |
| "type" : "string" | |
| }, | |
| "encounter" : { | |
| "type" : "string" | |
| }, | |
| "certainty" : { | |
| "type" : "string", | |
| "enum" : [ "PROVISIONAL", "CONFIRMED" ] | |
| }, | |
| "rank" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| }, | |
| "patient" : { | |
| "$ref" : "#/definitions/PatientGet" | |
| }, | |
| "formFieldNamespace" : { | |
| "type" : "string" | |
| }, | |
| "formFieldPath" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "PatientdiagnosesGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "PatientdiagnosesGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "diagnosis" : { | |
| "type" : "string" | |
| }, | |
| "patient" : { | |
| "$ref" : "#/definitions/PatientGetFull" | |
| }, | |
| "condition" : { | |
| "type" : "string" | |
| }, | |
| "encounter" : { | |
| "type" : "string" | |
| }, | |
| "certainty" : { | |
| "type" : "string", | |
| "enum" : [ "PROVISIONAL", "CONFIRMED" ] | |
| }, | |
| "rank" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "formFieldNamespace" : { | |
| "type" : "string" | |
| }, | |
| "formFieldPath" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "PatientdiagnosesCreate" : { | |
| "properties" : { | |
| "diagnosis" : { | |
| "type" : "string" | |
| }, | |
| "encounter" : { | |
| "type" : "string" | |
| }, | |
| "condition" : { | |
| "type" : "string" | |
| }, | |
| "certainty" : { | |
| "type" : "string", | |
| "enum" : [ "PROVISIONAL", "CONFIRMED" ] | |
| }, | |
| "patient" : { | |
| "$ref" : "#/definitions/PatientCreate" | |
| }, | |
| "rank" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| }, | |
| "formFieldNamespace" : { | |
| "type" : "string" | |
| }, | |
| "formFieldPath" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "PatientdiagnosesCreateFull" : { | |
| "properties" : { | |
| "diagnosis" : { | |
| "type" : "string" | |
| }, | |
| "encounter" : { | |
| "type" : "string" | |
| }, | |
| "condition" : { | |
| "type" : "string" | |
| }, | |
| "certainty" : { | |
| "type" : "string", | |
| "enum" : [ "PROVISIONAL", "CONFIRMED" ] | |
| }, | |
| "patient" : { | |
| "$ref" : "#/definitions/PatientCreateFull" | |
| }, | |
| "rank" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| }, | |
| "formFieldNamespace" : { | |
| "type" : "string" | |
| }, | |
| "formFieldPath" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "PatientdiagnosesUpdate" : { | |
| "properties" : { | |
| "diagnosis" : { | |
| "type" : "string" | |
| }, | |
| "condition" : { | |
| "type" : "string" | |
| }, | |
| "rank" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| }, | |
| "certainty" : { | |
| "type" : "string", | |
| "enum" : [ "PROVISIONAL", "CONFIRMED" ] | |
| }, | |
| "encounter" : { | |
| "type" : "string" | |
| }, | |
| "formFieldNamespace" : { | |
| "type" : "string" | |
| }, | |
| "formFieldPath" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "TaskdefinitionGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "taskClass" : { | |
| "type" : "string" | |
| }, | |
| "startTime" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "started" : { | |
| "type" : "boolean" | |
| } | |
| } | |
| }, | |
| "TaskdefinitionGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "taskClass" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "TaskdefinitionGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "taskClass" : { | |
| "type" : "string" | |
| }, | |
| "startTime" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "lastExecutionTime" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "repeatInterval" : { | |
| "type" : "object" | |
| }, | |
| "startOnStartup" : { | |
| "type" : "boolean" | |
| }, | |
| "startTimePattern" : { | |
| "type" : "string" | |
| }, | |
| "started" : { | |
| "type" : "boolean" | |
| }, | |
| "properties" : { | |
| "type" : "object" | |
| } | |
| } | |
| }, | |
| "TaskdefinitionCreate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "taskClass" : { | |
| "type" : "string" | |
| }, | |
| "startTime" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "repeatInterval" : { | |
| "type" : "object" | |
| }, | |
| "startOnStartup" : { | |
| "type" : "boolean" | |
| }, | |
| "properties" : { | |
| "type" : "object" | |
| } | |
| } | |
| }, | |
| "TaskdefinitionCreateFull" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "taskClass" : { | |
| "type" : "string" | |
| }, | |
| "startTime" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "repeatInterval" : { | |
| "type" : "object" | |
| }, | |
| "startOnStartup" : { | |
| "type" : "boolean" | |
| }, | |
| "properties" : { | |
| "type" : "object" | |
| } | |
| } | |
| }, | |
| "TaskdefinitionUpdate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "taskClass" : { | |
| "type" : "string" | |
| }, | |
| "startTime" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "repeatInterval" : { | |
| "type" : "object" | |
| }, | |
| "startOnStartup" : { | |
| "type" : "boolean" | |
| }, | |
| "properties" : { | |
| "type" : "object" | |
| } | |
| } | |
| }, | |
| "DrugGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "dosageForm" : { | |
| "$ref" : "#/definitions/ConceptGet" | |
| }, | |
| "maximumDailyDose" : { | |
| "type" : "number", | |
| "format" : "double" | |
| }, | |
| "minimumDailyDose" : { | |
| "type" : "number", | |
| "format" : "double" | |
| }, | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptGet" | |
| }, | |
| "combination" : { | |
| "type" : "boolean" | |
| }, | |
| "strength" : { | |
| "type" : "string" | |
| }, | |
| "drugReferenceMaps" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/DrugreferencemapGet" | |
| } | |
| }, | |
| "ingredients" : { | |
| "type" : "object" | |
| } | |
| } | |
| }, | |
| "DrugGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "DrugGetFull" : { | |
| "properties" : { | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "dosageForm" : { | |
| "$ref" : "#/definitions/ConceptGetFull" | |
| }, | |
| "maximumDailyDose" : { | |
| "type" : "number", | |
| "format" : "double" | |
| }, | |
| "minimumDailyDose" : { | |
| "type" : "number", | |
| "format" : "double" | |
| }, | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptGetFull" | |
| }, | |
| "combination" : { | |
| "type" : "boolean" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| }, | |
| "strength" : { | |
| "type" : "string" | |
| }, | |
| "drugReferenceMaps" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/DrugreferencemapGetFull" | |
| } | |
| }, | |
| "ingredients" : { | |
| "type" : "object" | |
| } | |
| } | |
| }, | |
| "DrugCreate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "combination" : { | |
| "type" : "boolean" | |
| }, | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptCreate" | |
| }, | |
| "maximumDailyDose" : { | |
| "type" : "number", | |
| "format" : "double" | |
| }, | |
| "minimumDailyDose" : { | |
| "type" : "number", | |
| "format" : "double" | |
| }, | |
| "dosageForm" : { | |
| "$ref" : "#/definitions/ConceptCreate" | |
| }, | |
| "strength" : { | |
| "type" : "string" | |
| }, | |
| "drugReferenceMaps" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/DrugreferencemapCreate" | |
| } | |
| }, | |
| "ingredients" : { | |
| "type" : "object" | |
| } | |
| } | |
| }, | |
| "DrugCreateFull" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "combination" : { | |
| "type" : "boolean" | |
| }, | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptCreateFull" | |
| }, | |
| "maximumDailyDose" : { | |
| "type" : "number", | |
| "format" : "double" | |
| }, | |
| "minimumDailyDose" : { | |
| "type" : "number", | |
| "format" : "double" | |
| }, | |
| "dosageForm" : { | |
| "$ref" : "#/definitions/ConceptCreateFull" | |
| }, | |
| "strength" : { | |
| "type" : "string" | |
| }, | |
| "drugReferenceMaps" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/DrugreferencemapCreateFull" | |
| } | |
| }, | |
| "ingredients" : { | |
| "type" : "object" | |
| } | |
| } | |
| }, | |
| "DrugUpdate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "combination" : { | |
| "type" : "boolean" | |
| }, | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptUpdate" | |
| }, | |
| "maximumDailyDose" : { | |
| "type" : "number", | |
| "format" : "double" | |
| }, | |
| "minimumDailyDose" : { | |
| "type" : "number", | |
| "format" : "double" | |
| }, | |
| "dosageForm" : { | |
| "$ref" : "#/definitions/ConceptUpdate" | |
| }, | |
| "strength" : { | |
| "type" : "string" | |
| }, | |
| "drugReferenceMaps" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/DrugreferencemapUpdate" | |
| } | |
| } | |
| } | |
| }, | |
| "RelationshipGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "personA" : { | |
| "type" : "string" | |
| }, | |
| "relationshipType" : { | |
| "type" : "string" | |
| }, | |
| "personB" : { | |
| "type" : "string" | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| }, | |
| "startDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "endDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| } | |
| } | |
| }, | |
| "RelationshipGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "RelationshipGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "personA" : { | |
| "type" : "string" | |
| }, | |
| "relationshipType" : { | |
| "type" : "string" | |
| }, | |
| "personB" : { | |
| "type" : "string" | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| }, | |
| "startDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "endDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| } | |
| } | |
| }, | |
| "RelationshipCreate" : { | |
| "properties" : { | |
| "personA" : { | |
| "type" : "string" | |
| }, | |
| "relationshipType" : { | |
| "type" : "string" | |
| }, | |
| "personB" : { | |
| "type" : "string" | |
| }, | |
| "startDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "endDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| } | |
| } | |
| }, | |
| "RelationshipCreateFull" : { | |
| "properties" : { | |
| "personA" : { | |
| "type" : "string" | |
| }, | |
| "relationshipType" : { | |
| "type" : "string" | |
| }, | |
| "personB" : { | |
| "type" : "string" | |
| }, | |
| "startDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "endDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| } | |
| } | |
| }, | |
| "RelationshipUpdate" : { | |
| "properties" : { | |
| "relationshipType" : { | |
| "type" : "string" | |
| }, | |
| "startDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "endDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "PrivilegeGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "PrivilegeGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "PrivilegeGetFull" : { }, | |
| "PrivilegeCreate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "PrivilegeCreateFull" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "PrivilegeUpdate" : { | |
| "properties" : { | |
| "description" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "PersonattributetypeGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "format" : { | |
| "type" : "string" | |
| }, | |
| "foreignKey" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| }, | |
| "sortWeight" : { | |
| "type" : "number", | |
| "format" : "double" | |
| }, | |
| "searchable" : { | |
| "type" : "boolean" | |
| }, | |
| "editPrivilege" : { | |
| "$ref" : "#/definitions/PrivilegeGet" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "PersonattributetypeGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "PersonattributetypeGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "format" : { | |
| "type" : "string" | |
| }, | |
| "foreignKey" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| }, | |
| "sortWeight" : { | |
| "type" : "number", | |
| "format" : "double" | |
| }, | |
| "searchable" : { | |
| "type" : "boolean" | |
| }, | |
| "editPrivilege" : { | |
| "$ref" : "#/definitions/PrivilegeGetFull" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "concept" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "PersonattributetypeCreate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "format" : { | |
| "type" : "string" | |
| }, | |
| "foreignKey" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| }, | |
| "sortWeight" : { | |
| "type" : "number", | |
| "format" : "double" | |
| }, | |
| "searchable" : { | |
| "type" : "boolean" | |
| }, | |
| "editPrivilege" : { | |
| "$ref" : "#/definitions/PrivilegeCreate" | |
| } | |
| } | |
| }, | |
| "PersonattributetypeCreateFull" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "format" : { | |
| "type" : "string" | |
| }, | |
| "foreignKey" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| }, | |
| "sortWeight" : { | |
| "type" : "number", | |
| "format" : "double" | |
| }, | |
| "searchable" : { | |
| "type" : "boolean" | |
| }, | |
| "editPrivilege" : { | |
| "$ref" : "#/definitions/PrivilegeCreateFull" | |
| } | |
| } | |
| }, | |
| "PersonattributetypeUpdate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "format" : { | |
| "type" : "string" | |
| }, | |
| "foreignKey" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| }, | |
| "sortWeight" : { | |
| "type" : "number", | |
| "format" : "double" | |
| }, | |
| "searchable" : { | |
| "type" : "boolean" | |
| }, | |
| "editPrivilege" : { | |
| "$ref" : "#/definitions/PrivilegeUpdate" | |
| } | |
| } | |
| }, | |
| "ConceptreferencetermmapGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "termA" : { | |
| "type" : "string" | |
| }, | |
| "termB" : { | |
| "type" : "string" | |
| }, | |
| "conceptMapType" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptreferencetermmapGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptreferencetermmapGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "termA" : { | |
| "type" : "string" | |
| }, | |
| "termB" : { | |
| "type" : "string" | |
| }, | |
| "conceptMapType" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptreferencetermmapCreate" : { | |
| "properties" : { | |
| "termA" : { | |
| "type" : "string" | |
| }, | |
| "termB" : { | |
| "type" : "string" | |
| }, | |
| "conceptMapType" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptreferencetermmapCreateFull" : { | |
| "properties" : { | |
| "termA" : { | |
| "type" : "string" | |
| }, | |
| "termB" : { | |
| "type" : "string" | |
| }, | |
| "conceptMapType" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptreferencetermmapUpdate" : { | |
| "properties" : { | |
| "termA" : { | |
| "type" : "string" | |
| }, | |
| "termB" : { | |
| "type" : "string" | |
| }, | |
| "conceptMapType" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "EncounterGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "encounterDatetime" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "patient" : { | |
| "$ref" : "#/definitions/PatientGet" | |
| }, | |
| "location" : { | |
| "$ref" : "#/definitions/LocationGet" | |
| }, | |
| "form" : { | |
| "$ref" : "#/definitions/FormGet" | |
| }, | |
| "encounterType" : { | |
| "type" : "string" | |
| }, | |
| "obs" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ObsGet" | |
| } | |
| }, | |
| "orders" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/OrderGet" | |
| } | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| }, | |
| "visit" : { | |
| "type" : "string" | |
| }, | |
| "encounterProviders" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/EncounterEncounterproviderGet" | |
| } | |
| }, | |
| "diagnoses" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/PatientdiagnosesGet" | |
| } | |
| } | |
| } | |
| }, | |
| "EncounterGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "EncounterGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "encounterDatetime" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "patient" : { | |
| "$ref" : "#/definitions/PatientGetFull" | |
| }, | |
| "location" : { | |
| "$ref" : "#/definitions/LocationGetFull" | |
| }, | |
| "form" : { | |
| "$ref" : "#/definitions/FormGetFull" | |
| }, | |
| "encounterType" : { | |
| "type" : "string" | |
| }, | |
| "obs" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ObsGetFull" | |
| } | |
| }, | |
| "orders" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/OrderGetFull" | |
| } | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| }, | |
| "visit" : { | |
| "type" : "string" | |
| }, | |
| "encounterProviders" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/EncounterEncounterproviderGetFull" | |
| } | |
| }, | |
| "diagnoses" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/PatientdiagnosesGetFull" | |
| } | |
| } | |
| } | |
| }, | |
| "EncounterCreate" : { | |
| "properties" : { | |
| "encounterDatetime" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "patient" : { | |
| "$ref" : "#/definitions/PatientCreate" | |
| }, | |
| "encounterType" : { | |
| "type" : "string" | |
| }, | |
| "location" : { | |
| "$ref" : "#/definitions/LocationCreate" | |
| }, | |
| "form" : { | |
| "$ref" : "#/definitions/FormCreate" | |
| }, | |
| "provider" : { | |
| "type" : "string" | |
| }, | |
| "orders" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/OrderCreate" | |
| } | |
| }, | |
| "obs" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ObsCreate" | |
| } | |
| }, | |
| "visit" : { | |
| "type" : "string" | |
| }, | |
| "encounterProviders" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/EncounterEncounterproviderCreate" | |
| } | |
| }, | |
| "diagnoses" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/PatientdiagnosesCreate" | |
| } | |
| } | |
| } | |
| }, | |
| "EncounterCreateFull" : { | |
| "properties" : { | |
| "encounterDatetime" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "patient" : { | |
| "$ref" : "#/definitions/PatientCreateFull" | |
| }, | |
| "encounterType" : { | |
| "type" : "string" | |
| }, | |
| "location" : { | |
| "$ref" : "#/definitions/LocationCreateFull" | |
| }, | |
| "form" : { | |
| "$ref" : "#/definitions/FormCreateFull" | |
| }, | |
| "provider" : { | |
| "type" : "string" | |
| }, | |
| "orders" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/OrderCreateFull" | |
| } | |
| }, | |
| "obs" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ObsCreateFull" | |
| } | |
| }, | |
| "visit" : { | |
| "type" : "string" | |
| }, | |
| "encounterProviders" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/EncounterEncounterproviderCreateFull" | |
| } | |
| }, | |
| "diagnoses" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/PatientdiagnosesCreateFull" | |
| } | |
| } | |
| } | |
| }, | |
| "EncounterUpdate" : { | |
| "properties" : { | |
| "encounterDatetime" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "patient" : { | |
| "$ref" : "#/definitions/PatientUpdate" | |
| }, | |
| "encounterType" : { | |
| "type" : "string" | |
| }, | |
| "location" : { | |
| "$ref" : "#/definitions/LocationUpdate" | |
| }, | |
| "form" : { | |
| "$ref" : "#/definitions/FormUpdate" | |
| }, | |
| "provider" : { | |
| "type" : "string" | |
| }, | |
| "orders" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/OrderUpdate" | |
| } | |
| }, | |
| "obs" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ObsUpdate" | |
| } | |
| }, | |
| "visit" : { | |
| "type" : "string" | |
| }, | |
| "encounterProviders" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/EncounterEncounterproviderUpdate" | |
| } | |
| }, | |
| "diagnoses" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/PatientdiagnosesUpdate" | |
| } | |
| } | |
| } | |
| }, | |
| "FieldGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "fieldType" : { | |
| "$ref" : "#/definitions/FieldtypeGet" | |
| }, | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptGet" | |
| }, | |
| "tableName" : { | |
| "type" : "string" | |
| }, | |
| "attributeName" : { | |
| "type" : "string" | |
| }, | |
| "defaultValue" : { | |
| "type" : "string" | |
| }, | |
| "selectMultiple" : { | |
| "type" : "boolean" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "FieldGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "FieldGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "fieldType" : { | |
| "$ref" : "#/definitions/FieldtypeGetFull" | |
| }, | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptGetFull" | |
| }, | |
| "tableName" : { | |
| "type" : "string" | |
| }, | |
| "attributeName" : { | |
| "type" : "string" | |
| }, | |
| "defaultValue" : { | |
| "type" : "string" | |
| }, | |
| "selectMultiple" : { | |
| "type" : "boolean" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "FieldCreate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "fieldType" : { | |
| "$ref" : "#/definitions/FieldtypeCreate" | |
| }, | |
| "selectMultiple" : { | |
| "type" : "boolean" | |
| }, | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptCreate" | |
| }, | |
| "tableName" : { | |
| "type" : "string" | |
| }, | |
| "attributeName" : { | |
| "type" : "string" | |
| }, | |
| "defaultValue" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "FieldCreateFull" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "fieldType" : { | |
| "$ref" : "#/definitions/FieldtypeCreateFull" | |
| }, | |
| "selectMultiple" : { | |
| "type" : "boolean" | |
| }, | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptCreateFull" | |
| }, | |
| "tableName" : { | |
| "type" : "string" | |
| }, | |
| "attributeName" : { | |
| "type" : "string" | |
| }, | |
| "defaultValue" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "FieldUpdate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "fieldType" : { | |
| "$ref" : "#/definitions/FieldtypeUpdate" | |
| }, | |
| "selectMultiple" : { | |
| "type" : "boolean" | |
| }, | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptUpdate" | |
| }, | |
| "tableName" : { | |
| "type" : "string" | |
| }, | |
| "attributeName" : { | |
| "type" : "string" | |
| }, | |
| "defaultValue" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "OrdertypeGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "javaClassName" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "conceptClasses" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ConceptclassGet" | |
| } | |
| }, | |
| "parent" : { | |
| "$ref" : "#/definitions/OrdertypeGet" | |
| } | |
| } | |
| }, | |
| "OrdertypeGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "OrdertypeGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "javaClassName" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "conceptClasses" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ConceptclassGetFull" | |
| } | |
| }, | |
| "parent" : { | |
| "$ref" : "#/definitions/OrdertypeGetFull" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "OrdertypeCreate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "javaClassName" : { | |
| "type" : "string" | |
| }, | |
| "parent" : { | |
| "$ref" : "#/definitions/OrdertypeCreate" | |
| }, | |
| "conceptClasses" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ConceptclassCreate" | |
| } | |
| } | |
| } | |
| }, | |
| "OrdertypeCreateFull" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "javaClassName" : { | |
| "type" : "string" | |
| }, | |
| "parent" : { | |
| "$ref" : "#/definitions/OrdertypeCreateFull" | |
| }, | |
| "conceptClasses" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ConceptclassCreateFull" | |
| } | |
| } | |
| } | |
| }, | |
| "OrdertypeUpdate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "javaClassName" : { | |
| "type" : "string" | |
| }, | |
| "parent" : { | |
| "$ref" : "#/definitions/OrdertypeUpdate" | |
| }, | |
| "conceptClasses" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ConceptclassUpdate" | |
| } | |
| } | |
| } | |
| }, | |
| "ConditionGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "condition" : { | |
| "type" : "string" | |
| }, | |
| "patient" : { | |
| "$ref" : "#/definitions/PatientGet" | |
| }, | |
| "clinicalStatus" : { | |
| "type" : "string", | |
| "enum" : [ "ACTIVE", "INACTIVE", "HISTORY_OF", "RECURRENCE", "RELAPSE", "REMISSION", "RESOLVED" ] | |
| }, | |
| "verificationStatus" : { | |
| "type" : "string", | |
| "enum" : [ "PROVISIONAL", "CONFIRMED" ] | |
| }, | |
| "previousVersion" : { | |
| "$ref" : "#/definitions/ConditionGet" | |
| }, | |
| "onsetDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "endDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConditionGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "ConditionGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "condition" : { | |
| "type" : "string" | |
| }, | |
| "patient" : { | |
| "$ref" : "#/definitions/PatientGetFull" | |
| }, | |
| "clinicalStatus" : { | |
| "type" : "string", | |
| "enum" : [ "ACTIVE", "INACTIVE", "HISTORY_OF", "RECURRENCE", "RELAPSE", "REMISSION", "RESOLVED" ] | |
| }, | |
| "verificationStatus" : { | |
| "type" : "string", | |
| "enum" : [ "PROVISIONAL", "CONFIRMED" ] | |
| }, | |
| "previousVersion" : { | |
| "$ref" : "#/definitions/ConditionGetFull" | |
| }, | |
| "onsetDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "endDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "additionalDetail" : { | |
| "type" : "string" | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConditionCreate" : { | |
| "properties" : { | |
| "condition" : { | |
| "type" : "string" | |
| }, | |
| "patient" : { | |
| "$ref" : "#/definitions/PatientCreate" | |
| }, | |
| "clinicalStatus" : { | |
| "type" : "string", | |
| "enum" : [ "ACTIVE", "INACTIVE", "HISTORY_OF", "RECURRENCE", "RELAPSE", "REMISSION", "RESOLVED" ] | |
| }, | |
| "verificationStatus" : { | |
| "type" : "string", | |
| "enum" : [ "PROVISIONAL", "CONFIRMED" ] | |
| }, | |
| "onsetDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "endDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "additionalDetail" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConditionCreateFull" : { | |
| "properties" : { | |
| "condition" : { | |
| "type" : "string" | |
| }, | |
| "patient" : { | |
| "$ref" : "#/definitions/PatientCreateFull" | |
| }, | |
| "clinicalStatus" : { | |
| "type" : "string", | |
| "enum" : [ "ACTIVE", "INACTIVE", "HISTORY_OF", "RECURRENCE", "RELAPSE", "REMISSION", "RESOLVED" ] | |
| }, | |
| "verificationStatus" : { | |
| "type" : "string", | |
| "enum" : [ "PROVISIONAL", "CONFIRMED" ] | |
| }, | |
| "onsetDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "endDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "additionalDetail" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConditionUpdate" : { | |
| "properties" : { | |
| "condition" : { | |
| "type" : "string" | |
| }, | |
| "clinicalStatus" : { | |
| "type" : "string", | |
| "enum" : [ "ACTIVE", "INACTIVE", "HISTORY_OF", "RECURRENCE", "RELAPSE", "REMISSION", "RESOLVED" ] | |
| }, | |
| "verificationStatus" : { | |
| "type" : "string", | |
| "enum" : [ "PROVISIONAL", "CONFIRMED" ] | |
| }, | |
| "onsetDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "endDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "additionalDetail" : { | |
| "type" : "string" | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ProviderattributetypeGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "minOccurs" : { | |
| "type" : "string" | |
| }, | |
| "maxOccurs" : { | |
| "type" : "string" | |
| }, | |
| "datatypeClassname" : { | |
| "type" : "string" | |
| }, | |
| "preferredHandlerClassname" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ProviderattributetypeGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "ProviderattributetypeGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "minOccurs" : { | |
| "type" : "string" | |
| }, | |
| "maxOccurs" : { | |
| "type" : "string" | |
| }, | |
| "datatypeClassname" : { | |
| "type" : "string" | |
| }, | |
| "datatypeConfig" : { | |
| "type" : "string" | |
| }, | |
| "preferredHandlerClassname" : { | |
| "type" : "string" | |
| }, | |
| "handlerConfig" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ProviderattributetypeCreate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "datatypeClassname" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "minOccurs" : { | |
| "type" : "string" | |
| }, | |
| "maxOccurs" : { | |
| "type" : "string" | |
| }, | |
| "datatypeConfig" : { | |
| "type" : "string" | |
| }, | |
| "preferredHandlerClassname" : { | |
| "type" : "string" | |
| }, | |
| "handlerConfig" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ProviderattributetypeCreateFull" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "datatypeClassname" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "minOccurs" : { | |
| "type" : "string" | |
| }, | |
| "maxOccurs" : { | |
| "type" : "string" | |
| }, | |
| "datatypeConfig" : { | |
| "type" : "string" | |
| }, | |
| "preferredHandlerClassname" : { | |
| "type" : "string" | |
| }, | |
| "handlerConfig" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ProviderattributetypeUpdate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "datatypeClassname" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "minOccurs" : { | |
| "type" : "string" | |
| }, | |
| "maxOccurs" : { | |
| "type" : "string" | |
| }, | |
| "datatypeConfig" : { | |
| "type" : "string" | |
| }, | |
| "preferredHandlerClassname" : { | |
| "type" : "string" | |
| }, | |
| "handlerConfig" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptdatatypeGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "hl7Abbreviation" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptdatatypeGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "ConceptdatatypeGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "hl7Abbreviation" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptreferencetermGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "conceptSource" : { | |
| "$ref" : "#/definitions/ConceptsourceGet" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "code" : { | |
| "type" : "string" | |
| }, | |
| "version" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptreferencetermGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "ConceptreferencetermGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "conceptSource" : { | |
| "$ref" : "#/definitions/ConceptsourceGetFull" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "code" : { | |
| "type" : "string" | |
| }, | |
| "version" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptreferencetermCreate" : { | |
| "properties" : { | |
| "code" : { | |
| "type" : "string" | |
| }, | |
| "conceptSource" : { | |
| "$ref" : "#/definitions/ConceptsourceCreate" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "version" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptreferencetermCreateFull" : { | |
| "properties" : { | |
| "code" : { | |
| "type" : "string" | |
| }, | |
| "conceptSource" : { | |
| "$ref" : "#/definitions/ConceptsourceCreateFull" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "version" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptreferencetermUpdate" : { | |
| "properties" : { | |
| "code" : { | |
| "type" : "string" | |
| }, | |
| "conceptSource" : { | |
| "$ref" : "#/definitions/ConceptsourceUpdate" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "version" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "LocationtagGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "LocationtagGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "LocationtagGetFull" : { }, | |
| "LocationtagCreate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "retireReason" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "LocationtagCreateFull" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "retireReason" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "LocationtagUpdate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "retireReason" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptstopwordGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "value" : { | |
| "type" : "string" | |
| }, | |
| "locale" : { | |
| "type" : "object" | |
| } | |
| } | |
| }, | |
| "ConceptstopwordGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptstopwordGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "value" : { | |
| "type" : "string" | |
| }, | |
| "locale" : { | |
| "type" : "object" | |
| } | |
| } | |
| }, | |
| "ConceptstopwordCreate" : { | |
| "properties" : { | |
| "value" : { | |
| "type" : "string" | |
| }, | |
| "locale" : { | |
| "type" : "object" | |
| } | |
| } | |
| }, | |
| "ConceptstopwordCreateFull" : { | |
| "properties" : { | |
| "value" : { | |
| "type" : "string" | |
| }, | |
| "locale" : { | |
| "type" : "object" | |
| } | |
| } | |
| }, | |
| "ConceptstopwordUpdate" : { | |
| "properties" : { | |
| "value" : { | |
| "type" : "string" | |
| }, | |
| "locale" : { | |
| "type" : "object" | |
| } | |
| } | |
| }, | |
| "PersonGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "gender" : { | |
| "type" : "string" | |
| }, | |
| "age" : { | |
| "type" : "string" | |
| }, | |
| "birthdate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "birthdateEstimated" : { | |
| "type" : "boolean" | |
| }, | |
| "dead" : { | |
| "type" : "boolean" | |
| }, | |
| "deathDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "causeOfDeath" : { | |
| "$ref" : "#/definitions/ConceptGet" | |
| }, | |
| "preferredName" : { | |
| "type" : "string" | |
| }, | |
| "preferredAddress" : { | |
| "type" : "string" | |
| }, | |
| "attributes" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/PersonAttributeGet" | |
| } | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| }, | |
| "birthtime" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "deathdateEstimated" : { | |
| "type" : "boolean" | |
| } | |
| } | |
| }, | |
| "PersonGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "PersonGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "gender" : { | |
| "type" : "string" | |
| }, | |
| "age" : { | |
| "type" : "string" | |
| }, | |
| "birthdate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "birthdateEstimated" : { | |
| "type" : "boolean" | |
| }, | |
| "dead" : { | |
| "type" : "boolean" | |
| }, | |
| "deathDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "causeOfDeath" : { | |
| "$ref" : "#/definitions/ConceptGetFull" | |
| }, | |
| "preferredName" : { | |
| "type" : "string" | |
| }, | |
| "preferredAddress" : { | |
| "type" : "string" | |
| }, | |
| "names" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/PersonNameGetFull" | |
| } | |
| }, | |
| "addresses" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/PersonAddressGetFull" | |
| } | |
| }, | |
| "attributes" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/PersonAttributeGetFull" | |
| } | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| }, | |
| "birthtime" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "deathdateEstimated" : { | |
| "type" : "boolean" | |
| }, | |
| "causeOfDeathNonCoded" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "PersonCreate" : { | |
| "properties" : { | |
| "names" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/PersonNameCreate" | |
| } | |
| }, | |
| "gender" : { | |
| "type" : "string" | |
| }, | |
| "age" : { | |
| "type" : "string" | |
| }, | |
| "birthdate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "birthdateEstimated" : { | |
| "type" : "boolean" | |
| }, | |
| "dead" : { | |
| "type" : "boolean" | |
| }, | |
| "deathDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "causeOfDeath" : { | |
| "$ref" : "#/definitions/ConceptCreate" | |
| }, | |
| "addresses" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/PersonAddressCreate" | |
| } | |
| }, | |
| "attributes" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/PersonAttributeCreate" | |
| } | |
| }, | |
| "birthtime" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "deathdateEstimated" : { | |
| "type" : "boolean" | |
| }, | |
| "causeOfDeathNonCoded" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "PersonCreateFull" : { | |
| "properties" : { | |
| "names" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/PersonNameCreateFull" | |
| } | |
| }, | |
| "gender" : { | |
| "type" : "string" | |
| }, | |
| "age" : { | |
| "type" : "string" | |
| }, | |
| "birthdate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "birthdateEstimated" : { | |
| "type" : "boolean" | |
| }, | |
| "dead" : { | |
| "type" : "boolean" | |
| }, | |
| "deathDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "causeOfDeath" : { | |
| "$ref" : "#/definitions/ConceptCreateFull" | |
| }, | |
| "addresses" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/PersonAddressCreateFull" | |
| } | |
| }, | |
| "attributes" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/PersonAttributeCreateFull" | |
| } | |
| }, | |
| "birthtime" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "deathdateEstimated" : { | |
| "type" : "boolean" | |
| }, | |
| "causeOfDeathNonCoded" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "PersonUpdate" : { | |
| "properties" : { | |
| "age" : { | |
| "type" : "string" | |
| }, | |
| "gender" : { | |
| "type" : "string" | |
| }, | |
| "birthdate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "birthdateEstimated" : { | |
| "type" : "boolean" | |
| }, | |
| "preferredName" : { | |
| "type" : "string" | |
| }, | |
| "preferredAddress" : { | |
| "type" : "string" | |
| }, | |
| "addresses" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/PersonAddressUpdate" | |
| } | |
| }, | |
| "attributes" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/PersonAttributeUpdate" | |
| } | |
| }, | |
| "names" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/PersonNameUpdate" | |
| } | |
| }, | |
| "causeOfDeath" : { | |
| "$ref" : "#/definitions/ConceptUpdate" | |
| }, | |
| "dead" : { | |
| "type" : "boolean" | |
| }, | |
| "deathDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "birthtime" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "deathdateEstimated" : { | |
| "type" : "boolean" | |
| }, | |
| "causeOfDeathNonCoded" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "OrdersetGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "operator" : { | |
| "type" : "string", | |
| "enum" : [ "ALL", "ONE", "ANY" ] | |
| }, | |
| "orderSetMembers" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/OrdersetOrdersetmemberGet" | |
| } | |
| } | |
| } | |
| }, | |
| "OrdersetGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "OrdersetGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| }, | |
| "operator" : { | |
| "type" : "string", | |
| "enum" : [ "ALL", "ONE", "ANY" ] | |
| }, | |
| "orderSetMembers" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/OrdersetOrdersetmemberGetFull" | |
| } | |
| } | |
| } | |
| }, | |
| "OrdersetCreate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "operator" : { | |
| "type" : "string", | |
| "enum" : [ "ALL", "ONE", "ANY" ] | |
| }, | |
| "orderSetMembers" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/OrdersetOrdersetmemberCreate" | |
| } | |
| } | |
| } | |
| }, | |
| "OrdersetCreateFull" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "operator" : { | |
| "type" : "string", | |
| "enum" : [ "ALL", "ONE", "ANY" ] | |
| }, | |
| "orderSetMembers" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/OrdersetOrdersetmemberCreateFull" | |
| } | |
| } | |
| } | |
| }, | |
| "OrdersetUpdate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "operator" : { | |
| "type" : "string", | |
| "enum" : [ "ALL", "ONE", "ANY" ] | |
| }, | |
| "orderSetMembers" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/OrdersetOrdersetmemberUpdate" | |
| } | |
| } | |
| } | |
| }, | |
| "ProviderGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "person" : { | |
| "$ref" : "#/definitions/PersonGet" | |
| }, | |
| "identifier" : { | |
| "type" : "string" | |
| }, | |
| "attributes" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ProviderGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "ProviderGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "person" : { | |
| "$ref" : "#/definitions/PersonGetFull" | |
| }, | |
| "identifier" : { | |
| "type" : "string" | |
| }, | |
| "attributes" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ProviderCreate" : { | |
| "properties" : { | |
| "person" : { | |
| "$ref" : "#/definitions/PersonCreate" | |
| }, | |
| "identifier" : { | |
| "type" : "string" | |
| }, | |
| "attributes" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ProviderCreateFull" : { | |
| "properties" : { | |
| "person" : { | |
| "$ref" : "#/definitions/PersonCreateFull" | |
| }, | |
| "identifier" : { | |
| "type" : "string" | |
| }, | |
| "attributes" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ProviderUpdate" : { | |
| "properties" : { | |
| "person" : { | |
| "$ref" : "#/definitions/PersonUpdate" | |
| }, | |
| "identifier" : { | |
| "type" : "string" | |
| }, | |
| "attributes" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ObsGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptGet" | |
| }, | |
| "person" : { | |
| "$ref" : "#/definitions/PersonGet" | |
| }, | |
| "obsDatetime" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "accessionNumber" : { | |
| "type" : "string" | |
| }, | |
| "obsGroup" : { | |
| "$ref" : "#/definitions/ObsGet" | |
| }, | |
| "valueCodedName" : { | |
| "type" : "string" | |
| }, | |
| "groupMembers" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ObsGet" | |
| } | |
| }, | |
| "comment" : { | |
| "type" : "string" | |
| }, | |
| "location" : { | |
| "$ref" : "#/definitions/LocationGet" | |
| }, | |
| "order" : { | |
| "type" : "string" | |
| }, | |
| "encounter" : { | |
| "$ref" : "#/definitions/EncounterGet" | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| }, | |
| "value" : { | |
| "type" : "string" | |
| }, | |
| "valueModifier" : { | |
| "type" : "string" | |
| }, | |
| "formFieldPath" : { | |
| "type" : "string" | |
| }, | |
| "formFieldNamespace" : { | |
| "type" : "string" | |
| }, | |
| "status" : { | |
| "type" : "string", | |
| "enum" : [ "PRELIMINARY", "FINAL", "AMENDED" ] | |
| }, | |
| "interpretation" : { | |
| "type" : "string", | |
| "enum" : [ "NORMAL", "ABNORMAL", "CRITICALLY_ABNORMAL", "NEGATIVE", "POSITIVE", "CRITICALLY_LOW", "LOW", "HIGH", "CRITICALLY_HIGH", "VERY_SUSCEPTIBLE", "SUSCEPTIBLE", "INTERMEDIATE", "RESISTANT", "SIGNIFICANT_CHANGE_DOWN", "SIGNIFICANT_CHANGE_UP", "OFF_SCALE_LOW", "OFF_SCALE_HIGH" ] | |
| } | |
| } | |
| }, | |
| "ObsGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "ObsGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptGetFull" | |
| }, | |
| "person" : { | |
| "$ref" : "#/definitions/PersonGetFull" | |
| }, | |
| "obsDatetime" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "accessionNumber" : { | |
| "type" : "string" | |
| }, | |
| "obsGroup" : { | |
| "$ref" : "#/definitions/ObsGetFull" | |
| }, | |
| "valueCodedName" : { | |
| "type" : "string" | |
| }, | |
| "groupMembers" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ObsGetFull" | |
| } | |
| }, | |
| "comment" : { | |
| "type" : "string" | |
| }, | |
| "location" : { | |
| "$ref" : "#/definitions/LocationGetFull" | |
| }, | |
| "order" : { | |
| "type" : "string" | |
| }, | |
| "encounter" : { | |
| "$ref" : "#/definitions/EncounterGetFull" | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| }, | |
| "value" : { | |
| "type" : "string" | |
| }, | |
| "valueModifier" : { | |
| "type" : "string" | |
| }, | |
| "formFieldPath" : { | |
| "type" : "string" | |
| }, | |
| "formFieldNamespace" : { | |
| "type" : "string" | |
| }, | |
| "status" : { | |
| "type" : "string", | |
| "enum" : [ "PRELIMINARY", "FINAL", "AMENDED" ] | |
| }, | |
| "interpretation" : { | |
| "type" : "string", | |
| "enum" : [ "NORMAL", "ABNORMAL", "CRITICALLY_ABNORMAL", "NEGATIVE", "POSITIVE", "CRITICALLY_LOW", "LOW", "HIGH", "CRITICALLY_HIGH", "VERY_SUSCEPTIBLE", "SUSCEPTIBLE", "INTERMEDIATE", "RESISTANT", "SIGNIFICANT_CHANGE_DOWN", "SIGNIFICANT_CHANGE_UP", "OFF_SCALE_LOW", "OFF_SCALE_HIGH" ] | |
| } | |
| } | |
| }, | |
| "ObsCreate" : { | |
| "properties" : { | |
| "person" : { | |
| "$ref" : "#/definitions/PersonCreate" | |
| }, | |
| "obsDatetime" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptCreate" | |
| }, | |
| "location" : { | |
| "$ref" : "#/definitions/LocationCreate" | |
| }, | |
| "order" : { | |
| "type" : "string" | |
| }, | |
| "encounter" : { | |
| "$ref" : "#/definitions/EncounterCreate" | |
| }, | |
| "accessionNumber" : { | |
| "type" : "string" | |
| }, | |
| "groupMembers" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ObsCreate" | |
| } | |
| }, | |
| "valueCodedName" : { | |
| "type" : "string" | |
| }, | |
| "comment" : { | |
| "type" : "string" | |
| }, | |
| "value" : { | |
| "type" : "string" | |
| }, | |
| "valueModifier" : { | |
| "type" : "string" | |
| }, | |
| "formFieldPath" : { | |
| "type" : "string" | |
| }, | |
| "formFieldNamespace" : { | |
| "type" : "string" | |
| }, | |
| "status" : { | |
| "type" : "string", | |
| "enum" : [ "PRELIMINARY", "FINAL", "AMENDED" ] | |
| }, | |
| "interpretation" : { | |
| "type" : "string", | |
| "enum" : [ "NORMAL", "ABNORMAL", "CRITICALLY_ABNORMAL", "NEGATIVE", "POSITIVE", "CRITICALLY_LOW", "LOW", "HIGH", "CRITICALLY_HIGH", "VERY_SUSCEPTIBLE", "SUSCEPTIBLE", "INTERMEDIATE", "RESISTANT", "SIGNIFICANT_CHANGE_DOWN", "SIGNIFICANT_CHANGE_UP", "OFF_SCALE_LOW", "OFF_SCALE_HIGH" ] | |
| } | |
| } | |
| }, | |
| "ObsCreateFull" : { | |
| "properties" : { | |
| "person" : { | |
| "$ref" : "#/definitions/PersonCreateFull" | |
| }, | |
| "obsDatetime" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptCreateFull" | |
| }, | |
| "location" : { | |
| "$ref" : "#/definitions/LocationCreateFull" | |
| }, | |
| "order" : { | |
| "type" : "string" | |
| }, | |
| "encounter" : { | |
| "$ref" : "#/definitions/EncounterCreateFull" | |
| }, | |
| "accessionNumber" : { | |
| "type" : "string" | |
| }, | |
| "groupMembers" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ObsCreateFull" | |
| } | |
| }, | |
| "valueCodedName" : { | |
| "type" : "string" | |
| }, | |
| "comment" : { | |
| "type" : "string" | |
| }, | |
| "value" : { | |
| "type" : "string" | |
| }, | |
| "valueModifier" : { | |
| "type" : "string" | |
| }, | |
| "formFieldPath" : { | |
| "type" : "string" | |
| }, | |
| "formFieldNamespace" : { | |
| "type" : "string" | |
| }, | |
| "status" : { | |
| "type" : "string", | |
| "enum" : [ "PRELIMINARY", "FINAL", "AMENDED" ] | |
| }, | |
| "interpretation" : { | |
| "type" : "string", | |
| "enum" : [ "NORMAL", "ABNORMAL", "CRITICALLY_ABNORMAL", "NEGATIVE", "POSITIVE", "CRITICALLY_LOW", "LOW", "HIGH", "CRITICALLY_HIGH", "VERY_SUSCEPTIBLE", "SUSCEPTIBLE", "INTERMEDIATE", "RESISTANT", "SIGNIFICANT_CHANGE_DOWN", "SIGNIFICANT_CHANGE_UP", "OFF_SCALE_LOW", "OFF_SCALE_HIGH" ] | |
| } | |
| } | |
| }, | |
| "ObsUpdate" : { | |
| "properties" : { | |
| "person" : { | |
| "$ref" : "#/definitions/PersonUpdate" | |
| }, | |
| "obsDatetime" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptUpdate" | |
| }, | |
| "location" : { | |
| "$ref" : "#/definitions/LocationUpdate" | |
| }, | |
| "order" : { | |
| "type" : "string" | |
| }, | |
| "encounter" : { | |
| "$ref" : "#/definitions/EncounterUpdate" | |
| }, | |
| "accessionNumber" : { | |
| "type" : "string" | |
| }, | |
| "groupMembers" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/ObsUpdate" | |
| } | |
| }, | |
| "valueCodedName" : { | |
| "type" : "string" | |
| }, | |
| "comment" : { | |
| "type" : "string" | |
| }, | |
| "value" : { | |
| "type" : "string" | |
| }, | |
| "valueModifier" : { | |
| "type" : "string" | |
| }, | |
| "formFieldPath" : { | |
| "type" : "string" | |
| }, | |
| "formFieldNamespace" : { | |
| "type" : "string" | |
| }, | |
| "status" : { | |
| "type" : "string", | |
| "enum" : [ "PRELIMINARY", "FINAL", "AMENDED" ] | |
| }, | |
| "interpretation" : { | |
| "type" : "string", | |
| "enum" : [ "NORMAL", "ABNORMAL", "CRITICALLY_ABNORMAL", "NEGATIVE", "POSITIVE", "CRITICALLY_LOW", "LOW", "HIGH", "CRITICALLY_HIGH", "VERY_SUSCEPTIBLE", "SUSCEPTIBLE", "INTERMEDIATE", "RESISTANT", "SIGNIFICANT_CHANGE_DOWN", "SIGNIFICANT_CHANGE_UP", "OFF_SCALE_LOW", "OFF_SCALE_HIGH" ] | |
| } | |
| } | |
| }, | |
| "RelationshiptypeGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "aIsToB" : { | |
| "type" : "string" | |
| }, | |
| "bIsToA" : { | |
| "type" : "string" | |
| }, | |
| "displayAIsToB" : { | |
| "type" : "string" | |
| }, | |
| "displayBIsToA" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "RelationshiptypeGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "RelationshiptypeGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "aIsToB" : { | |
| "type" : "string" | |
| }, | |
| "bIsToA" : { | |
| "type" : "string" | |
| }, | |
| "displayAIsToB" : { | |
| "type" : "string" | |
| }, | |
| "displayBIsToA" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "weight" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "RelationshiptypeCreate" : { | |
| "properties" : { | |
| "aIsToB" : { | |
| "type" : "string" | |
| }, | |
| "bIsToA" : { | |
| "type" : "string" | |
| }, | |
| "weight" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "RelationshiptypeCreateFull" : { | |
| "properties" : { | |
| "aIsToB" : { | |
| "type" : "string" | |
| }, | |
| "bIsToA" : { | |
| "type" : "string" | |
| }, | |
| "weight" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "RelationshiptypeUpdate" : { | |
| "properties" : { | |
| "aIsToB" : { | |
| "type" : "string" | |
| }, | |
| "bIsToA" : { | |
| "type" : "string" | |
| }, | |
| "weight" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptattributetypeGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "minOccurs" : { | |
| "type" : "string" | |
| }, | |
| "maxOccurs" : { | |
| "type" : "string" | |
| }, | |
| "datatypeClassname" : { | |
| "type" : "string" | |
| }, | |
| "preferredHandlerClassname" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptattributetypeGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "ConceptattributetypeGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "minOccurs" : { | |
| "type" : "string" | |
| }, | |
| "maxOccurs" : { | |
| "type" : "string" | |
| }, | |
| "datatypeClassname" : { | |
| "type" : "string" | |
| }, | |
| "datatypeConfig" : { | |
| "type" : "string" | |
| }, | |
| "preferredHandlerClassname" : { | |
| "type" : "string" | |
| }, | |
| "handlerConfig" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptattributetypeCreate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "datatypeClassname" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "minOccurs" : { | |
| "type" : "string" | |
| }, | |
| "maxOccurs" : { | |
| "type" : "string" | |
| }, | |
| "datatypeConfig" : { | |
| "type" : "string" | |
| }, | |
| "preferredHandlerClassname" : { | |
| "type" : "string" | |
| }, | |
| "handlerConfig" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptattributetypeCreateFull" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "datatypeClassname" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "minOccurs" : { | |
| "type" : "string" | |
| }, | |
| "maxOccurs" : { | |
| "type" : "string" | |
| }, | |
| "datatypeConfig" : { | |
| "type" : "string" | |
| }, | |
| "preferredHandlerClassname" : { | |
| "type" : "string" | |
| }, | |
| "handlerConfig" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptattributetypeUpdate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "datatypeClassname" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "minOccurs" : { | |
| "type" : "string" | |
| }, | |
| "maxOccurs" : { | |
| "type" : "string" | |
| }, | |
| "datatypeConfig" : { | |
| "type" : "string" | |
| }, | |
| "preferredHandlerClassname" : { | |
| "type" : "string" | |
| }, | |
| "handlerConfig" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "TaskactionCreate" : { | |
| "properties" : { | |
| "tasks" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/TaskdefinitionCreate" | |
| } | |
| }, | |
| "allTasks" : { | |
| "type" : "boolean" | |
| }, | |
| "action" : { | |
| "type" : "string", | |
| "enum" : [ "SCHEDULETASK", "SHUTDOWNTASK", "RESCHEDULETASK", "RESCHEDULEALLTASKS", "DELETE", "RUNTASK" ] | |
| } | |
| } | |
| }, | |
| "TaskactionCreateFull" : { | |
| "properties" : { | |
| "tasks" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/TaskdefinitionCreateFull" | |
| } | |
| }, | |
| "allTasks" : { | |
| "type" : "boolean" | |
| }, | |
| "action" : { | |
| "type" : "string", | |
| "enum" : [ "SCHEDULETASK", "SHUTDOWNTASK", "RESCHEDULETASK", "RESCHEDULEALLTASKS", "DELETE", "RUNTASK" ] | |
| } | |
| } | |
| }, | |
| "TaskactionGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| }, | |
| "tasks" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/TaskdefinitionGet" | |
| } | |
| }, | |
| "action" : { | |
| "type" : "string", | |
| "enum" : [ "SCHEDULETASK", "SHUTDOWNTASK", "RESCHEDULETASK", "RESCHEDULEALLTASKS", "DELETE", "RUNTASK" ] | |
| } | |
| } | |
| }, | |
| "TaskactionGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| }, | |
| "tasks" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/TaskdefinitionGetRef" | |
| } | |
| }, | |
| "action" : { | |
| "type" : "string", | |
| "enum" : [ "SCHEDULETASK", "SHUTDOWNTASK", "RESCHEDULETASK", "RESCHEDULEALLTASKS", "DELETE", "RUNTASK" ] | |
| } | |
| } | |
| }, | |
| "TaskactionGetFull" : { | |
| "properties" : { | |
| "tasks" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/TaskdefinitionGetFull" | |
| } | |
| }, | |
| "action" : { | |
| "type" : "string", | |
| "enum" : [ "SCHEDULETASK", "SHUTDOWNTASK", "RESCHEDULETASK", "RESCHEDULEALLTASKS", "DELETE", "RUNTASK" ] | |
| } | |
| } | |
| }, | |
| "EncountertypeGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "EncountertypeGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "EncountertypeGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "EncountertypeCreate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "EncountertypeCreateFull" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "EncountertypeUpdate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ProgramGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptGet" | |
| }, | |
| "allWorkflows" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/WorkflowGet" | |
| } | |
| }, | |
| "outcomesConcept" : { | |
| "$ref" : "#/definitions/ConceptGet" | |
| } | |
| } | |
| }, | |
| "ProgramGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "allWorkflows" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/WorkflowGetRef" | |
| } | |
| } | |
| } | |
| }, | |
| "ProgramGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptGetFull" | |
| }, | |
| "outcomesConcept" : { | |
| "$ref" : "#/definitions/ConceptGetFull" | |
| }, | |
| "allWorkflows" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/WorkflowGetFull" | |
| } | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ProgramCreate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptCreate" | |
| }, | |
| "outcomesConcept" : { | |
| "$ref" : "#/definitions/ConceptCreate" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ProgramCreateFull" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptCreateFull" | |
| }, | |
| "outcomesConcept" : { | |
| "$ref" : "#/definitions/ConceptCreateFull" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ProgramUpdate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptUpdate" | |
| }, | |
| "outcomesConcept" : { | |
| "$ref" : "#/definitions/ConceptUpdate" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "OrderGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "orderNumber" : { | |
| "type" : "string" | |
| }, | |
| "accessionNumber" : { | |
| "type" : "string" | |
| }, | |
| "patient" : { | |
| "$ref" : "#/definitions/PatientGet" | |
| }, | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptGet" | |
| }, | |
| "action" : { | |
| "type" : "string", | |
| "enum" : [ "NEW", "REVISE", "DISCONTINUE", "RENEW" ] | |
| }, | |
| "careSetting" : { | |
| "$ref" : "#/definitions/CaresettingGet" | |
| }, | |
| "previousOrder" : { | |
| "$ref" : "#/definitions/OrderGet" | |
| }, | |
| "dateActivated" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "scheduledDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "dateStopped" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "autoExpireDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "encounter" : { | |
| "$ref" : "#/definitions/EncounterGet" | |
| }, | |
| "orderer" : { | |
| "$ref" : "#/definitions/ProviderGet" | |
| }, | |
| "orderReason" : { | |
| "$ref" : "#/definitions/ConceptGet" | |
| }, | |
| "orderReasonNonCoded" : { | |
| "type" : "string" | |
| }, | |
| "orderType" : { | |
| "$ref" : "#/definitions/OrdertypeGet" | |
| }, | |
| "urgency" : { | |
| "type" : "string", | |
| "enum" : [ "ROUTINE", "STAT", "ON_SCHEDULED_DATE" ] | |
| }, | |
| "instructions" : { | |
| "type" : "string" | |
| }, | |
| "commentToFulfiller" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "OrderGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "OrderGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "orderNumber" : { | |
| "type" : "string" | |
| }, | |
| "accessionNumber" : { | |
| "type" : "string" | |
| }, | |
| "patient" : { | |
| "$ref" : "#/definitions/PatientGetFull" | |
| }, | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptGetFull" | |
| }, | |
| "action" : { | |
| "type" : "string", | |
| "enum" : [ "NEW", "REVISE", "DISCONTINUE", "RENEW" ] | |
| }, | |
| "careSetting" : { | |
| "$ref" : "#/definitions/CaresettingGetFull" | |
| }, | |
| "previousOrder" : { | |
| "$ref" : "#/definitions/OrderGetFull" | |
| }, | |
| "dateActivated" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "scheduledDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "dateStopped" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "autoExpireDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "encounter" : { | |
| "$ref" : "#/definitions/EncounterGetFull" | |
| }, | |
| "orderer" : { | |
| "$ref" : "#/definitions/ProviderGetFull" | |
| }, | |
| "orderReason" : { | |
| "$ref" : "#/definitions/ConceptGetFull" | |
| }, | |
| "orderReasonNonCoded" : { | |
| "type" : "string" | |
| }, | |
| "orderType" : { | |
| "$ref" : "#/definitions/OrdertypeGetFull" | |
| }, | |
| "urgency" : { | |
| "type" : "string", | |
| "enum" : [ "ROUTINE", "STAT", "ON_SCHEDULED_DATE" ] | |
| }, | |
| "instructions" : { | |
| "type" : "string" | |
| }, | |
| "commentToFulfiller" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| }, | |
| "fulfillerStatus" : { | |
| "type" : "string", | |
| "enum" : [ "RECEIVED", "IN_PROGRESS", "EXCEPTION", "ON_HOLD", "DECLINED", "COMPLETED" ] | |
| }, | |
| "fulfillerComment" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "OrderCreate" : { | |
| "properties" : { | |
| "encounter" : { | |
| "$ref" : "#/definitions/EncounterCreate" | |
| }, | |
| "action" : { | |
| "type" : "string", | |
| "enum" : [ "NEW", "REVISE", "DISCONTINUE", "RENEW" ] | |
| }, | |
| "accessionNumber" : { | |
| "type" : "string" | |
| }, | |
| "dateActivated" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "scheduledDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "patient" : { | |
| "$ref" : "#/definitions/PatientCreate" | |
| }, | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptCreate" | |
| }, | |
| "careSetting" : { | |
| "$ref" : "#/definitions/CaresettingCreate" | |
| }, | |
| "dateStopped" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "autoExpireDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "orderer" : { | |
| "$ref" : "#/definitions/ProviderCreate" | |
| }, | |
| "previousOrder" : { | |
| "$ref" : "#/definitions/OrderCreate" | |
| }, | |
| "urgency" : { | |
| "type" : "string", | |
| "enum" : [ "ROUTINE", "STAT", "ON_SCHEDULED_DATE" ] | |
| }, | |
| "orderType" : { | |
| "$ref" : "#/definitions/OrdertypeCreate" | |
| }, | |
| "orderReason" : { | |
| "$ref" : "#/definitions/ConceptCreate" | |
| }, | |
| "orderReasonNonCoded" : { | |
| "type" : "string" | |
| }, | |
| "instructions" : { | |
| "type" : "string" | |
| }, | |
| "commentToFulfiller" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "OrderCreateFull" : { | |
| "properties" : { | |
| "encounter" : { | |
| "$ref" : "#/definitions/EncounterCreateFull" | |
| }, | |
| "action" : { | |
| "type" : "string", | |
| "enum" : [ "NEW", "REVISE", "DISCONTINUE", "RENEW" ] | |
| }, | |
| "accessionNumber" : { | |
| "type" : "string" | |
| }, | |
| "dateActivated" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "scheduledDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "patient" : { | |
| "$ref" : "#/definitions/PatientCreateFull" | |
| }, | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptCreateFull" | |
| }, | |
| "careSetting" : { | |
| "$ref" : "#/definitions/CaresettingCreateFull" | |
| }, | |
| "dateStopped" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "autoExpireDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "orderer" : { | |
| "$ref" : "#/definitions/ProviderCreateFull" | |
| }, | |
| "previousOrder" : { | |
| "$ref" : "#/definitions/OrderCreateFull" | |
| }, | |
| "urgency" : { | |
| "type" : "string", | |
| "enum" : [ "ROUTINE", "STAT", "ON_SCHEDULED_DATE" ] | |
| }, | |
| "orderType" : { | |
| "$ref" : "#/definitions/OrdertypeCreateFull" | |
| }, | |
| "orderReason" : { | |
| "$ref" : "#/definitions/ConceptCreateFull" | |
| }, | |
| "orderReasonNonCoded" : { | |
| "type" : "string" | |
| }, | |
| "instructions" : { | |
| "type" : "string" | |
| }, | |
| "commentToFulfiller" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "VisitGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "patient" : { | |
| "$ref" : "#/definitions/PatientGet" | |
| }, | |
| "visitType" : { | |
| "$ref" : "#/definitions/VisittypeGet" | |
| }, | |
| "indication" : { | |
| "$ref" : "#/definitions/ConceptGet" | |
| }, | |
| "location" : { | |
| "$ref" : "#/definitions/LocationGet" | |
| }, | |
| "startDatetime" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "stopDatetime" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "encounters" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/EncounterGet" | |
| } | |
| }, | |
| "attributes" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/VisitAttributeGet" | |
| } | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "VisitGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "VisitGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "patient" : { | |
| "$ref" : "#/definitions/PatientGetFull" | |
| }, | |
| "visitType" : { | |
| "$ref" : "#/definitions/VisittypeGetFull" | |
| }, | |
| "indication" : { | |
| "$ref" : "#/definitions/ConceptGetFull" | |
| }, | |
| "location" : { | |
| "$ref" : "#/definitions/LocationGetFull" | |
| }, | |
| "startDatetime" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "stopDatetime" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "encounters" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/EncounterGetFull" | |
| } | |
| }, | |
| "attributes" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/VisitAttributeGetFull" | |
| } | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "VisitCreate" : { | |
| "properties" : { | |
| "patient" : { | |
| "$ref" : "#/definitions/PatientCreate" | |
| }, | |
| "visitType" : { | |
| "$ref" : "#/definitions/VisittypeCreate" | |
| }, | |
| "startDatetime" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "location" : { | |
| "$ref" : "#/definitions/LocationCreate" | |
| }, | |
| "indication" : { | |
| "$ref" : "#/definitions/ConceptCreate" | |
| }, | |
| "stopDatetime" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "encounters" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/EncounterCreate" | |
| } | |
| }, | |
| "attributes" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/VisitAttributeCreate" | |
| } | |
| } | |
| } | |
| }, | |
| "VisitCreateFull" : { | |
| "properties" : { | |
| "patient" : { | |
| "$ref" : "#/definitions/PatientCreateFull" | |
| }, | |
| "visitType" : { | |
| "$ref" : "#/definitions/VisittypeCreateFull" | |
| }, | |
| "startDatetime" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "location" : { | |
| "$ref" : "#/definitions/LocationCreateFull" | |
| }, | |
| "indication" : { | |
| "$ref" : "#/definitions/ConceptCreateFull" | |
| }, | |
| "stopDatetime" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "encounters" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/EncounterCreateFull" | |
| } | |
| }, | |
| "attributes" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/VisitAttributeCreateFull" | |
| } | |
| } | |
| } | |
| }, | |
| "VisitUpdate" : { | |
| "properties" : { | |
| "visitType" : { | |
| "$ref" : "#/definitions/VisittypeUpdate" | |
| }, | |
| "startDatetime" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "location" : { | |
| "$ref" : "#/definitions/LocationUpdate" | |
| }, | |
| "indication" : { | |
| "$ref" : "#/definitions/ConceptUpdate" | |
| }, | |
| "stopDatetime" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "encounters" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/EncounterUpdate" | |
| } | |
| }, | |
| "attributes" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/VisitAttributeUpdate" | |
| } | |
| } | |
| } | |
| }, | |
| "PatientidentifiertypeGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "format" : { | |
| "type" : "string" | |
| }, | |
| "formatDescription" : { | |
| "type" : "string" | |
| }, | |
| "required" : { | |
| "type" : "boolean" | |
| }, | |
| "validator" : { | |
| "type" : "string" | |
| }, | |
| "locationBehavior" : { | |
| "type" : "string", | |
| "enum" : [ "REQUIRED", "NOT_USED" ] | |
| }, | |
| "uniquenessBehavior" : { | |
| "type" : "string", | |
| "enum" : [ "UNIQUE", "NON_UNIQUE", "LOCATION" ] | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "PatientidentifiertypeGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "PatientidentifiertypeGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "format" : { | |
| "type" : "string" | |
| }, | |
| "formatDescription" : { | |
| "type" : "string" | |
| }, | |
| "required" : { | |
| "type" : "boolean" | |
| }, | |
| "validator" : { | |
| "type" : "string" | |
| }, | |
| "locationBehavior" : { | |
| "type" : "string", | |
| "enum" : [ "REQUIRED", "NOT_USED" ] | |
| }, | |
| "uniquenessBehavior" : { | |
| "type" : "string", | |
| "enum" : [ "UNIQUE", "NON_UNIQUE", "LOCATION" ] | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "PatientidentifiertypeCreate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "format" : { | |
| "type" : "string" | |
| }, | |
| "formatDescription" : { | |
| "type" : "string" | |
| }, | |
| "required" : { | |
| "type" : "boolean" | |
| }, | |
| "validator" : { | |
| "type" : "string" | |
| }, | |
| "locationBehavior" : { | |
| "type" : "string", | |
| "enum" : [ "REQUIRED", "NOT_USED" ] | |
| }, | |
| "uniquenessBehavior" : { | |
| "type" : "string", | |
| "enum" : [ "UNIQUE", "NON_UNIQUE", "LOCATION" ] | |
| } | |
| } | |
| }, | |
| "PatientidentifiertypeCreateFull" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "format" : { | |
| "type" : "string" | |
| }, | |
| "formatDescription" : { | |
| "type" : "string" | |
| }, | |
| "required" : { | |
| "type" : "boolean" | |
| }, | |
| "validator" : { | |
| "type" : "string" | |
| }, | |
| "locationBehavior" : { | |
| "type" : "string", | |
| "enum" : [ "REQUIRED", "NOT_USED" ] | |
| }, | |
| "uniquenessBehavior" : { | |
| "type" : "string", | |
| "enum" : [ "UNIQUE", "NON_UNIQUE", "LOCATION" ] | |
| } | |
| } | |
| }, | |
| "PatientidentifiertypeUpdate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "format" : { | |
| "type" : "string" | |
| }, | |
| "formatDescription" : { | |
| "type" : "string" | |
| }, | |
| "required" : { | |
| "type" : "boolean" | |
| }, | |
| "validator" : { | |
| "type" : "string" | |
| }, | |
| "locationBehavior" : { | |
| "type" : "string", | |
| "enum" : [ "REQUIRED", "NOT_USED" ] | |
| }, | |
| "uniquenessBehavior" : { | |
| "type" : "string", | |
| "enum" : [ "UNIQUE", "NON_UNIQUE", "LOCATION" ] | |
| } | |
| } | |
| }, | |
| "AlertGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "alertId" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| }, | |
| "text" : { | |
| "type" : "string" | |
| }, | |
| "satisfiedByAny" : { | |
| "type" : "boolean" | |
| }, | |
| "dateToExpire" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "alertRead" : { | |
| "type" : "boolean" | |
| }, | |
| "recipients" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/AlertRecipientGet" | |
| } | |
| } | |
| } | |
| }, | |
| "AlertGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "alertId" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| } | |
| }, | |
| "AlertGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "alertId" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| }, | |
| "text" : { | |
| "type" : "string" | |
| }, | |
| "satisfiedByAny" : { | |
| "type" : "boolean" | |
| }, | |
| "alertRead" : { | |
| "type" : "boolean" | |
| }, | |
| "dateToExpire" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "creator" : { | |
| "type" : "string" | |
| }, | |
| "dateCreated" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "changedBy" : { | |
| "type" : "string" | |
| }, | |
| "dateChanged" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "recipients" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/AlertRecipientGetFull" | |
| } | |
| } | |
| } | |
| }, | |
| "AlertCreate" : { | |
| "properties" : { | |
| "text" : { | |
| "type" : "string" | |
| }, | |
| "recipients" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/AlertRecipientCreate" | |
| } | |
| }, | |
| "satisfiedByAny" : { | |
| "type" : "boolean" | |
| }, | |
| "dateToExpire" : { | |
| "type" : "string", | |
| "format" : "date" | |
| } | |
| } | |
| }, | |
| "AlertCreateFull" : { | |
| "properties" : { | |
| "text" : { | |
| "type" : "string" | |
| }, | |
| "recipients" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/AlertRecipientCreateFull" | |
| } | |
| }, | |
| "satisfiedByAny" : { | |
| "type" : "boolean" | |
| }, | |
| "dateToExpire" : { | |
| "type" : "string", | |
| "format" : "date" | |
| } | |
| } | |
| }, | |
| "AlertUpdate" : { | |
| "properties" : { | |
| "text" : { | |
| "type" : "string" | |
| }, | |
| "recipients" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/AlertRecipientUpdate" | |
| } | |
| }, | |
| "satisfiedByAny" : { | |
| "type" : "boolean" | |
| }, | |
| "dateToExpire" : { | |
| "type" : "string", | |
| "format" : "date" | |
| } | |
| } | |
| }, | |
| "RoleGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "privileges" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/PrivilegeGet" | |
| } | |
| }, | |
| "inheritedRoles" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/RoleGet" | |
| } | |
| } | |
| } | |
| }, | |
| "RoleGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "RoleGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "privileges" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/PrivilegeGetFull" | |
| } | |
| }, | |
| "inheritedRoles" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/RoleGetFull" | |
| } | |
| }, | |
| "allInheritedRoles" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "RoleCreate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "privileges" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/PrivilegeCreate" | |
| } | |
| }, | |
| "inheritedRoles" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/RoleCreate" | |
| } | |
| } | |
| } | |
| }, | |
| "RoleCreateFull" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "privileges" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/PrivilegeCreateFull" | |
| } | |
| }, | |
| "inheritedRoles" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/RoleCreateFull" | |
| } | |
| } | |
| } | |
| }, | |
| "RoleUpdate" : { | |
| "properties" : { | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "privileges" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/PrivilegeUpdate" | |
| } | |
| }, | |
| "inheritedRoles" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/definitions/RoleUpdate" | |
| } | |
| } | |
| } | |
| }, | |
| "OrderFulfillerdetailsCreate" : { | |
| "properties" : { | |
| "fulfillerStatus" : { | |
| "type" : "string" | |
| }, | |
| "fulfillerComment" : { | |
| "type" : "string" | |
| }, | |
| "accessionNumber" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "OrderFulfillerdetailsCreateFull" : { | |
| "properties" : { | |
| "fulfillerStatus" : { | |
| "type" : "string" | |
| }, | |
| "fulfillerComment" : { | |
| "type" : "string" | |
| }, | |
| "accessionNumber" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptNameGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "locale" : { | |
| "type" : "object" | |
| }, | |
| "localePreferred" : { | |
| "type" : "boolean" | |
| }, | |
| "conceptNameType" : { | |
| "type" : "string", | |
| "enum" : [ "FULLY_SPECIFIED", "SHORT", "INDEX_TERM" ] | |
| } | |
| } | |
| }, | |
| "ConceptNameGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "ConceptNameGetFull" : { | |
| "properties" : { | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "locale" : { | |
| "type" : "object" | |
| }, | |
| "localePreferred" : { | |
| "type" : "boolean" | |
| }, | |
| "conceptNameType" : { | |
| "type" : "string", | |
| "enum" : [ "FULLY_SPECIFIED", "SHORT", "INDEX_TERM" ] | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptNameCreate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "locale" : { | |
| "type" : "object" | |
| }, | |
| "localePreferred" : { | |
| "type" : "boolean" | |
| }, | |
| "conceptNameType" : { | |
| "type" : "string", | |
| "enum" : [ "FULLY_SPECIFIED", "SHORT", "INDEX_TERM" ] | |
| } | |
| } | |
| }, | |
| "ConceptNameCreateFull" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "locale" : { | |
| "type" : "object" | |
| }, | |
| "localePreferred" : { | |
| "type" : "boolean" | |
| }, | |
| "conceptNameType" : { | |
| "type" : "string", | |
| "enum" : [ "FULLY_SPECIFIED", "SHORT", "INDEX_TERM" ] | |
| } | |
| } | |
| }, | |
| "ConceptNameUpdate" : { | |
| "properties" : { | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "locale" : { | |
| "type" : "object" | |
| }, | |
| "localePreferred" : { | |
| "type" : "boolean" | |
| }, | |
| "conceptNameType" : { | |
| "type" : "string", | |
| "enum" : [ "FULLY_SPECIFIED", "SHORT", "INDEX_TERM" ] | |
| } | |
| } | |
| }, | |
| "ConceptAttributeGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "attributeType" : { | |
| "type" : "string" | |
| }, | |
| "value" : { | |
| "type" : "string" | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptAttributeGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "ConceptAttributeGetFull" : { | |
| "properties" : { | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "attributeType" : { | |
| "type" : "string" | |
| }, | |
| "value" : { | |
| "type" : "string" | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptAttributeCreate" : { | |
| "properties" : { | |
| "attributeType" : { | |
| "type" : "string" | |
| }, | |
| "value" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptAttributeCreateFull" : { | |
| "properties" : { | |
| "attributeType" : { | |
| "type" : "string" | |
| }, | |
| "value" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptAttributeUpdate" : { | |
| "properties" : { | |
| "attributeType" : { | |
| "type" : "string" | |
| }, | |
| "value" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "PersonAddressGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "preferred" : { | |
| "type" : "boolean" | |
| }, | |
| "address1" : { | |
| "type" : "string" | |
| }, | |
| "address2" : { | |
| "type" : "string" | |
| }, | |
| "cityVillage" : { | |
| "type" : "string" | |
| }, | |
| "stateProvince" : { | |
| "type" : "string" | |
| }, | |
| "country" : { | |
| "type" : "string" | |
| }, | |
| "postalCode" : { | |
| "type" : "string" | |
| }, | |
| "countyDistrict" : { | |
| "type" : "string" | |
| }, | |
| "address3" : { | |
| "type" : "string" | |
| }, | |
| "address4" : { | |
| "type" : "string" | |
| }, | |
| "address5" : { | |
| "type" : "string" | |
| }, | |
| "address6" : { | |
| "type" : "string" | |
| }, | |
| "startDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "endDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "latitude" : { | |
| "type" : "string" | |
| }, | |
| "longitude" : { | |
| "type" : "string" | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| }, | |
| "address7" : { | |
| "type" : "string" | |
| }, | |
| "address8" : { | |
| "type" : "string" | |
| }, | |
| "address9" : { | |
| "type" : "string" | |
| }, | |
| "address10" : { | |
| "type" : "string" | |
| }, | |
| "address11" : { | |
| "type" : "string" | |
| }, | |
| "address12" : { | |
| "type" : "string" | |
| }, | |
| "address13" : { | |
| "type" : "string" | |
| }, | |
| "address14" : { | |
| "type" : "string" | |
| }, | |
| "address15" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "PersonAddressGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "PersonAddressGetFull" : { | |
| "properties" : { | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "preferred" : { | |
| "type" : "boolean" | |
| }, | |
| "address1" : { | |
| "type" : "string" | |
| }, | |
| "address2" : { | |
| "type" : "string" | |
| }, | |
| "cityVillage" : { | |
| "type" : "string" | |
| }, | |
| "stateProvince" : { | |
| "type" : "string" | |
| }, | |
| "country" : { | |
| "type" : "string" | |
| }, | |
| "postalCode" : { | |
| "type" : "string" | |
| }, | |
| "latitude" : { | |
| "type" : "string" | |
| }, | |
| "longitude" : { | |
| "type" : "string" | |
| }, | |
| "countyDistrict" : { | |
| "type" : "string" | |
| }, | |
| "address3" : { | |
| "type" : "string" | |
| }, | |
| "address4" : { | |
| "type" : "string" | |
| }, | |
| "address5" : { | |
| "type" : "string" | |
| }, | |
| "address6" : { | |
| "type" : "string" | |
| }, | |
| "startDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "endDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| }, | |
| "address7" : { | |
| "type" : "string" | |
| }, | |
| "address8" : { | |
| "type" : "string" | |
| }, | |
| "address9" : { | |
| "type" : "string" | |
| }, | |
| "address10" : { | |
| "type" : "string" | |
| }, | |
| "address11" : { | |
| "type" : "string" | |
| }, | |
| "address12" : { | |
| "type" : "string" | |
| }, | |
| "address13" : { | |
| "type" : "string" | |
| }, | |
| "address14" : { | |
| "type" : "string" | |
| }, | |
| "address15" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "PersonAddressCreate" : { | |
| "properties" : { | |
| "preferred" : { | |
| "type" : "boolean" | |
| }, | |
| "address1" : { | |
| "type" : "string" | |
| }, | |
| "address2" : { | |
| "type" : "string" | |
| }, | |
| "cityVillage" : { | |
| "type" : "string" | |
| }, | |
| "stateProvince" : { | |
| "type" : "string" | |
| }, | |
| "country" : { | |
| "type" : "string" | |
| }, | |
| "postalCode" : { | |
| "type" : "string" | |
| }, | |
| "latitude" : { | |
| "type" : "string" | |
| }, | |
| "longitude" : { | |
| "type" : "string" | |
| }, | |
| "countyDistrict" : { | |
| "type" : "string" | |
| }, | |
| "address3" : { | |
| "type" : "string" | |
| }, | |
| "address4" : { | |
| "type" : "string" | |
| }, | |
| "address5" : { | |
| "type" : "string" | |
| }, | |
| "address6" : { | |
| "type" : "string" | |
| }, | |
| "startDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "endDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "address7" : { | |
| "type" : "string" | |
| }, | |
| "address8" : { | |
| "type" : "string" | |
| }, | |
| "address9" : { | |
| "type" : "string" | |
| }, | |
| "address10" : { | |
| "type" : "string" | |
| }, | |
| "address11" : { | |
| "type" : "string" | |
| }, | |
| "address12" : { | |
| "type" : "string" | |
| }, | |
| "address13" : { | |
| "type" : "string" | |
| }, | |
| "address14" : { | |
| "type" : "string" | |
| }, | |
| "address15" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "PersonAddressCreateFull" : { | |
| "properties" : { | |
| "preferred" : { | |
| "type" : "boolean" | |
| }, | |
| "address1" : { | |
| "type" : "string" | |
| }, | |
| "address2" : { | |
| "type" : "string" | |
| }, | |
| "cityVillage" : { | |
| "type" : "string" | |
| }, | |
| "stateProvince" : { | |
| "type" : "string" | |
| }, | |
| "country" : { | |
| "type" : "string" | |
| }, | |
| "postalCode" : { | |
| "type" : "string" | |
| }, | |
| "latitude" : { | |
| "type" : "string" | |
| }, | |
| "longitude" : { | |
| "type" : "string" | |
| }, | |
| "countyDistrict" : { | |
| "type" : "string" | |
| }, | |
| "address3" : { | |
| "type" : "string" | |
| }, | |
| "address4" : { | |
| "type" : "string" | |
| }, | |
| "address5" : { | |
| "type" : "string" | |
| }, | |
| "address6" : { | |
| "type" : "string" | |
| }, | |
| "startDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "endDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "address7" : { | |
| "type" : "string" | |
| }, | |
| "address8" : { | |
| "type" : "string" | |
| }, | |
| "address9" : { | |
| "type" : "string" | |
| }, | |
| "address10" : { | |
| "type" : "string" | |
| }, | |
| "address11" : { | |
| "type" : "string" | |
| }, | |
| "address12" : { | |
| "type" : "string" | |
| }, | |
| "address13" : { | |
| "type" : "string" | |
| }, | |
| "address14" : { | |
| "type" : "string" | |
| }, | |
| "address15" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "PersonAddressUpdate" : { | |
| "properties" : { | |
| "preferred" : { | |
| "type" : "boolean" | |
| }, | |
| "address1" : { | |
| "type" : "string" | |
| }, | |
| "address2" : { | |
| "type" : "string" | |
| }, | |
| "cityVillage" : { | |
| "type" : "string" | |
| }, | |
| "stateProvince" : { | |
| "type" : "string" | |
| }, | |
| "country" : { | |
| "type" : "string" | |
| }, | |
| "postalCode" : { | |
| "type" : "string" | |
| }, | |
| "latitude" : { | |
| "type" : "string" | |
| }, | |
| "longitude" : { | |
| "type" : "string" | |
| }, | |
| "countyDistrict" : { | |
| "type" : "string" | |
| }, | |
| "address3" : { | |
| "type" : "string" | |
| }, | |
| "address4" : { | |
| "type" : "string" | |
| }, | |
| "address5" : { | |
| "type" : "string" | |
| }, | |
| "address6" : { | |
| "type" : "string" | |
| }, | |
| "startDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "endDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "address7" : { | |
| "type" : "string" | |
| }, | |
| "address8" : { | |
| "type" : "string" | |
| }, | |
| "address9" : { | |
| "type" : "string" | |
| }, | |
| "address10" : { | |
| "type" : "string" | |
| }, | |
| "address11" : { | |
| "type" : "string" | |
| }, | |
| "address12" : { | |
| "type" : "string" | |
| }, | |
| "address13" : { | |
| "type" : "string" | |
| }, | |
| "address14" : { | |
| "type" : "string" | |
| }, | |
| "address15" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "FormResourceGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "FormResourceGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "FormResourceGetFull" : { }, | |
| "FormResourceCreate" : { | |
| "properties" : { | |
| "form" : { | |
| "$ref" : "#/definitions/FormCreate" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "dataType" : { | |
| "type" : "string" | |
| }, | |
| "handler" : { | |
| "type" : "string" | |
| }, | |
| "handlerConfig" : { | |
| "type" : "string" | |
| }, | |
| "value" : { | |
| "type" : "string" | |
| }, | |
| "valueReference" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "FormResourceCreateFull" : { | |
| "properties" : { | |
| "form" : { | |
| "$ref" : "#/definitions/FormCreateFull" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "dataType" : { | |
| "type" : "string" | |
| }, | |
| "handler" : { | |
| "type" : "string" | |
| }, | |
| "handlerConfig" : { | |
| "type" : "string" | |
| }, | |
| "value" : { | |
| "type" : "string" | |
| }, | |
| "valueReference" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "FormResourceUpdate" : { | |
| "properties" : { | |
| "form" : { | |
| "$ref" : "#/definitions/FormUpdate" | |
| }, | |
| "name" : { | |
| "type" : "string" | |
| }, | |
| "dataType" : { | |
| "type" : "string" | |
| }, | |
| "handler" : { | |
| "type" : "string" | |
| }, | |
| "handlerConfig" : { | |
| "type" : "string" | |
| }, | |
| "value" : { | |
| "type" : "string" | |
| }, | |
| "valueReference" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "LocationAttributeGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "attributeType" : { | |
| "type" : "string" | |
| }, | |
| "value" : { | |
| "type" : "string" | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "LocationAttributeGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "LocationAttributeGetFull" : { | |
| "properties" : { | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "attributeType" : { | |
| "type" : "string" | |
| }, | |
| "value" : { | |
| "type" : "string" | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "LocationAttributeCreate" : { | |
| "properties" : { | |
| "attributeType" : { | |
| "type" : "string" | |
| }, | |
| "value" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "LocationAttributeCreateFull" : { | |
| "properties" : { | |
| "attributeType" : { | |
| "type" : "string" | |
| }, | |
| "value" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "LocationAttributeUpdate" : { | |
| "properties" : { | |
| "attributeType" : { | |
| "type" : "string" | |
| }, | |
| "value" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "CohortMembershipGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "startDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "endDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "patientUuid" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "CohortMembershipGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "CohortMembershipGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "startDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "endDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "patientUuid" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "CohortMembershipCreate" : { | |
| "properties" : { | |
| "patientUuid" : { | |
| "type" : "string" | |
| }, | |
| "startDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "endDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| } | |
| } | |
| }, | |
| "CohortMembershipCreateFull" : { | |
| "properties" : { | |
| "patientUuid" : { | |
| "type" : "string" | |
| }, | |
| "startDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "endDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| } | |
| } | |
| }, | |
| "CohortMembershipUpdate" : { | |
| "properties" : { | |
| "startDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "endDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| } | |
| } | |
| }, | |
| "PersonAttributeGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "value" : { | |
| "type" : "string" | |
| }, | |
| "attributeType" : { | |
| "$ref" : "#/definitions/PersonattributetypeGet" | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "PersonAttributeGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "PersonAttributeGetFull" : { | |
| "properties" : { | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "value" : { | |
| "type" : "string" | |
| }, | |
| "attributeType" : { | |
| "$ref" : "#/definitions/PersonattributetypeGetFull" | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| }, | |
| "hydratedObject" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "PersonAttributeCreate" : { | |
| "properties" : { | |
| "attributeType" : { | |
| "$ref" : "#/definitions/PersonattributetypeCreate" | |
| }, | |
| "value" : { | |
| "type" : "string" | |
| }, | |
| "hydratedObject" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "PersonAttributeCreateFull" : { | |
| "properties" : { | |
| "attributeType" : { | |
| "$ref" : "#/definitions/PersonattributetypeCreateFull" | |
| }, | |
| "value" : { | |
| "type" : "string" | |
| }, | |
| "hydratedObject" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "PersonAttributeUpdate" : { | |
| "properties" : { | |
| "attributeType" : { | |
| "$ref" : "#/definitions/PersonattributetypeUpdate" | |
| }, | |
| "value" : { | |
| "type" : "string" | |
| }, | |
| "hydratedObject" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "PatientIdentifierGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "identifier" : { | |
| "type" : "string" | |
| }, | |
| "identifierType" : { | |
| "$ref" : "#/definitions/PatientidentifiertypeGet" | |
| }, | |
| "location" : { | |
| "$ref" : "#/definitions/LocationGet" | |
| }, | |
| "preferred" : { | |
| "type" : "boolean" | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "PatientIdentifierGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "PatientIdentifierGetFull" : { | |
| "properties" : { | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "identifier" : { | |
| "type" : "string" | |
| }, | |
| "identifierType" : { | |
| "$ref" : "#/definitions/PatientidentifiertypeGetFull" | |
| }, | |
| "location" : { | |
| "$ref" : "#/definitions/LocationGetFull" | |
| }, | |
| "preferred" : { | |
| "type" : "boolean" | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "PatientIdentifierCreate" : { | |
| "properties" : { | |
| "identifier" : { | |
| "type" : "string" | |
| }, | |
| "identifierType" : { | |
| "$ref" : "#/definitions/PatientidentifiertypeCreate" | |
| }, | |
| "location" : { | |
| "$ref" : "#/definitions/LocationCreate" | |
| }, | |
| "preferred" : { | |
| "type" : "boolean" | |
| } | |
| } | |
| }, | |
| "PatientIdentifierCreateFull" : { | |
| "properties" : { | |
| "identifier" : { | |
| "type" : "string" | |
| }, | |
| "identifierType" : { | |
| "$ref" : "#/definitions/PatientidentifiertypeCreateFull" | |
| }, | |
| "location" : { | |
| "$ref" : "#/definitions/LocationCreateFull" | |
| }, | |
| "preferred" : { | |
| "type" : "boolean" | |
| } | |
| } | |
| }, | |
| "PatientIdentifierUpdate" : { | |
| "properties" : { | |
| "identifier" : { | |
| "type" : "string" | |
| }, | |
| "identifierType" : { | |
| "$ref" : "#/definitions/PatientidentifiertypeUpdate" | |
| }, | |
| "location" : { | |
| "$ref" : "#/definitions/LocationUpdate" | |
| }, | |
| "preferred" : { | |
| "type" : "boolean" | |
| } | |
| } | |
| }, | |
| "ConceptDescriptionGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "locale" : { | |
| "type" : "object" | |
| } | |
| } | |
| }, | |
| "ConceptDescriptionGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptDescriptionGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "locale" : { | |
| "type" : "object" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptDescriptionCreate" : { | |
| "properties" : { | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "locale" : { | |
| "type" : "object" | |
| } | |
| } | |
| }, | |
| "ConceptDescriptionCreateFull" : { | |
| "properties" : { | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "locale" : { | |
| "type" : "object" | |
| } | |
| } | |
| }, | |
| "ConceptDescriptionUpdate" : { | |
| "properties" : { | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "locale" : { | |
| "type" : "object" | |
| } | |
| } | |
| }, | |
| "ConceptMappingGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "conceptReferenceTerm" : { | |
| "$ref" : "#/definitions/ConceptreferencetermGet" | |
| }, | |
| "conceptMapType" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptMappingGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "ConceptMappingGetFull" : { | |
| "properties" : { | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "conceptReferenceTerm" : { | |
| "$ref" : "#/definitions/ConceptreferencetermGetFull" | |
| }, | |
| "conceptMapType" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptMappingCreate" : { | |
| "properties" : { | |
| "conceptReferenceTerm" : { | |
| "$ref" : "#/definitions/ConceptreferencetermCreate" | |
| }, | |
| "conceptMapType" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptMappingCreateFull" : { | |
| "properties" : { | |
| "conceptReferenceTerm" : { | |
| "$ref" : "#/definitions/ConceptreferencetermCreateFull" | |
| }, | |
| "conceptMapType" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ConceptMappingUpdate" : { | |
| "properties" : { | |
| "conceptReferenceTerm" : { | |
| "$ref" : "#/definitions/ConceptreferencetermUpdate" | |
| }, | |
| "conceptMapType" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "AlertRecipientGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "recipient" : { | |
| "type" : "string" | |
| }, | |
| "alertRead" : { | |
| "type" : "boolean" | |
| }, | |
| "dateChanged" : { | |
| "type" : "string", | |
| "format" : "date" | |
| } | |
| } | |
| }, | |
| "AlertRecipientGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "AlertRecipientGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "recipient" : { | |
| "type" : "string" | |
| }, | |
| "alertRead" : { | |
| "type" : "boolean" | |
| }, | |
| "dateChanged" : { | |
| "type" : "string", | |
| "format" : "date" | |
| } | |
| } | |
| }, | |
| "AlertRecipientCreate" : { | |
| "properties" : { | |
| "recipient" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "AlertRecipientCreateFull" : { | |
| "properties" : { | |
| "recipient" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "AlertRecipientUpdate" : { | |
| "properties" : { | |
| "recipient" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "CustomdatatypeHandlersGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "handlerClassname" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "CustomdatatypeHandlersGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "handlerClassname" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "CustomdatatypeHandlersGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "handlerClassname" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "PersonNameGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "givenName" : { | |
| "type" : "string" | |
| }, | |
| "middleName" : { | |
| "type" : "string" | |
| }, | |
| "familyName" : { | |
| "type" : "string" | |
| }, | |
| "familyName2" : { | |
| "type" : "string" | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "PersonNameGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "PersonNameGetFull" : { | |
| "properties" : { | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "givenName" : { | |
| "type" : "string" | |
| }, | |
| "middleName" : { | |
| "type" : "string" | |
| }, | |
| "familyName" : { | |
| "type" : "string" | |
| }, | |
| "familyName2" : { | |
| "type" : "string" | |
| }, | |
| "preferred" : { | |
| "type" : "boolean" | |
| }, | |
| "prefix" : { | |
| "type" : "string" | |
| }, | |
| "familyNamePrefix" : { | |
| "type" : "string" | |
| }, | |
| "familyNameSuffix" : { | |
| "type" : "string" | |
| }, | |
| "degree" : { | |
| "type" : "string" | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "PersonNameCreate" : { | |
| "properties" : { | |
| "givenName" : { | |
| "type" : "string" | |
| }, | |
| "familyName" : { | |
| "type" : "string" | |
| }, | |
| "middleName" : { | |
| "type" : "string" | |
| }, | |
| "familyName2" : { | |
| "type" : "string" | |
| }, | |
| "preferred" : { | |
| "type" : "boolean" | |
| }, | |
| "prefix" : { | |
| "type" : "string" | |
| }, | |
| "familyNamePrefix" : { | |
| "type" : "string" | |
| }, | |
| "familyNameSuffix" : { | |
| "type" : "string" | |
| }, | |
| "degree" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "PersonNameCreateFull" : { | |
| "properties" : { | |
| "givenName" : { | |
| "type" : "string" | |
| }, | |
| "familyName" : { | |
| "type" : "string" | |
| }, | |
| "middleName" : { | |
| "type" : "string" | |
| }, | |
| "familyName2" : { | |
| "type" : "string" | |
| }, | |
| "preferred" : { | |
| "type" : "boolean" | |
| }, | |
| "prefix" : { | |
| "type" : "string" | |
| }, | |
| "familyNamePrefix" : { | |
| "type" : "string" | |
| }, | |
| "familyNameSuffix" : { | |
| "type" : "string" | |
| }, | |
| "degree" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "PersonNameUpdate" : { | |
| "properties" : { | |
| "givenName" : { | |
| "type" : "string" | |
| }, | |
| "familyName" : { | |
| "type" : "string" | |
| }, | |
| "middleName" : { | |
| "type" : "string" | |
| }, | |
| "familyName2" : { | |
| "type" : "string" | |
| }, | |
| "preferred" : { | |
| "type" : "boolean" | |
| }, | |
| "prefix" : { | |
| "type" : "string" | |
| }, | |
| "familyNamePrefix" : { | |
| "type" : "string" | |
| }, | |
| "familyNameSuffix" : { | |
| "type" : "string" | |
| }, | |
| "degree" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "VisitAttributeGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "attributeType" : { | |
| "type" : "string" | |
| }, | |
| "value" : { | |
| "type" : "string" | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "VisitAttributeGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "VisitAttributeGetFull" : { | |
| "properties" : { | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "attributeType" : { | |
| "type" : "string" | |
| }, | |
| "value" : { | |
| "type" : "string" | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "VisitAttributeCreate" : { | |
| "properties" : { | |
| "attributeType" : { | |
| "type" : "string" | |
| }, | |
| "value" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "VisitAttributeCreateFull" : { | |
| "properties" : { | |
| "attributeType" : { | |
| "type" : "string" | |
| }, | |
| "value" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "VisitAttributeUpdate" : { | |
| "properties" : { | |
| "attributeType" : { | |
| "type" : "string" | |
| }, | |
| "value" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "OrdersetOrdersetmemberGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "orderType" : { | |
| "$ref" : "#/definitions/OrdertypeGet" | |
| }, | |
| "orderTemplate" : { | |
| "type" : "string" | |
| }, | |
| "orderTemplateType" : { | |
| "type" : "string" | |
| }, | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptGet" | |
| } | |
| } | |
| }, | |
| "OrdersetOrdersetmemberGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "OrdersetOrdersetmemberGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "orderType" : { | |
| "$ref" : "#/definitions/OrdertypeGetFull" | |
| }, | |
| "orderTemplate" : { | |
| "type" : "string" | |
| }, | |
| "orderTemplateType" : { | |
| "type" : "string" | |
| }, | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptGetFull" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "OrdersetOrdersetmemberCreate" : { | |
| "properties" : { | |
| "orderType" : { | |
| "$ref" : "#/definitions/OrdertypeCreate" | |
| }, | |
| "orderTemplate" : { | |
| "type" : "string" | |
| }, | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptCreate" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "OrdersetOrdersetmemberCreateFull" : { | |
| "properties" : { | |
| "orderType" : { | |
| "$ref" : "#/definitions/OrdertypeCreateFull" | |
| }, | |
| "orderTemplate" : { | |
| "type" : "string" | |
| }, | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptCreateFull" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "OrdersetOrdersetmemberUpdate" : { | |
| "properties" : { | |
| "orderType" : { | |
| "$ref" : "#/definitions/OrdertypeUpdate" | |
| }, | |
| "orderTemplate" : { | |
| "type" : "string" | |
| }, | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptUpdate" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ProgramenrollmentStateCreate" : { | |
| "properties" : { | |
| "state" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ProgramenrollmentStateCreateFull" : { | |
| "properties" : { | |
| "state" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ProgramenrollmentStateGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| }, | |
| "state" : { | |
| "type" : "string" | |
| }, | |
| "patientProgram" : { | |
| "$ref" : "#/definitions/ProgramenrollmentGet" | |
| }, | |
| "startDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "endDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ProgramenrollmentStateGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| }, | |
| "state" : { | |
| "type" : "string" | |
| }, | |
| "startDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "endDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ProgramenrollmentStateGetFull" : { | |
| "properties" : { | |
| "state" : { | |
| "type" : "string" | |
| }, | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "patientProgram" : { | |
| "$ref" : "#/definitions/ProgramenrollmentGetFull" | |
| }, | |
| "startDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "endDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ProgramenrollmentStateUpdate" : { | |
| "properties" : { | |
| "state" : { | |
| "type" : "string" | |
| }, | |
| "startDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "endDate" : { | |
| "type" : "string", | |
| "format" : "date" | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "WorkflowStateGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptGet" | |
| } | |
| } | |
| }, | |
| "WorkflowStateGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptGetRef" | |
| } | |
| } | |
| }, | |
| "WorkflowStateGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "description" : { | |
| "type" : "string" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptGetFull" | |
| } | |
| } | |
| }, | |
| "WorkflowStateCreate" : { | |
| "properties" : { | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptCreate" | |
| }, | |
| "initial" : { | |
| "type" : "boolean" | |
| }, | |
| "terminal" : { | |
| "type" : "boolean" | |
| } | |
| } | |
| }, | |
| "WorkflowStateCreateFull" : { | |
| "properties" : { | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptCreateFull" | |
| }, | |
| "initial" : { | |
| "type" : "boolean" | |
| }, | |
| "terminal" : { | |
| "type" : "boolean" | |
| } | |
| } | |
| }, | |
| "WorkflowStateUpdate" : { | |
| "properties" : { | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptUpdate" | |
| }, | |
| "initial" : { | |
| "type" : "boolean" | |
| }, | |
| "terminal" : { | |
| "type" : "boolean" | |
| } | |
| } | |
| }, | |
| "PatientAllergyCreate" : { | |
| "properties" : { | |
| "allergen" : { | |
| "type" : "string" | |
| }, | |
| "severity" : { | |
| "$ref" : "#/definitions/ConceptCreate" | |
| }, | |
| "comment" : { | |
| "type" : "string" | |
| }, | |
| "reactions" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "PatientAllergyCreateFull" : { | |
| "properties" : { | |
| "allergen" : { | |
| "type" : "string" | |
| }, | |
| "severity" : { | |
| "$ref" : "#/definitions/ConceptCreateFull" | |
| }, | |
| "comment" : { | |
| "type" : "string" | |
| }, | |
| "reactions" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "PatientAllergyGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "allergen" : { | |
| "type" : "string" | |
| }, | |
| "severity" : { | |
| "$ref" : "#/definitions/ConceptGet" | |
| }, | |
| "comment" : { | |
| "type" : "string" | |
| }, | |
| "reactions" : { | |
| "type" : "string" | |
| }, | |
| "patient" : { | |
| "$ref" : "#/definitions/PatientGet" | |
| } | |
| } | |
| }, | |
| "PatientAllergyGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "PatientAllergyGetFull" : { | |
| "properties" : { | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "allergen" : { | |
| "type" : "string" | |
| }, | |
| "severity" : { | |
| "$ref" : "#/definitions/ConceptGetFull" | |
| }, | |
| "comment" : { | |
| "type" : "string" | |
| }, | |
| "reactions" : { | |
| "type" : "string" | |
| }, | |
| "patient" : { | |
| "$ref" : "#/definitions/PatientGetFull" | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "PatientAllergyUpdate" : { | |
| "properties" : { | |
| "allergen" : { | |
| "type" : "string" | |
| }, | |
| "severity" : { | |
| "$ref" : "#/definitions/ConceptUpdate" | |
| }, | |
| "comment" : { | |
| "type" : "string" | |
| }, | |
| "reactions" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "DrugIngredientGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "ingredient" : { | |
| "$ref" : "#/definitions/ConceptGet" | |
| }, | |
| "strength" : { | |
| "type" : "number", | |
| "format" : "double" | |
| }, | |
| "units" : { | |
| "$ref" : "#/definitions/ConceptGet" | |
| } | |
| } | |
| }, | |
| "DrugIngredientGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "DrugIngredientGetFull" : { | |
| "properties" : { | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "ingredient" : { | |
| "$ref" : "#/definitions/ConceptGetFull" | |
| }, | |
| "strength" : { | |
| "type" : "number", | |
| "format" : "double" | |
| }, | |
| "units" : { | |
| "$ref" : "#/definitions/ConceptGetFull" | |
| } | |
| } | |
| }, | |
| "DrugIngredientCreate" : { | |
| "properties" : { | |
| "ingredient" : { | |
| "$ref" : "#/definitions/ConceptCreate" | |
| }, | |
| "strength" : { | |
| "type" : "number", | |
| "format" : "double" | |
| }, | |
| "units" : { | |
| "$ref" : "#/definitions/ConceptCreate" | |
| } | |
| } | |
| }, | |
| "DrugIngredientCreateFull" : { | |
| "properties" : { | |
| "ingredient" : { | |
| "$ref" : "#/definitions/ConceptCreateFull" | |
| }, | |
| "strength" : { | |
| "type" : "number", | |
| "format" : "double" | |
| }, | |
| "units" : { | |
| "$ref" : "#/definitions/ConceptCreateFull" | |
| } | |
| } | |
| }, | |
| "DrugIngredientUpdate" : { | |
| "properties" : { | |
| "ingredient" : { | |
| "$ref" : "#/definitions/ConceptUpdate" | |
| }, | |
| "strength" : { | |
| "type" : "number", | |
| "format" : "double" | |
| }, | |
| "units" : { | |
| "$ref" : "#/definitions/ConceptUpdate" | |
| } | |
| } | |
| }, | |
| "EncounterEncounterproviderGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| }, | |
| "provider" : { | |
| "$ref" : "#/definitions/ProviderGet" | |
| }, | |
| "encounterRole" : { | |
| "$ref" : "#/definitions/EncounterroleGet" | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "EncounterEncounterproviderGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "EncounterEncounterproviderGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "provider" : { | |
| "$ref" : "#/definitions/ProviderGetFull" | |
| }, | |
| "encounterRole" : { | |
| "$ref" : "#/definitions/EncounterroleGetFull" | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "EncounterEncounterproviderCreate" : { | |
| "properties" : { | |
| "provider" : { | |
| "$ref" : "#/definitions/ProviderCreate" | |
| }, | |
| "encounter" : { | |
| "$ref" : "#/definitions/EncounterCreate" | |
| }, | |
| "encounterRole" : { | |
| "$ref" : "#/definitions/EncounterroleCreate" | |
| } | |
| } | |
| }, | |
| "EncounterEncounterproviderCreateFull" : { | |
| "properties" : { | |
| "provider" : { | |
| "$ref" : "#/definitions/ProviderCreateFull" | |
| }, | |
| "encounter" : { | |
| "$ref" : "#/definitions/EncounterCreateFull" | |
| }, | |
| "encounterRole" : { | |
| "$ref" : "#/definitions/EncounterroleCreateFull" | |
| } | |
| } | |
| }, | |
| "EncounterEncounterproviderUpdate" : { | |
| "properties" : { | |
| "encounterRole" : { | |
| "$ref" : "#/definitions/EncounterroleUpdate" | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| }, | |
| "voidReason" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "FieldAnswerGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptGet" | |
| }, | |
| "field" : { | |
| "$ref" : "#/definitions/FieldGet" | |
| } | |
| } | |
| }, | |
| "FieldAnswerGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "FieldAnswerGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptGetFull" | |
| }, | |
| "field" : { | |
| "$ref" : "#/definitions/FieldGetFull" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "FieldAnswerCreate" : { | |
| "properties" : { | |
| "field" : { | |
| "$ref" : "#/definitions/FieldCreate" | |
| }, | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptCreate" | |
| } | |
| } | |
| }, | |
| "FieldAnswerCreateFull" : { | |
| "properties" : { | |
| "field" : { | |
| "$ref" : "#/definitions/FieldCreateFull" | |
| }, | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptCreateFull" | |
| } | |
| } | |
| }, | |
| "FieldAnswerUpdate" : { | |
| "properties" : { | |
| "field" : { | |
| "$ref" : "#/definitions/FieldUpdate" | |
| }, | |
| "concept" : { | |
| "$ref" : "#/definitions/ConceptUpdate" | |
| } | |
| } | |
| }, | |
| "ProviderAttributeGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "attributeType" : { | |
| "type" : "string" | |
| }, | |
| "value" : { | |
| "type" : "string" | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ProviderAttributeGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "ProviderAttributeGetFull" : { | |
| "properties" : { | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "attributeType" : { | |
| "type" : "string" | |
| }, | |
| "value" : { | |
| "type" : "string" | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ProviderAttributeCreate" : { | |
| "properties" : { | |
| "attributeType" : { | |
| "type" : "string" | |
| }, | |
| "value" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ProviderAttributeCreateFull" : { | |
| "properties" : { | |
| "attributeType" : { | |
| "type" : "string" | |
| }, | |
| "value" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ProviderAttributeUpdate" : { | |
| "properties" : { | |
| "attributeType" : { | |
| "type" : "string" | |
| }, | |
| "value" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ProgramenrollmentAttributeGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "attributeType" : { | |
| "type" : "string" | |
| }, | |
| "value" : { | |
| "type" : "string" | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ProgramenrollmentAttributeGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "ProgramenrollmentAttributeGetFull" : { | |
| "properties" : { | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "attributeType" : { | |
| "type" : "string" | |
| }, | |
| "value" : { | |
| "type" : "string" | |
| }, | |
| "voided" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ProgramenrollmentAttributeCreate" : { | |
| "properties" : { | |
| "attributeType" : { | |
| "type" : "string" | |
| }, | |
| "value" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ProgramenrollmentAttributeCreateFull" : { | |
| "properties" : { | |
| "attributeType" : { | |
| "type" : "string" | |
| }, | |
| "value" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "ProgramenrollmentAttributeUpdate" : { | |
| "properties" : { | |
| "attributeType" : { | |
| "type" : "string" | |
| }, | |
| "value" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "FormFormfieldGet" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "parent" : { | |
| "$ref" : "#/definitions/FormFormfieldGet" | |
| }, | |
| "form" : { | |
| "$ref" : "#/definitions/FormGet" | |
| }, | |
| "field" : { | |
| "$ref" : "#/definitions/FieldGet" | |
| }, | |
| "fieldNumber" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| }, | |
| "fieldPart" : { | |
| "type" : "string" | |
| }, | |
| "pageNumber" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| }, | |
| "minOccurs" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| }, | |
| "maxOccurs" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| }, | |
| "required" : { | |
| "type" : "boolean" | |
| }, | |
| "sortWeight" : { | |
| "type" : "object" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "FormFormfieldGetRef" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string", | |
| "description" : "Unique identifier of the resource" | |
| }, | |
| "display" : { | |
| "type" : "string", | |
| "description" : "Display name of the resource" | |
| } | |
| } | |
| }, | |
| "FormFormfieldGetFull" : { | |
| "properties" : { | |
| "uuid" : { | |
| "type" : "string" | |
| }, | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "parent" : { | |
| "$ref" : "#/definitions/FormFormfieldGetFull" | |
| }, | |
| "form" : { | |
| "$ref" : "#/definitions/FormGetFull" | |
| }, | |
| "field" : { | |
| "$ref" : "#/definitions/FieldGetFull" | |
| }, | |
| "fieldNumber" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| }, | |
| "fieldPart" : { | |
| "type" : "string" | |
| }, | |
| "pageNumber" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| }, | |
| "minOccurs" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| }, | |
| "maxOccurs" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| }, | |
| "required" : { | |
| "type" : "boolean" | |
| }, | |
| "sortWeight" : { | |
| "type" : "object" | |
| }, | |
| "retired" : { | |
| "type" : "string" | |
| }, | |
| "auditInfo" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "FormFormfieldCreate" : { | |
| "properties" : { | |
| "form" : { | |
| "$ref" : "#/definitions/FormCreate" | |
| }, | |
| "field" : { | |
| "$ref" : "#/definitions/FieldCreate" | |
| }, | |
| "required" : { | |
| "type" : "boolean" | |
| }, | |
| "parent" : { | |
| "$ref" : "#/definitions/FormFormfieldCreate" | |
| }, | |
| "fieldNumber" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| }, | |
| "fieldPart" : { | |
| "type" : "string" | |
| }, | |
| "pageNumber" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| }, | |
| "minOccurs" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| }, | |
| "maxOccurs" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| }, | |
| "sortWeight" : { | |
| "type" : "object" | |
| } | |
| } | |
| }, | |
| "FormFormfieldCreateFull" : { | |
| "properties" : { | |
| "form" : { | |
| "$ref" : "#/definitions/FormCreateFull" | |
| }, | |
| "field" : { | |
| "$ref" : "#/definitions/FieldCreateFull" | |
| }, | |
| "required" : { | |
| "type" : "boolean" | |
| }, | |
| "parent" : { | |
| "$ref" : "#/definitions/FormFormfieldCreateFull" | |
| }, | |
| "fieldNumber" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| }, | |
| "fieldPart" : { | |
| "type" : "string" | |
| }, | |
| "pageNumber" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| }, | |
| "minOccurs" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| }, | |
| "maxOccurs" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| }, | |
| "sortWeight" : { | |
| "type" : "object" | |
| } | |
| } | |
| }, | |
| "FormFormfieldUpdate" : { | |
| "properties" : { | |
| "form" : { | |
| "$ref" : "#/definitions/FormUpdate" | |
| }, | |
| "field" : { | |
| "$ref" : "#/definitions/FieldUpdate" | |
| }, | |
| "required" : { | |
| "type" : "boolean" | |
| }, | |
| "parent" : { | |
| "$ref" : "#/definitions/FormFormfieldUpdate" | |
| }, | |
| "fieldNumber" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| }, | |
| "fieldPart" : { | |
| "type" : "string" | |
| }, | |
| "pageNumber" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| }, | |
| "minOccurs" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| }, | |
| "maxOccurs" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| }, | |
| "sortWeight" : { | |
| "type" : "object" | |
| } | |
| } | |
| }, | |
| "FetchAll" : { | |
| "properties" : { | |
| "results" : { | |
| "type" : "array", | |
| "items" : { | |
| "type" : "object", | |
| "properties" : { | |
| "display" : { | |
| "type" : "string" | |
| }, | |
| "links" : { | |
| "type" : "array", | |
| "items" : { | |
| "type" : "object", | |
| "properties" : { | |
| "rel" : { | |
| "type" : "string", | |
| "example" : "self" | |
| }, | |
| "uri" : { | |
| "type" : "string", | |
| "format" : "uri" | |
| } | |
| } | |
| } | |
| }, | |
| "uuid" : { | |
| "type" : "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "externalDocs" : { | |
| "description" : "Find more info on REST Module Wiki", | |
| "url" : "https://wiki.openmrs.org/x/xoAaAQ" | |
| } | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment