{ "swagger" : "2.0", "info" : { "description" : "OpenMRS RESTful API documentation generated by Swagger", "version" : "2.6.9", "title" : "OpenMRS API Docs", "contact" : { "name" : "OpenMRS", "url" : "http://openmrs.org" }, "license" : { "name" : "MPL-2.0 w/ HD", "url" : "http://openmrs.org/license" } }, "host" : "dev3.openmrs.org", "basePath" : "/openmrs/ws/rest/v1", "schemes" : [ "https" ], "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "security" : [ { "basic_auth" : [ ] }, { "basic_auth" : [ ] } ], "paths" : { "/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" } } } }, "/billing/bill" : { "get" : { "tags" : [ "billing/bill" ], "summary" : "Fetch all non-retired billing/bill resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllBills", "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" : "billing/bill response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/BillingBillGet" } } }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "billing/bill" ], "summary" : "Create with properties in request", "operationId" : "createBill", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "resource", "description" : "Resource to create", "required" : true, "schema" : { "$ref" : "#/definitions/BillingBillCreate" } } ], "responses" : { "201" : { "description" : "billing/bill response" }, "401" : { "description" : "User not logged in" } } } }, "/billing/bill/{uuid}" : { "get" : { "tags" : [ "billing/bill" ], "summary" : "Fetch by uuid", "operationId" : "getBill", "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" : "billing/bill response", "schema" : { "$ref" : "#/definitions/BillingBillGet" } }, "404" : { "description" : "Resource with given uuid doesn't exist" }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "billing/bill" ], "summary" : "Edit with given uuid, only modifying properties in request", "operationId" : "updateBill", "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/BillingBillUpdate" } } ], "responses" : { "201" : { "description" : "billing/bill response" }, "401" : { "description" : "User not logged in" } } }, "delete" : { "tags" : [ "billing/bill" ], "summary" : "Delete or purge resource by uuid", "description" : "The resource will be voided/retired unless purge = 'true'", "operationId" : "deleteBill", "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" } } } }, "/stockmanagement/userrolescope" : { "get" : { "tags" : [ "stockmanagement/userrolescope" ], "summary" : "Fetch all non-retired stockmanagement/userrolescope resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllUserRoleScopes", "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" : "stockmanagement/userrolescope response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/StockmanagementUserrolescopeGet" } } }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "stockmanagement/userrolescope" ], "summary" : "Create with properties in request", "operationId" : "createUserRoleScope", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "resource", "description" : "Resource to create", "required" : true, "schema" : { "$ref" : "#/definitions/StockmanagementUserrolescopeCreate" } } ], "responses" : { "201" : { "description" : "stockmanagement/userrolescope response" }, "401" : { "description" : "User not logged in" } } } }, "/stockmanagement/userrolescope/{uuid}" : { "get" : { "tags" : [ "stockmanagement/userrolescope" ], "summary" : "Fetch by uuid", "operationId" : "getUserRoleScope", "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" : "stockmanagement/userrolescope response", "schema" : { "$ref" : "#/definitions/StockmanagementUserrolescopeGet" } }, "404" : { "description" : "Resource with given uuid doesn't exist" }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "stockmanagement/userrolescope" ], "summary" : "Edit with given uuid, only modifying properties in request", "operationId" : "updateUserRoleScope", "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/StockmanagementUserrolescopeUpdate" } } ], "responses" : { "201" : { "description" : "stockmanagement/userrolescope response" }, "401" : { "description" : "User not logged in" } } }, "delete" : { "tags" : [ "stockmanagement/userrolescope" ], "summary" : "Delete or purge resource by uuid", "description" : "The resource will be voided/retired unless purge = 'true'", "operationId" : "deleteUserRoleScope", "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" } } } }, "/metadatamapping/metadataset" : { "get" : { "tags" : [ "metadatamapping/metadataset" ], "summary" : "Fetch all non-retired metadatamapping/metadataset resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllMetadataSets", "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" : "metadatamapping/metadataset response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/MetadatamappingMetadatasetGet" } } }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "metadatamapping/metadataset" ], "summary" : "Create with properties in request", "operationId" : "createMetadataSet", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "resource", "description" : "Resource to create", "required" : true, "schema" : { "$ref" : "#/definitions/MetadatamappingMetadatasetCreate" } } ], "responses" : { "201" : { "description" : "metadatamapping/metadataset response" }, "401" : { "description" : "User not logged in" } } } }, "/metadatamapping/metadataset/{uuid}" : { "get" : { "tags" : [ "metadatamapping/metadataset" ], "summary" : "Fetch by uuid", "operationId" : "getMetadataSet", "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" : "metadatamapping/metadataset response", "schema" : { "$ref" : "#/definitions/MetadatamappingMetadatasetGet" } }, "404" : { "description" : "Resource with given uuid doesn't exist" }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "metadatamapping/metadataset" ], "summary" : "Edit with given uuid, only modifying properties in request", "operationId" : "updateMetadataSet", "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/MetadatamappingMetadatasetUpdate" } } ], "responses" : { "201" : { "description" : "metadatamapping/metadataset response" }, "401" : { "description" : "User not logged in" } } }, "delete" : { "tags" : [ "metadatamapping/metadataset" ], "summary" : "Delete or purge resource by uuid", "description" : "The resource will be voided/retired unless purge = 'true'", "operationId" : "deleteMetadataSet", "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" } } } }, "/admissionLocation" : { "get" : { "tags" : [ "admissionLocation" ], "summary" : "Fetch all non-retired admissionLocation resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllAdmissionLocations", "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" : "admissionLocation response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/AdmissionLocationGet" } } }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "admissionLocation" ], "summary" : "Create with properties in request", "operationId" : "createAdmissionLocation", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "resource", "description" : "Resource to create", "required" : true, "schema" : { "$ref" : "#/definitions/AdmissionLocationCreate" } } ], "responses" : { "201" : { "description" : "admissionLocation response" }, "401" : { "description" : "User not logged in" } } } }, "/admissionLocation/{uuid}" : { "get" : { "tags" : [ "admissionLocation" ], "summary" : "Fetch by uuid", "operationId" : "getAdmissionLocation", "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" : "admissionLocation response", "schema" : { "$ref" : "#/definitions/AdmissionLocationGet" } }, "404" : { "description" : "Resource with given uuid doesn't exist" }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "admissionLocation" ], "summary" : "Edit with given uuid, only modifying properties in request", "operationId" : "updateAdmissionLocation", "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/AdmissionLocationUpdate" } } ], "responses" : { "201" : { "description" : "admissionLocation response" }, "401" : { "description" : "User not logged in" } } }, "delete" : { "tags" : [ "admissionLocation" ], "summary" : "Delete or purge resource by uuid", "description" : "The resource will be voided/retired unless purge = 'true'", "operationId" : "deleteAdmissionLocation", "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" } } } }, "/stockmanagement/stockitemreference" : { "get" : { "tags" : [ "stockmanagement/stockitemreference" ], "summary" : "Fetch all non-retired stockmanagement/stockitemreference resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllStockItemReferences", "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" : "stockmanagement/stockitemreference response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/StockmanagementStockitemreferenceGet" } } }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "stockmanagement/stockitemreference" ], "summary" : "Create with properties in request", "operationId" : "createStockItemReference", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "resource", "description" : "Resource to create", "required" : true, "schema" : { "$ref" : "#/definitions/StockmanagementStockitemreferenceCreate" } } ], "responses" : { "201" : { "description" : "stockmanagement/stockitemreference response" }, "401" : { "description" : "User not logged in" } } } }, "/stockmanagement/stockitemreference/{uuid}" : { "get" : { "tags" : [ "stockmanagement/stockitemreference" ], "summary" : "Fetch by uuid", "operationId" : "getStockItemReference", "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" : "stockmanagement/stockitemreference response", "schema" : { "$ref" : "#/definitions/StockmanagementStockitemreferenceGet" } }, "404" : { "description" : "Resource with given uuid doesn't exist" }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "stockmanagement/stockitemreference" ], "summary" : "Edit with given uuid, only modifying properties in request", "operationId" : "updateStockItemReference", "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/StockmanagementStockitemreferenceUpdate" } } ], "responses" : { "201" : { "description" : "stockmanagement/stockitemreference response" }, "401" : { "description" : "User not logged in" } } }, "delete" : { "tags" : [ "stockmanagement/stockitemreference" ], "summary" : "Delete or purge resource by uuid", "description" : "The resource will be voided/retired unless purge = 'true'", "operationId" : "deleteStockItemReference", "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" } } } }, "/queue-room" : { "get" : { "tags" : [ "queue-room" ], "summary" : "Fetch all non-retired queue-room resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllQueueRooms", "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" : "queue-room response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/Queue-roomGet" } } }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "queue-room" ], "summary" : "Create with properties in request", "operationId" : "createQueueRoom", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "resource", "description" : "Resource to create", "required" : true, "schema" : { "$ref" : "#/definitions/Queue-roomCreate" } } ], "responses" : { "201" : { "description" : "queue-room response" }, "401" : { "description" : "User not logged in" } } } }, "/queue-room/{uuid}" : { "get" : { "tags" : [ "queue-room" ], "summary" : "Fetch by uuid", "operationId" : "getQueueRoom", "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" : "queue-room response", "schema" : { "$ref" : "#/definitions/Queue-roomGet" } }, "404" : { "description" : "Resource with given uuid doesn't exist" }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "queue-room" ], "summary" : "Edit with given uuid, only modifying properties in request", "operationId" : "updateQueueRoom", "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/Queue-roomUpdate" } } ], "responses" : { "201" : { "description" : "queue-room response" }, "401" : { "description" : "User not logged in" } } }, "delete" : { "tags" : [ "queue-room" ], "summary" : "Delete or purge resource by uuid", "description" : "The resource will be voided/retired unless purge = 'true'", "operationId" : "deleteQueueRoom", "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" } } } }, "/reportingrest/cohortDefinition" : { "get" : { "tags" : [ "reportingrest/cohortDefinition" ], "summary" : "Fetch all non-retired reportingrest/cohortDefinition resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllCohortDefinitions", "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" : "reportingrest/cohortDefinition response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/ReportingrestCohortDefinitionGet" } } }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "reportingrest/cohortDefinition" ], "summary" : "Create with properties in request", "operationId" : "createCohortDefinition", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "resource", "description" : "Resource to create", "required" : true, "schema" : { "$ref" : "#/definitions/ReportingrestCohortDefinitionCreate" } } ], "responses" : { "201" : { "description" : "reportingrest/cohortDefinition response" }, "401" : { "description" : "User not logged in" } } } }, "/reportingrest/cohortDefinition/{uuid}" : { "get" : { "tags" : [ "reportingrest/cohortDefinition" ], "summary" : "Fetch by uuid", "operationId" : "getCohortDefinition", "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" : "reportingrest/cohortDefinition response", "schema" : { "$ref" : "#/definitions/ReportingrestCohortDefinitionGet" } }, "404" : { "description" : "Resource with given uuid doesn't exist" }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "reportingrest/cohortDefinition" ], "summary" : "Edit with given uuid, only modifying properties in request", "operationId" : "updateCohortDefinition", "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/ReportingrestCohortDefinitionUpdate" } } ], "responses" : { "201" : { "description" : "reportingrest/cohortDefinition response" }, "401" : { "description" : "User not logged in" } } }, "delete" : { "tags" : [ "reportingrest/cohortDefinition" ], "summary" : "Delete or purge resource by uuid", "description" : "The resource will be voided/retired unless purge = 'true'", "operationId" : "deleteCohortDefinition", "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" } } } }, "/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" } } } }, "/idgen/identifiersource" : { "get" : { "tags" : [ "idgen/identifiersource" ], "summary" : "Fetch all non-retired idgen/identifiersource resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllIdentifierSources", "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" } ], "responses" : { "200" : { "description" : "idgen/identifiersource response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/IdgenIdentifiersourceGet" } } }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "idgen/identifiersource" ], "summary" : "Create with properties in request", "operationId" : "createIdentifierSource", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "resource", "description" : "Resource to create", "required" : true, "schema" : { "$ref" : "#/definitions/IdgenIdentifiersourceCreate" } } ], "responses" : { "201" : { "description" : "idgen/identifiersource response" }, "401" : { "description" : "User not logged in" } } } }, "/idgen/identifiersource/{uuid}" : { "get" : { "tags" : [ "idgen/identifiersource" ], "summary" : "Fetch by uuid", "operationId" : "getIdentifierSource", "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" : "idgen/identifiersource response", "schema" : { "$ref" : "#/definitions/IdgenIdentifiersourceGet" } }, "404" : { "description" : "Resource with given uuid doesn't exist" }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "idgen/identifiersource" ], "summary" : "Edit with given uuid, only modifying properties in request", "operationId" : "updateIdentifierSource", "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/IdgenIdentifiersourceUpdate" } } ], "responses" : { "201" : { "description" : "idgen/identifiersource response" }, "401" : { "description" : "User not logged in" } } }, "delete" : { "tags" : [ "idgen/identifiersource" ], "summary" : "Delete or purge resource by uuid", "description" : "The resource will be voided/retired unless purge = 'true'", "operationId" : "deleteIdentifierSource", "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" } } } }, "/stockmanagement/stockoperationactionlineitem" : { "get" : { "tags" : [ "stockmanagement/stockoperationactionlineitem" ], "summary" : "Fetch all non-retired", "operationId" : "getAllStockOperationActionLineItems", "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" : "stockmanagement/stockoperationactionlineitem response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/StockmanagementStockoperationactionlineitemGet" } } }, "401" : { "description" : "User not logged in" } } } }, "/stockmanagement/stockoperationactionlineitem/{uuid}" : { "get" : { "tags" : [ "stockmanagement/stockoperationactionlineitem" ], "summary" : "Fetch by uuid", "operationId" : "getStockOperationActionLineItem", "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" : "stockmanagement/stockoperationactionlineitem response", "schema" : { "$ref" : "#/definitions/StockmanagementStockoperationactionlineitemGet" } }, "404" : { "description" : "Resource with given uuid doesn't exist" }, "401" : { "description" : "User not logged in" } } }, "delete" : { "tags" : [ "stockmanagement/stockoperationactionlineitem" ], "summary" : "Delete or purge resource by uuid", "description" : "The resource will be voided/retired unless purge = 'true'", "operationId" : "deleteStockOperationActionLineItem", "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" } } } }, "/cohortm/cohorttype" : { "get" : { "tags" : [ "cohortm/cohorttype" ], "summary" : "Fetch all non-retired cohortm/cohorttype resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllCohortTypes", "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" : "cohortm/cohorttype response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/CohortmCohorttypeGet" } } }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "cohortm/cohorttype" ], "summary" : "Create with properties in request", "operationId" : "createCohortType", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "resource", "description" : "Resource to create", "required" : true, "schema" : { "$ref" : "#/definitions/CohortmCohorttypeCreate" } } ], "responses" : { "201" : { "description" : "cohortm/cohorttype response" }, "401" : { "description" : "User not logged in" } } } }, "/cohortm/cohorttype/{uuid}" : { "get" : { "tags" : [ "cohortm/cohorttype" ], "summary" : "Fetch by uuid", "operationId" : "getCohortType", "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" : "cohortm/cohorttype response", "schema" : { "$ref" : "#/definitions/CohortmCohorttypeGet" } }, "404" : { "description" : "Resource with given uuid doesn't exist" }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "cohortm/cohorttype" ], "summary" : "Edit with given uuid, only modifying properties in request", "operationId" : "updateCohortType", "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/CohortmCohorttypeUpdate" } } ], "responses" : { "201" : { "description" : "cohortm/cohorttype response" }, "401" : { "description" : "User not logged in" } } }, "delete" : { "tags" : [ "cohortm/cohorttype" ], "summary" : "Delete or purge resource by uuid", "description" : "The resource will be voided/retired unless purge = 'true'", "operationId" : "deleteCohortType", "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" } } } }, "/queue-entry" : { "get" : { "tags" : [ "queue-entry" ], "summary" : "Fetch all non-retired queue-entry resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllQueueEntries", "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" : "queue-entry response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/Queue-entryGet" } } }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "queue-entry" ], "summary" : "Create with properties in request", "operationId" : "createQueueEntry", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "resource", "description" : "Resource to create", "required" : true, "schema" : { "$ref" : "#/definitions/Queue-entryCreate" } } ], "responses" : { "201" : { "description" : "queue-entry response" }, "401" : { "description" : "User not logged in" } } } }, "/queue-entry/{uuid}" : { "get" : { "tags" : [ "queue-entry" ], "summary" : "Fetch by uuid", "operationId" : "getQueueEntry", "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" : "queue-entry response", "schema" : { "$ref" : "#/definitions/Queue-entryGet" } }, "404" : { "description" : "Resource with given uuid doesn't exist" }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "queue-entry" ], "summary" : "Edit with given uuid, only modifying properties in request", "operationId" : "updateQueueEntry", "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/Queue-entryUpdate" } } ], "responses" : { "201" : { "description" : "queue-entry response" }, "401" : { "description" : "User not logged in" } } }, "delete" : { "tags" : [ "queue-entry" ], "summary" : "Delete or purge resource by uuid", "description" : "The resource will be voided/retired unless purge = 'true'", "operationId" : "deleteQueueEntry", "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" } } } }, "/reportingrest/reportdata" : { "get" : { "tags" : [ "reportingrest/reportdata" ], "summary" : "Fetch all non-retired reportingrest/reportdata resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllEvaluatedReportDefinitions", "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" : "reportingrest/reportdata response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/ReportingrestReportdataGet" } } }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "reportingrest/reportdata" ], "summary" : "Create with properties in request", "operationId" : "createEvaluatedReportDefinition", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "resource", "description" : "Resource to create", "required" : true, "schema" : { "$ref" : "#/definitions/ReportingrestReportdataCreate" } } ], "responses" : { "201" : { "description" : "reportingrest/reportdata response" }, "401" : { "description" : "User not logged in" } } } }, "/reportingrest/reportdata/{uuid}" : { "get" : { "tags" : [ "reportingrest/reportdata" ], "summary" : "Fetch by uuid", "operationId" : "getEvaluatedReportDefinition", "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" : "reportingrest/reportdata response", "schema" : { "$ref" : "#/definitions/ReportingrestReportdataGet" } }, "404" : { "description" : "Resource with given uuid doesn't exist" }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "reportingrest/reportdata" ], "summary" : "Edit with given uuid, only modifying properties in request", "operationId" : "updateEvaluatedReportDefinition", "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/ReportingrestReportdataUpdate" } } ], "responses" : { "201" : { "description" : "reportingrest/reportdata response" }, "401" : { "description" : "User not logged in" } } }, "delete" : { "tags" : [ "reportingrest/reportdata" ], "summary" : "Delete or purge resource by uuid", "description" : "The resource will be voided/retired unless purge = 'true'", "operationId" : "deleteEvaluatedReportDefinition", "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" } } } }, "/beds" : { "get" : { "tags" : [ "beds" ], "summary" : "Fetch all non-retired beds resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllBedDetailses", "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" : "visitUuid", "in" : "query", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "beds response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/BedsGet" } } }, "401" : { "description" : "User not logged in" } } } }, "/beds/{uuid}" : { "get" : { "tags" : [ "beds" ], "summary" : "Fetch by uuid", "operationId" : "getBedDetails", "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" : "beds response", "schema" : { "$ref" : "#/definitions/BedsGet" } }, "404" : { "description" : "Resource with given uuid doesn't exist" }, "401" : { "description" : "User not logged in" } } }, "delete" : { "tags" : [ "beds" ], "summary" : "Delete or purge resource by uuid", "description" : "The resource will be voided/retired unless purge = 'true'", "operationId" : "deleteBedDetails", "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" } } } }, "/stockmanagement/stockoperationitemcost" : { "get" : { "tags" : [ "stockmanagement/stockoperationitemcost" ], "summary" : "Fetch all non-retired stockmanagement/stockoperationitemcost resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllStockOperationItemCosts", "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" : "stockmanagement/stockoperationitemcost response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/StockmanagementStockoperationitemcostGet" } } }, "401" : { "description" : "User not logged in" } } } }, "/stockmanagement/stockoperationitemcost/{uuid}" : { "get" : { "tags" : [ "stockmanagement/stockoperationitemcost" ], "summary" : "Fetch by uuid", "operationId" : "getStockOperationItemCost", "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" : "stockmanagement/stockoperationitemcost response", "schema" : { "$ref" : "#/definitions/StockmanagementStockoperationitemcostGet" } }, "404" : { "description" : "Resource with given uuid doesn't exist" }, "401" : { "description" : "User not logged in" } } }, "delete" : { "tags" : [ "stockmanagement/stockoperationitemcost" ], "summary" : "Delete or purge resource by uuid", "description" : "The resource will be voided/retired unless purge = 'true'", "operationId" : "deleteStockOperationItemCost", "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" } } } }, "/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" } } } }, "/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" } } } }, "/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" } } } }, "/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" } } } }, "/patientflags/patientflag" : { "get" : { "tags" : [ "patientflags/patientflag" ], "summary" : "Fetch all non-retired patientflags/patientflag resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllPatientFlags", "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" : "patientflags/patientflag response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/PatientflagsPatientflagGet" } } }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "patientflags/patientflag" ], "summary" : "Create with properties in request", "operationId" : "createPatientFlag", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "resource", "description" : "Resource to create", "required" : true, "schema" : { "$ref" : "#/definitions/PatientflagsPatientflagCreate" } } ], "responses" : { "201" : { "description" : "patientflags/patientflag response" }, "401" : { "description" : "User not logged in" } } } }, "/patientflags/patientflag/{uuid}" : { "get" : { "tags" : [ "patientflags/patientflag" ], "summary" : "Fetch by uuid", "operationId" : "getPatientFlag", "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" : "patientflags/patientflag response", "schema" : { "$ref" : "#/definitions/PatientflagsPatientflagGet" } }, "404" : { "description" : "Resource with given uuid doesn't exist" }, "401" : { "description" : "User not logged in" } } }, "delete" : { "tags" : [ "patientflags/patientflag" ], "summary" : "Delete or purge resource by uuid", "description" : "The resource will be voided/retired unless purge = 'true'", "operationId" : "deletePatientFlag", "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" } } } }, "/attachment" : { "get" : { "tags" : [ "attachment" ], "summary" : "Fetch all non-retired attachment resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllAttachments", "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" : "attachment response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/AttachmentGet" } } }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "attachment" ], "summary" : "Create with properties in request", "operationId" : "createAttachment", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "resource", "description" : "Resource to create", "required" : true, "schema" : { "$ref" : "#/definitions/AttachmentCreate" } } ], "responses" : { "201" : { "description" : "attachment response" }, "401" : { "description" : "User not logged in" } } } }, "/attachment/{uuid}" : { "get" : { "tags" : [ "attachment" ], "summary" : "Fetch by uuid", "operationId" : "getAttachment", "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" : "attachment response", "schema" : { "$ref" : "#/definitions/AttachmentGet" } }, "404" : { "description" : "Resource with given uuid doesn't exist" }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "attachment" ], "summary" : "Edit with given uuid, only modifying properties in request", "operationId" : "updateAttachment", "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/AttachmentUpdate" } } ], "responses" : { "201" : { "description" : "attachment response" }, "401" : { "description" : "User not logged in" } } }, "delete" : { "tags" : [ "attachment" ], "summary" : "Delete or purge resource by uuid", "description" : "The resource will be voided/retired unless purge = 'true'", "operationId" : "deleteAttachment", "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" } } } }, "/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" } } } }, "/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" } } } }, "/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" } } } }, "/stockmanagement/stocksource" : { "get" : { "tags" : [ "stockmanagement/stocksource" ], "summary" : "Fetch all non-retired stockmanagement/stocksource resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllStockSources", "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" : "stockmanagement/stocksource response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/StockmanagementStocksourceGet" } } }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "stockmanagement/stocksource" ], "summary" : "Create with properties in request", "operationId" : "createStockSource", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "resource", "description" : "Resource to create", "required" : true, "schema" : { "$ref" : "#/definitions/StockmanagementStocksourceCreate" } } ], "responses" : { "201" : { "description" : "stockmanagement/stocksource response" }, "401" : { "description" : "User not logged in" } } } }, "/stockmanagement/stocksource/{uuid}" : { "get" : { "tags" : [ "stockmanagement/stocksource" ], "summary" : "Fetch by uuid", "operationId" : "getStockSource", "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" : "stockmanagement/stocksource response", "schema" : { "$ref" : "#/definitions/StockmanagementStocksourceGet" } }, "404" : { "description" : "Resource with given uuid doesn't exist" }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "stockmanagement/stocksource" ], "summary" : "Edit with given uuid, only modifying properties in request", "operationId" : "updateStockSource", "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/StockmanagementStocksourceUpdate" } } ], "responses" : { "201" : { "description" : "stockmanagement/stocksource response" }, "401" : { "description" : "User not logged in" } } }, "delete" : { "tags" : [ "stockmanagement/stocksource" ], "summary" : "Delete or purge resource by uuid", "description" : "The resource will be voided/retired unless purge = 'true'", "operationId" : "deleteStockSource", "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" } } } }, "/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" } } } }, "/idgen/autogenerationoption" : { "get" : { "tags" : [ "idgen/autogenerationoption" ], "summary" : "Fetch all non-retired idgen/autogenerationoption resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllAutoGenerationOptions", "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" : "idgen/autogenerationoption response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/IdgenAutogenerationoptionGet" } } }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "idgen/autogenerationoption" ], "summary" : "Create with properties in request", "operationId" : "createAutoGenerationOption", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "resource", "description" : "Resource to create", "required" : true, "schema" : { "$ref" : "#/definitions/IdgenAutogenerationoptionCreate" } } ], "responses" : { "201" : { "description" : "idgen/autogenerationoption response" }, "401" : { "description" : "User not logged in" } } } }, "/idgen/autogenerationoption/{uuid}" : { "get" : { "tags" : [ "idgen/autogenerationoption" ], "summary" : "Fetch by uuid", "operationId" : "getAutoGenerationOption", "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" : "idgen/autogenerationoption response", "schema" : { "$ref" : "#/definitions/IdgenAutogenerationoptionGet" } }, "404" : { "description" : "Resource with given uuid doesn't exist" }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "idgen/autogenerationoption" ], "summary" : "Edit with given uuid, only modifying properties in request", "operationId" : "updateAutoGenerationOption", "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/IdgenAutogenerationoptionUpdate" } } ], "responses" : { "201" : { "description" : "idgen/autogenerationoption response" }, "401" : { "description" : "User not logged in" } } }, "delete" : { "tags" : [ "idgen/autogenerationoption" ], "summary" : "Delete or purge resource by uuid", "description" : "The resource will be voided/retired unless purge = 'true'", "operationId" : "deleteAutoGenerationOption", "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" } } } }, "/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" } } } }, "/stockmanagement/privilegescope" : { "get" : { "tags" : [ "stockmanagement/privilegescope" ], "summary" : "Fetch all non-retired", "operationId" : "getAllPrivilegeScopes", "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" : "stockmanagement/privilegescope response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/StockmanagementPrivilegescopeGet" } } }, "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" } } } }, "/idgen/nextIdentifier" : { "get" : { "tags" : [ "idgen/nextIdentifier" ], "summary" : "Fetch all non-retired idgen/nextIdentifier resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllSequenceIdentifiers", "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" : "idgen/nextIdentifier response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/IdgenNextIdentifierGet" } } }, "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" } } } }, "/bedtype" : { "get" : { "tags" : [ "bedtype" ], "summary" : "Fetch all non-retired bedtype resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllBedTypes", "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" : "bedtype response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/BedtypeGet" } } }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "bedtype" ], "summary" : "Create with properties in request", "operationId" : "createBedType", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "resource", "description" : "Resource to create", "required" : true, "schema" : { "$ref" : "#/definitions/BedtypeCreate" } } ], "responses" : { "201" : { "description" : "bedtype response" }, "401" : { "description" : "User not logged in" } } } }, "/bedtype/{uuid}" : { "get" : { "tags" : [ "bedtype" ], "summary" : "Fetch by uuid", "operationId" : "getBedType", "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" : "bedtype response", "schema" : { "$ref" : "#/definitions/BedtypeGet" } }, "404" : { "description" : "Resource with given uuid doesn't exist" }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "bedtype" ], "summary" : "Edit with given uuid, only modifying properties in request", "operationId" : "updateBedType", "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/BedtypeUpdate" } } ], "responses" : { "201" : { "description" : "bedtype response" }, "401" : { "description" : "User not logged in" } } }, "delete" : { "tags" : [ "bedtype" ], "summary" : "Delete or purge resource by uuid", "description" : "The resource will be voided/retired unless purge = 'true'", "operationId" : "deleteBedType", "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" } } } }, "/billing/paymentAttribute" : { "get" : { "tags" : [ "billing/paymentAttribute" ], "summary" : "Fetch all non-retired billing/paymentAttribute resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllPaymentAttributes", "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" : "billing/paymentAttribute response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/BillingPaymentAttributeGet" } } }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "billing/paymentAttribute" ], "summary" : "Create with properties in request", "operationId" : "createPaymentAttribute", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "resource", "description" : "Resource to create", "required" : true, "schema" : { "$ref" : "#/definitions/BillingPaymentAttributeCreate" } } ], "responses" : { "201" : { "description" : "billing/paymentAttribute response" }, "401" : { "description" : "User not logged in" } } } }, "/billing/paymentAttribute/{uuid}" : { "get" : { "tags" : [ "billing/paymentAttribute" ], "summary" : "Fetch by uuid", "operationId" : "getPaymentAttribute", "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" : "billing/paymentAttribute response", "schema" : { "$ref" : "#/definitions/BillingPaymentAttributeGet" } }, "404" : { "description" : "Resource with given uuid doesn't exist" }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "billing/paymentAttribute" ], "summary" : "Edit with given uuid, only modifying properties in request", "operationId" : "updatePaymentAttribute", "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/BillingPaymentAttributeUpdate" } } ], "responses" : { "201" : { "description" : "billing/paymentAttribute response" }, "401" : { "description" : "User not logged in" } } }, "delete" : { "tags" : [ "billing/paymentAttribute" ], "summary" : "Delete or purge resource by uuid", "description" : "The resource will be voided/retired unless purge = 'true'", "operationId" : "deletePaymentAttribute", "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" } } } }, "/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" } } } }, "/stockmanagement/stockitemtransaction" : { "get" : { "tags" : [ "stockmanagement/stockitemtransaction" ], "summary" : "Fetch all non-retired stockmanagement/stockitemtransaction resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllStockItemTransactions", "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" : "stockmanagement/stockitemtransaction response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/StockmanagementStockitemtransactionGet" } } }, "401" : { "description" : "User not logged in" } } } }, "/stockmanagement/stockitemtransaction/{uuid}" : { "get" : { "tags" : [ "stockmanagement/stockitemtransaction" ], "summary" : "Fetch by uuid", "operationId" : "getStockItemTransaction", "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" : "stockmanagement/stockitemtransaction response", "schema" : { "$ref" : "#/definitions/StockmanagementStockitemtransactionGet" } }, "404" : { "description" : "Resource with given uuid doesn't exist" }, "401" : { "description" : "User not logged in" } } }, "delete" : { "tags" : [ "stockmanagement/stockitemtransaction" ], "summary" : "Delete or purge resource by uuid", "description" : "The resource will be voided/retired unless purge = 'true'", "operationId" : "deleteStockItemTransaction", "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" } } } }, "/metadatamapping/source" : { "get" : { "tags" : [ "metadatamapping/source" ], "summary" : "Fetch all non-retired metadatamapping/source resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllMetadataSources", "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" : "metadatamapping/source response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/MetadatamappingSourceGet" } } }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "metadatamapping/source" ], "summary" : "Create with properties in request", "operationId" : "createMetadataSource", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "resource", "description" : "Resource to create", "required" : true, "schema" : { "$ref" : "#/definitions/MetadatamappingSourceCreate" } } ], "responses" : { "201" : { "description" : "metadatamapping/source response" }, "401" : { "description" : "User not logged in" } } } }, "/metadatamapping/source/{uuid}" : { "get" : { "tags" : [ "metadatamapping/source" ], "summary" : "Fetch by uuid", "operationId" : "getMetadataSource", "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" : "metadatamapping/source response", "schema" : { "$ref" : "#/definitions/MetadatamappingSourceGet" } }, "404" : { "description" : "Resource with given uuid doesn't exist" }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "metadatamapping/source" ], "summary" : "Edit with given uuid, only modifying properties in request", "operationId" : "updateMetadataSource", "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/MetadatamappingSourceUpdate" } } ], "responses" : { "201" : { "description" : "metadatamapping/source response" }, "401" : { "description" : "User not logged in" } } }, "delete" : { "tags" : [ "metadatamapping/source" ], "summary" : "Delete or purge resource by uuid", "description" : "The resource will be voided/retired unless purge = 'true'", "operationId" : "deleteMetadataSource", "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" } } } }, "/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" } } } }, "/patientflags/priority" : { "get" : { "tags" : [ "patientflags/priority" ], "summary" : "Fetch all non-retired patientflags/priority resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllPatientFlagPriorities", "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" : "patientflags/priority response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/PatientflagsPriorityGet" } } }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "patientflags/priority" ], "summary" : "Create with properties in request", "operationId" : "createPatientFlagPriority", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "resource", "description" : "Resource to create", "required" : true, "schema" : { "$ref" : "#/definitions/PatientflagsPriorityCreate" } } ], "responses" : { "201" : { "description" : "patientflags/priority response" }, "401" : { "description" : "User not logged in" } } } }, "/patientflags/priority/{uuid}" : { "get" : { "tags" : [ "patientflags/priority" ], "summary" : "Fetch by uuid", "operationId" : "getPatientFlagPriority", "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" : "patientflags/priority response", "schema" : { "$ref" : "#/definitions/PatientflagsPriorityGet" } }, "404" : { "description" : "Resource with given uuid doesn't exist" }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "patientflags/priority" ], "summary" : "Edit with given uuid, only modifying properties in request", "operationId" : "updatePatientFlagPriority", "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/PatientflagsPriorityUpdate" } } ], "responses" : { "201" : { "description" : "patientflags/priority response" }, "401" : { "description" : "User not logged in" } } }, "delete" : { "tags" : [ "patientflags/priority" ], "summary" : "Delete or purge resource by uuid", "description" : "The resource will be voided/retired unless purge = 'true'", "operationId" : "deletePatientFlagPriority", "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" } } } }, "/billing/attributetype" : { "get" : { "tags" : [ "billing/attributetype" ], "summary" : "Fetch all non-retired billing/attributetype resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllInstanceAttributeTypeConverters", "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" } ], "responses" : { "200" : { "description" : "billing/attributetype response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/BillingAttributetypeGet" } } }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "billing/attributetype" ], "summary" : "Create with properties in request", "operationId" : "createInstanceAttributeTypeConverter", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "resource", "description" : "Resource to create", "required" : true, "schema" : { "$ref" : "#/definitions/BillingAttributetypeCreate" } } ], "responses" : { "201" : { "description" : "billing/attributetype response" }, "401" : { "description" : "User not logged in" } } } }, "/billing/attributetype/{uuid}" : { "get" : { "tags" : [ "billing/attributetype" ], "summary" : "Fetch by uuid", "operationId" : "getInstanceAttributeTypeConverter", "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" : "billing/attributetype response", "schema" : { "$ref" : "#/definitions/BillingAttributetypeGet" } }, "404" : { "description" : "Resource with given uuid doesn't exist" }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "billing/attributetype" ], "summary" : "Edit with given uuid, only modifying properties in request", "operationId" : "updateInstanceAttributeTypeConverter", "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/BillingAttributetypeUpdate" } } ], "responses" : { "201" : { "description" : "billing/attributetype response" }, "401" : { "description" : "User not logged in" } } }, "delete" : { "tags" : [ "billing/attributetype" ], "summary" : "Delete or purge resource by uuid", "description" : "The resource will be voided/retired unless purge = 'true'", "operationId" : "deleteInstanceAttributeTypeConverter", "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" } } } }, "/idgen/logentry" : { "get" : { "tags" : [ "idgen/logentry" ], "summary" : "Fetch all non-retired idgen/logentry resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllLogEntries", "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" : "fromDate", "in" : "query", "description" : "Must be used with ", "required" : false, "type" : "string" }, { "name" : "identifier", "in" : "query", "description" : "Must be used with ", "required" : false, "type" : "string" }, { "name" : "toDate", "in" : "query", "description" : "Must be used with ", "required" : false, "type" : "string" }, { "name" : "comment", "in" : "query", "description" : "Must be used with ", "required" : false, "type" : "string" }, { "name" : "source", "in" : "query", "description" : "Must be used with ", "required" : false, "type" : "string" }, { "name" : "generatedBy", "in" : "query", "description" : "Must be used with ", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "idgen/logentry response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/IdgenLogentryGet" } } }, "401" : { "description" : "User not logged in" } } } }, "/idgen/logentry/{uuid}" : { "get" : { "tags" : [ "idgen/logentry" ], "summary" : "Fetch by uuid", "operationId" : "getLogEntry", "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" : "idgen/logentry response", "schema" : { "$ref" : "#/definitions/IdgenLogentryGet" } }, "404" : { "description" : "Resource with given uuid doesn't exist" }, "401" : { "description" : "User not logged in" } } }, "delete" : { "tags" : [ "idgen/logentry" ], "summary" : "Delete or purge resource by uuid", "description" : "The resource will be voided/retired unless purge = 'true'", "operationId" : "deleteLogEntry", "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" : "conceptList", "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" } } } }, "/bed" : { "get" : { "tags" : [ "bed" ], "summary" : "Fetch all non-retired bed resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllBeds", "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" : "bed response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/BedGet" } } }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "bed" ], "summary" : "Create with properties in request", "operationId" : "createBed", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "resource", "description" : "Resource to create", "required" : true, "schema" : { "$ref" : "#/definitions/BedCreate" } } ], "responses" : { "201" : { "description" : "bed response" }, "401" : { "description" : "User not logged in" } } } }, "/bed/{uuid}" : { "get" : { "tags" : [ "bed" ], "summary" : "Fetch by uuid", "operationId" : "getBed", "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" : "bed response", "schema" : { "$ref" : "#/definitions/BedGet" } }, "404" : { "description" : "Resource with given uuid doesn't exist" }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "bed" ], "summary" : "Edit with given uuid, only modifying properties in request", "operationId" : "updateBed", "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/BedUpdate" } } ], "responses" : { "201" : { "description" : "bed response" }, "401" : { "description" : "User not logged in" } } }, "delete" : { "tags" : [ "bed" ], "summary" : "Delete or purge resource by uuid", "description" : "The resource will be voided/retired unless purge = 'true'", "operationId" : "deleteBed", "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" } } } }, "/patientprofile" : { "get" : { "tags" : [ "patientprofile" ], "summary" : "Fetch all non-retired patientprofile resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllPatientProfiles", "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" : "patientprofile response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/PatientprofileGet" } } }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "patientprofile" ], "summary" : "Create with properties in request", "operationId" : "createPatientProfile", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "resource", "description" : "Resource to create", "required" : true, "schema" : { "$ref" : "#/definitions/PatientprofileCreate" } } ], "responses" : { "201" : { "description" : "patientprofile response" }, "401" : { "description" : "User not logged in" } } } }, "/patientprofile/{uuid}" : { "post" : { "tags" : [ "patientprofile" ], "summary" : "Edit with given uuid, only modifying properties in request", "operationId" : "updatePatientProfile", "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/PatientprofileUpdate" } } ], "responses" : { "201" : { "description" : "patientprofile response" }, "401" : { "description" : "User not logged in" } } } }, "/ordertemplates/orderTemplate" : { "get" : { "tags" : [ "ordertemplates/orderTemplate" ], "summary" : "Fetch all non-retired ordertemplates/orderTemplate resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllOrderTemplateses", "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" : "ordertemplates/orderTemplate response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/OrdertemplatesOrderTemplateGet" } } }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "ordertemplates/orderTemplate" ], "summary" : "Create with properties in request", "operationId" : "createOrderTemplates", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "resource", "description" : "Resource to create", "required" : true, "schema" : { "$ref" : "#/definitions/OrdertemplatesOrderTemplateCreate" } } ], "responses" : { "201" : { "description" : "ordertemplates/orderTemplate response" }, "401" : { "description" : "User not logged in" } } } }, "/ordertemplates/orderTemplate/{uuid}" : { "get" : { "tags" : [ "ordertemplates/orderTemplate" ], "summary" : "Fetch by uuid", "operationId" : "getOrderTemplates", "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" : "ordertemplates/orderTemplate response", "schema" : { "$ref" : "#/definitions/OrdertemplatesOrderTemplateGet" } }, "404" : { "description" : "Resource with given uuid doesn't exist" }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "ordertemplates/orderTemplate" ], "summary" : "Edit with given uuid, only modifying properties in request", "operationId" : "updateOrderTemplates", "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/OrdertemplatesOrderTemplateUpdate" } } ], "responses" : { "201" : { "description" : "ordertemplates/orderTemplate response" }, "401" : { "description" : "User not logged in" } } }, "delete" : { "tags" : [ "ordertemplates/orderTemplate" ], "summary" : "Delete or purge resource by uuid", "description" : "The resource will be voided/retired unless purge = 'true'", "operationId" : "deleteOrderTemplates", "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" } } } }, "/cohortm/cohortattributetype" : { "get" : { "tags" : [ "cohortm/cohortattributetype" ], "summary" : "Fetch all non-retired cohortm/cohortattributetype resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllCohortAttributeTypes", "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" : "cohortm/cohortattributetype response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/CohortmCohortattributetypeGet" } } }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "cohortm/cohortattributetype" ], "summary" : "Create with properties in request", "operationId" : "createCohortAttributeType", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "resource", "description" : "Resource to create", "required" : true, "schema" : { "$ref" : "#/definitions/CohortmCohortattributetypeCreate" } } ], "responses" : { "201" : { "description" : "cohortm/cohortattributetype response" }, "401" : { "description" : "User not logged in" } } } }, "/cohortm/cohortattributetype/{uuid}" : { "get" : { "tags" : [ "cohortm/cohortattributetype" ], "summary" : "Fetch by uuid", "operationId" : "getCohortAttributeType", "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" : "cohortm/cohortattributetype response", "schema" : { "$ref" : "#/definitions/CohortmCohortattributetypeGet" } }, "404" : { "description" : "Resource with given uuid doesn't exist" }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "cohortm/cohortattributetype" ], "summary" : "Edit with given uuid, only modifying properties in request", "operationId" : "updateCohortAttributeType", "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/CohortmCohortattributetypeUpdate" } } ], "responses" : { "201" : { "description" : "cohortm/cohortattributetype response" }, "401" : { "description" : "User not logged in" } } }, "delete" : { "tags" : [ "cohortm/cohortattributetype" ], "summary" : "Delete or purge resource by uuid", "description" : "The resource will be voided/retired unless purge = 'true'", "operationId" : "deleteCohortAttributeType", "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" } } } }, "/stockmanagement/stockitem" : { "get" : { "tags" : [ "stockmanagement/stockitem" ], "summary" : "Fetch all non-retired stockmanagement/stockitem resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllStockItems", "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" : "stockmanagement/stockitem response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/StockmanagementStockitemGet" } } }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "stockmanagement/stockitem" ], "summary" : "Create with properties in request", "operationId" : "createStockItem", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "resource", "description" : "Resource to create", "required" : true, "schema" : { "$ref" : "#/definitions/StockmanagementStockitemCreate" } } ], "responses" : { "201" : { "description" : "stockmanagement/stockitem response" }, "401" : { "description" : "User not logged in" } } } }, "/stockmanagement/stockitem/{uuid}" : { "get" : { "tags" : [ "stockmanagement/stockitem" ], "summary" : "Fetch by uuid", "operationId" : "getStockItem", "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" : "stockmanagement/stockitem response", "schema" : { "$ref" : "#/definitions/StockmanagementStockitemGet" } }, "404" : { "description" : "Resource with given uuid doesn't exist" }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "stockmanagement/stockitem" ], "summary" : "Edit with given uuid, only modifying properties in request", "operationId" : "updateStockItem", "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/StockmanagementStockitemUpdate" } } ], "responses" : { "201" : { "description" : "stockmanagement/stockitem response" }, "401" : { "description" : "User not logged in" } } }, "delete" : { "tags" : [ "stockmanagement/stockitem" ], "summary" : "Delete or purge resource by uuid", "description" : "The resource will be voided/retired unless purge = 'true'", "operationId" : "deleteStockItem", "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" } } } }, "/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" } } } }, "/stockmanagement/stockoperationtypelocationscope" : { "get" : { "tags" : [ "stockmanagement/stockoperationtypelocationscope" ], "summary" : "Fetch all non-retired stockmanagement/stockoperationtypelocationscope resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllStockOperationTypeLocationScopes", "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" : "stockmanagement/stockoperationtypelocationscope response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/StockmanagementStockoperationtypelocationscopeGet" } } }, "401" : { "description" : "User not logged in" } } } }, "/stockmanagement/stockoperationtypelocationscope/{uuid}" : { "get" : { "tags" : [ "stockmanagement/stockoperationtypelocationscope" ], "summary" : "Fetch by uuid", "operationId" : "getStockOperationTypeLocationScope", "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" : "stockmanagement/stockoperationtypelocationscope response", "schema" : { "$ref" : "#/definitions/StockmanagementStockoperationtypelocationscopeGet" } }, "404" : { "description" : "Resource with given uuid doesn't exist" }, "401" : { "description" : "User not logged in" } } }, "delete" : { "tags" : [ "stockmanagement/stockoperationtypelocationscope" ], "summary" : "Delete or purge resource by uuid", "description" : "The resource will be voided/retired unless purge = 'true'", "operationId" : "deleteStockOperationTypeLocationScope", "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" } } } }, "/stockmanagement/stockoperationlink" : { "get" : { "tags" : [ "stockmanagement/stockoperationlink" ], "summary" : "Fetch all non-retired stockmanagement/stockoperationlink resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllStockOperationLinks", "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" : "stockmanagement/stockoperationlink response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/StockmanagementStockoperationlinkGet" } } }, "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" } } } }, "/stockmanagement/stockoperationitem" : { "get" : { "tags" : [ "stockmanagement/stockoperationitem" ], "summary" : "Fetch all non-retired stockmanagement/stockoperationitem resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllStockOperationItems", "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" : "stockmanagement/stockoperationitem response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/StockmanagementStockoperationitemGet" } } }, "401" : { "description" : "User not logged in" } } } }, "/stockmanagement/stockoperationitem/{uuid}" : { "get" : { "tags" : [ "stockmanagement/stockoperationitem" ], "summary" : "Fetch by uuid", "operationId" : "getStockOperationItem", "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" : "stockmanagement/stockoperationitem response", "schema" : { "$ref" : "#/definitions/StockmanagementStockoperationitemGet" } }, "404" : { "description" : "Resource with given uuid doesn't exist" }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "stockmanagement/stockoperationitem" ], "summary" : "Edit with given uuid, only modifying properties in request", "operationId" : "updateStockOperationItem", "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/StockmanagementStockoperationitemUpdate" } } ], "responses" : { "201" : { "description" : "stockmanagement/stockoperationitem response" }, "401" : { "description" : "User not logged in" } } }, "delete" : { "tags" : [ "stockmanagement/stockoperationitem" ], "summary" : "Delete or purge resource by uuid", "description" : "The resource will be voided/retired unless purge = 'true'", "operationId" : "deleteStockOperationItem", "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" } } } }, "/stockmanagement/batchjob" : { "get" : { "tags" : [ "stockmanagement/batchjob" ], "summary" : "Fetch all non-retired stockmanagement/batchjob resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllBatchJobs", "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" : "stockmanagement/batchjob response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/StockmanagementBatchjobGet" } } }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "stockmanagement/batchjob" ], "summary" : "Create with properties in request", "operationId" : "createBatchJob", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "resource", "description" : "Resource to create", "required" : true, "schema" : { "$ref" : "#/definitions/StockmanagementBatchjobCreate" } } ], "responses" : { "201" : { "description" : "stockmanagement/batchjob response" }, "401" : { "description" : "User not logged in" } } } }, "/stockmanagement/batchjob/{uuid}" : { "get" : { "tags" : [ "stockmanagement/batchjob" ], "summary" : "Fetch by uuid", "operationId" : "getBatchJob", "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" : "stockmanagement/batchjob response", "schema" : { "$ref" : "#/definitions/StockmanagementBatchjobGet" } }, "404" : { "description" : "Resource with given uuid doesn't exist" }, "401" : { "description" : "User not logged in" } } }, "delete" : { "tags" : [ "stockmanagement/batchjob" ], "summary" : "Delete or purge resource by uuid", "description" : "The resource will be voided/retired unless purge = 'true'", "operationId" : "deleteBatchJob", "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" } } } }, "/stockmanagement/stockoperationbatchnumbers" : { "get" : { "tags" : [ "stockmanagement/stockoperationbatchnumbers" ], "summary" : "Fetch all non-retired stockmanagement/stockoperationbatchnumbers resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllStockOperationBatchNumberses", "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" : "stockmanagement/stockoperationbatchnumbers response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/StockmanagementStockoperationbatchnumbersGet" } } }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "stockmanagement/stockoperationbatchnumbers" ], "summary" : "Create with properties in request", "operationId" : "createStockOperationBatchNumbers", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "resource", "description" : "Resource to create", "required" : true, "schema" : { "$ref" : "#/definitions/StockmanagementStockoperationbatchnumbersCreate" } } ], "responses" : { "201" : { "description" : "stockmanagement/stockoperationbatchnumbers response" }, "401" : { "description" : "User not logged in" } } } }, "/stockmanagement/stockoperationbatchnumbers/{uuid}" : { "get" : { "tags" : [ "stockmanagement/stockoperationbatchnumbers" ], "summary" : "Fetch by uuid", "operationId" : "getStockOperationBatchNumbers", "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" : "stockmanagement/stockoperationbatchnumbers response", "schema" : { "$ref" : "#/definitions/StockmanagementStockoperationbatchnumbersGet" } }, "404" : { "description" : "Resource with given uuid doesn't exist" }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "stockmanagement/stockoperationbatchnumbers" ], "summary" : "Edit with given uuid, only modifying properties in request", "operationId" : "updateStockOperationBatchNumbers", "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/StockmanagementStockoperationbatchnumbersUpdate" } } ], "responses" : { "201" : { "description" : "stockmanagement/stockoperationbatchnumbers response" }, "401" : { "description" : "User not logged in" } } }, "delete" : { "tags" : [ "stockmanagement/stockoperationbatchnumbers" ], "summary" : "Delete or purge resource by uuid", "description" : "The resource will be voided/retired unless purge = 'true'", "operationId" : "deleteStockOperationBatchNumbers", "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" } } } }, "/stockmanagement/stockbatch" : { "get" : { "tags" : [ "stockmanagement/stockbatch" ], "summary" : "Fetch all non-retired stockmanagement/stockbatch resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllStockBatches", "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" : "stockmanagement/stockbatch response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/StockmanagementStockbatchGet" } } }, "401" : { "description" : "User not logged in" } } } }, "/queue" : { "get" : { "tags" : [ "queue" ], "summary" : "Fetch all non-retired queue resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllQueues", "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" : "queue response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/QueueGet" } } }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "queue" ], "summary" : "Create with properties in request", "operationId" : "createQueue", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "resource", "description" : "Resource to create", "required" : true, "schema" : { "$ref" : "#/definitions/QueueCreate" } } ], "responses" : { "201" : { "description" : "queue response" }, "401" : { "description" : "User not logged in" } } } }, "/queue/{uuid}" : { "get" : { "tags" : [ "queue" ], "summary" : "Fetch by uuid", "operationId" : "getQueue", "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" : "queue response", "schema" : { "$ref" : "#/definitions/QueueGet" } }, "404" : { "description" : "Resource with given uuid doesn't exist" }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "queue" ], "summary" : "Edit with given uuid, only modifying properties in request", "operationId" : "updateQueue", "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/QueueUpdate" } } ], "responses" : { "201" : { "description" : "queue response" }, "401" : { "description" : "User not logged in" } } }, "delete" : { "tags" : [ "queue" ], "summary" : "Delete or purge resource by uuid", "description" : "The resource will be voided/retired unless purge = 'true'", "operationId" : "deleteQueue", "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" } } } }, "/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" } } } }, "/bedTag" : { "get" : { "tags" : [ "bedTag" ], "summary" : "Fetch all non-retired bedTag resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllBedTags", "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" : "bedTag response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/BedTagGet" } } }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "bedTag" ], "summary" : "Create with properties in request", "operationId" : "createBedTag", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "resource", "description" : "Resource to create", "required" : true, "schema" : { "$ref" : "#/definitions/BedTagCreate" } } ], "responses" : { "201" : { "description" : "bedTag response" }, "401" : { "description" : "User not logged in" } } } }, "/bedTag/{uuid}" : { "get" : { "tags" : [ "bedTag" ], "summary" : "Fetch by uuid", "operationId" : "getBedTag", "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" : "bedTag response", "schema" : { "$ref" : "#/definitions/BedTagGet" } }, "404" : { "description" : "Resource with given uuid doesn't exist" }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "bedTag" ], "summary" : "Edit with given uuid, only modifying properties in request", "operationId" : "updateBedTag", "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/BedTagUpdate" } } ], "responses" : { "201" : { "description" : "bedTag response" }, "401" : { "description" : "User not logged in" } } }, "delete" : { "tags" : [ "bedTag" ], "summary" : "Delete or purge resource by uuid", "description" : "The resource will be voided/retired unless purge = 'true'", "operationId" : "deleteBedTag", "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" } } } }, "/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" } } } }, "/stockmanagement/dispenserequest" : { "get" : { "tags" : [ "stockmanagement/dispenserequest" ], "summary" : "Fetch all non-retired stockmanagement/dispenserequest resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllDispenseRequests", "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" : "stockmanagement/dispenserequest response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/StockmanagementDispenserequestGet" } } }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "stockmanagement/dispenserequest" ], "summary" : "Create with properties in request", "operationId" : "createDispenseRequest", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "resource", "description" : "Resource to create", "required" : true, "schema" : { "$ref" : "#/definitions/StockmanagementDispenserequestCreate" } } ], "responses" : { "201" : { "description" : "stockmanagement/dispenserequest response" }, "401" : { "description" : "User not logged in" } } } }, "/stockmanagement/dispenserequest/{uuid}" : { "get" : { "tags" : [ "stockmanagement/dispenserequest" ], "summary" : "Fetch by uuid", "operationId" : "getDispenseRequest", "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" : "stockmanagement/dispenserequest response", "schema" : { "$ref" : "#/definitions/StockmanagementDispenserequestGet" } }, "404" : { "description" : "Resource with given uuid doesn't exist" }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "stockmanagement/dispenserequest" ], "summary" : "Edit with given uuid, only modifying properties in request", "operationId" : "updateDispenseRequest", "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/StockmanagementDispenserequestUpdate" } } ], "responses" : { "201" : { "description" : "stockmanagement/dispenserequest response" }, "401" : { "description" : "User not logged in" } } }, "delete" : { "tags" : [ "stockmanagement/dispenserequest" ], "summary" : "Delete or purge resource by uuid", "description" : "The resource will be voided/retired unless purge = 'true'", "operationId" : "deleteDispenseRequest", "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" }, { "name" : "lastviewed", "in" : "query", "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" } } } }, "/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" } } } }, "/stockmanagement/stockoperationaction" : { "get" : { "tags" : [ "stockmanagement/stockoperationaction" ], "summary" : "Fetch all non-retired stockmanagement/stockoperationaction resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllStockOperationActions", "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" : "stockmanagement/stockoperationaction response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/StockmanagementStockoperationactionGet" } } }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "stockmanagement/stockoperationaction" ], "summary" : "Create with properties in request", "operationId" : "createStockOperationAction", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "resource", "description" : "Resource to create", "required" : true, "schema" : { "$ref" : "#/definitions/StockmanagementStockoperationactionCreate" } } ], "responses" : { "201" : { "description" : "stockmanagement/stockoperationaction response" }, "401" : { "description" : "User not logged in" } } } }, "/patientflags/displaypoint" : { "get" : { "tags" : [ "patientflags/displaypoint" ], "summary" : "Fetch all non-retired patientflags/displaypoint resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllPatientFlagDisplayPoints", "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" : "patientflags/displaypoint response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/PatientflagsDisplaypointGet" } } }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "patientflags/displaypoint" ], "summary" : "Create with properties in request", "operationId" : "createPatientFlagDisplayPoint", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "resource", "description" : "Resource to create", "required" : true, "schema" : { "$ref" : "#/definitions/PatientflagsDisplaypointCreate" } } ], "responses" : { "201" : { "description" : "patientflags/displaypoint response" }, "401" : { "description" : "User not logged in" } } } }, "/patientflags/displaypoint/{uuid}" : { "get" : { "tags" : [ "patientflags/displaypoint" ], "summary" : "Fetch by uuid", "operationId" : "getPatientFlagDisplayPoint", "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" : "patientflags/displaypoint response", "schema" : { "$ref" : "#/definitions/PatientflagsDisplaypointGet" } }, "404" : { "description" : "Resource with given uuid doesn't exist" }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "patientflags/displaypoint" ], "summary" : "Edit with given uuid, only modifying properties in request", "operationId" : "updatePatientFlagDisplayPoint", "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/PatientflagsDisplaypointUpdate" } } ], "responses" : { "201" : { "description" : "patientflags/displaypoint response" }, "401" : { "description" : "User not logged in" } } }, "delete" : { "tags" : [ "patientflags/displaypoint" ], "summary" : "Delete or purge resource by uuid", "description" : "The resource will be voided/retired unless purge = 'true'", "operationId" : "deletePatientFlagDisplayPoint", "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" } } } }, "/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" } } } }, "/reportingrest/reportDefinition" : { "get" : { "tags" : [ "reportingrest/reportDefinition" ], "summary" : "Fetch all non-retired reportingrest/reportDefinition resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllReportDefinitions", "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" : "reportingrest/reportDefinition response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/ReportingrestReportDefinitionGet" } } }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "reportingrest/reportDefinition" ], "summary" : "Create with properties in request", "operationId" : "createReportDefinition", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "resource", "description" : "Resource to create", "required" : true, "schema" : { "$ref" : "#/definitions/ReportingrestReportDefinitionCreate" } } ], "responses" : { "201" : { "description" : "reportingrest/reportDefinition response" }, "401" : { "description" : "User not logged in" } } } }, "/reportingrest/reportDefinition/{uuid}" : { "get" : { "tags" : [ "reportingrest/reportDefinition" ], "summary" : "Fetch by uuid", "operationId" : "getReportDefinition", "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" : "reportingrest/reportDefinition response", "schema" : { "$ref" : "#/definitions/ReportingrestReportDefinitionGet" } }, "404" : { "description" : "Resource with given uuid doesn't exist" }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "reportingrest/reportDefinition" ], "summary" : "Edit with given uuid, only modifying properties in request", "operationId" : "updateReportDefinition", "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/ReportingrestReportDefinitionUpdate" } } ], "responses" : { "201" : { "description" : "reportingrest/reportDefinition response" }, "401" : { "description" : "User not logged in" } } }, "delete" : { "tags" : [ "reportingrest/reportDefinition" ], "summary" : "Delete or purge resource by uuid", "description" : "The resource will be voided/retired unless purge = 'true'", "operationId" : "deleteReportDefinition", "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" } } } }, "/reportingrest/dataSetDefinition" : { "get" : { "tags" : [ "reportingrest/dataSetDefinition" ], "summary" : "Fetch all non-retired reportingrest/dataSetDefinition resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllDataSetDefinitions", "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" : "reportingrest/dataSetDefinition response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/ReportingrestDataSetDefinitionGet" } } }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "reportingrest/dataSetDefinition" ], "summary" : "Create with properties in request", "operationId" : "createDataSetDefinition", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "resource", "description" : "Resource to create", "required" : true, "schema" : { "$ref" : "#/definitions/ReportingrestDataSetDefinitionCreate" } } ], "responses" : { "201" : { "description" : "reportingrest/dataSetDefinition response" }, "401" : { "description" : "User not logged in" } } } }, "/reportingrest/dataSetDefinition/{uuid}" : { "get" : { "tags" : [ "reportingrest/dataSetDefinition" ], "summary" : "Fetch by uuid", "operationId" : "getDataSetDefinition", "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" : "reportingrest/dataSetDefinition response", "schema" : { "$ref" : "#/definitions/ReportingrestDataSetDefinitionGet" } }, "404" : { "description" : "Resource with given uuid doesn't exist" }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "reportingrest/dataSetDefinition" ], "summary" : "Edit with given uuid, only modifying properties in request", "operationId" : "updateDataSetDefinition", "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/ReportingrestDataSetDefinitionUpdate" } } ], "responses" : { "201" : { "description" : "reportingrest/dataSetDefinition response" }, "401" : { "description" : "User not logged in" } } }, "delete" : { "tags" : [ "reportingrest/dataSetDefinition" ], "summary" : "Delete or purge resource by uuid", "description" : "The resource will be voided/retired unless purge = 'true'", "operationId" : "deleteDataSetDefinition", "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" } } } }, "/billing/billLineItem" : { "get" : { "tags" : [ "billing/billLineItem" ], "summary" : "Fetch all non-retired billing/billLineItem resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllBillLineItems", "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" : "billing/billLineItem response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/BillingBillLineItemGet" } } }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "billing/billLineItem" ], "summary" : "Create with properties in request", "operationId" : "createBillLineItem", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "resource", "description" : "Resource to create", "required" : true, "schema" : { "$ref" : "#/definitions/BillingBillLineItemCreate" } } ], "responses" : { "201" : { "description" : "billing/billLineItem response" }, "401" : { "description" : "User not logged in" } } } }, "/billing/billLineItem/{uuid}" : { "get" : { "tags" : [ "billing/billLineItem" ], "summary" : "Fetch by uuid", "operationId" : "getBillLineItem", "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" : "billing/billLineItem response", "schema" : { "$ref" : "#/definitions/BillingBillLineItemGet" } }, "404" : { "description" : "Resource with given uuid doesn't exist" }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "billing/billLineItem" ], "summary" : "Edit with given uuid, only modifying properties in request", "operationId" : "updateBillLineItem", "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/BillingBillLineItemUpdate" } } ], "responses" : { "201" : { "description" : "billing/billLineItem response" }, "401" : { "description" : "User not logged in" } } }, "delete" : { "tags" : [ "billing/billLineItem" ], "summary" : "Delete or purge resource by uuid", "description" : "The resource will be voided/retired unless purge = 'true'", "operationId" : "deleteBillLineItem", "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" } } } }, "/stockmanagement/stockiteminventory" : { "get" : { "tags" : [ "stockmanagement/stockiteminventory" ], "summary" : "Fetch all non-retired stockmanagement/stockiteminventory resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllStockItemInventories", "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" : "stockmanagement/stockiteminventory response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/StockmanagementStockiteminventoryGet" } } }, "401" : { "description" : "User not logged in" } } } }, "/stockmanagement/orderitem" : { "get" : { "tags" : [ "stockmanagement/orderitem" ], "summary" : "Fetch all non-retired stockmanagement/orderitem resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllOrderItems", "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" : "stockmanagement/orderitem response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/StockmanagementOrderitemGet" } } }, "401" : { "description" : "User not logged in" } } } }, "/stockmanagement/orderitem/{uuid}" : { "get" : { "tags" : [ "stockmanagement/orderitem" ], "summary" : "Fetch by uuid", "operationId" : "getOrderItem", "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" : "stockmanagement/orderitem response", "schema" : { "$ref" : "#/definitions/StockmanagementOrderitemGet" } }, "404" : { "description" : "Resource with given uuid doesn't exist" }, "401" : { "description" : "User not logged in" } } }, "delete" : { "tags" : [ "stockmanagement/orderitem" ], "summary" : "Delete or purge resource by uuid", "description" : "The resource will be voided/retired unless purge = 'true'", "operationId" : "deleteOrderItem", "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" } } } }, "/stockmanagement/party" : { "get" : { "tags" : [ "stockmanagement/party" ], "summary" : "Fetch all non-retired stockmanagement/party resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllParties", "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" : "stockmanagement/party response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/StockmanagementPartyGet" } } }, "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" } } } }, "/cohortm/cohort" : { "get" : { "tags" : [ "cohortm/cohort" ], "summary" : "Fetch all non-retired cohortm/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" : "cohortm/cohort response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/CohortmCohortGet" } } }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "cohortm/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/CohortmCohortCreate" } } ], "responses" : { "201" : { "description" : "cohortm/cohort response" }, "401" : { "description" : "User not logged in" } } } }, "/cohortm/cohort/{uuid}" : { "get" : { "tags" : [ "cohortm/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" : "cohortm/cohort response", "schema" : { "$ref" : "#/definitions/CohortmCohortGet" } }, "404" : { "description" : "Resource with given uuid doesn't exist" }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "cohortm/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/CohortmCohortUpdate" } } ], "responses" : { "201" : { "description" : "cohortm/cohort response" }, "401" : { "description" : "User not logged in" } } }, "delete" : { "tags" : [ "cohortm/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" } } } }, "/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" } } } }, "/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" } } } }, "/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" } } } }, "/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" } } } } }, "/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" } } } }, "/stockmanagement/stockoperationtype" : { "get" : { "tags" : [ "stockmanagement/stockoperationtype" ], "summary" : "Fetch all non-retired stockmanagement/stockoperationtype resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllStockOperationTypes", "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" : "stockmanagement/stockoperationtype response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/StockmanagementStockoperationtypeGet" } } }, "401" : { "description" : "User not logged in" } } } }, "/stockmanagement/stockoperationtype/{uuid}" : { "get" : { "tags" : [ "stockmanagement/stockoperationtype" ], "summary" : "Fetch by uuid", "operationId" : "getStockOperationType", "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" : "stockmanagement/stockoperationtype response", "schema" : { "$ref" : "#/definitions/StockmanagementStockoperationtypeGet" } }, "404" : { "description" : "Resource with given uuid doesn't exist" }, "401" : { "description" : "User not logged in" } } }, "delete" : { "tags" : [ "stockmanagement/stockoperationtype" ], "summary" : "Delete or purge resource by uuid", "description" : "The resource will be voided/retired unless purge = 'true'", "operationId" : "deleteStockOperationType", "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" } } } }, "/stockmanagement/stockoperation" : { "get" : { "tags" : [ "stockmanagement/stockoperation" ], "summary" : "Fetch all non-retired stockmanagement/stockoperation resources or perform search", "description" : "All search parameters are optional", "operationId" : "getAllStockOperations", "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" : "stockmanagement/stockoperation response", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/StockmanagementStockoperationGet" } } }, "401" : { "description" : "User not logged in" } } }, "post" : { "tags" : [ "stockmanagement/stockoperation" ], "summary" : "Create with properties in request", "operationId" : "createStockOperation", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "resource", "description" : "Resource to create", "required" : true, "schema" : { "$ref" : "#/definitions/StockmanagementStockoperationCreate" } } ], "responses" : { "201" : { "description" : "stockmanagement/stockoperation response" }, "401" : { "description" : "User not logged in" } } } }, "/stockmanagement/stockoperation/{uuid}" : { "get" : { "tags" : [ "stockmanagement/stockoperation" ], "summary" : "Fetch by uuid", "operationId" : "getStockOperation", "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" : "stockmanagement/stockoperation response", "schema" : { "$ref" : "#/definitions/StockmanagementStockoperationGet" } }, "404" : { "description" : "Resource with given uuid doesn't exist" }, "401" : { "description" : "User not logged in" } } } } }, "securityDefinitions" : { "basic_auth" : { "type" : "basic" } }, "definitions" : { "LocationattributetypeGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "minOccurs" : { "type" : "integer", "format" : "int32" }, "maxOccurs" : { "type" : "integer", "format" : "int32" }, "datatypeClassname" : { "type" : "string" }, "preferredHandlerClassname" : { "type" : "string" } } }, "LocationattributetypeGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "LocationattributetypeGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "retired" : { "type" : "boolean" }, "minOccurs" : { "type" : "integer", "format" : "int32" }, "maxOccurs" : { "type" : "integer", "format" : "int32" }, "datatypeClassname" : { "type" : "string" }, "preferredHandlerClassname" : { "type" : "string" }, "datatypeConfig" : { "type" : "string" }, "handlerConfig" : { "type" : "string" } } }, "LocationattributetypeCreate" : { "required" : [ "datatypeClassname", "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "datatypeClassname" : { "type" : "string" }, "minOccurs" : { "type" : "integer", "format" : "int32" }, "maxOccurs" : { "type" : "integer", "format" : "int32" }, "datatypeConfig" : { "type" : "string" }, "preferredHandlerClassname" : { "type" : "string" }, "handlerConfig" : { "type" : "string" } } }, "LocationattributetypeCreateFull" : { "required" : [ "datatypeClassname", "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "datatypeClassname" : { "type" : "string" }, "minOccurs" : { "type" : "integer", "format" : "int32" }, "maxOccurs" : { "type" : "integer", "format" : "int32" }, "datatypeConfig" : { "type" : "string" }, "preferredHandlerClassname" : { "type" : "string" }, "handlerConfig" : { "type" : "string" } } }, "LocationattributetypeUpdate" : { "required" : [ "datatypeClassname", "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "datatypeClassname" : { "type" : "string" }, "minOccurs" : { "type" : "integer", "format" : "int32" }, "maxOccurs" : { "type" : "integer", "format" : "int32" }, "datatypeConfig" : { "type" : "string" }, "preferredHandlerClassname" : { "type" : "string" }, "handlerConfig" : { "type" : "string" } } }, "BillingBillGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "BillingBillGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "BillingBillGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "FieldtypeGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "isSet" : { "type" : "boolean", "default" : false } } }, "FieldtypeGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "FieldtypeGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "retired" : { "type" : "boolean" }, "isSet" : { "type" : "boolean", "default" : false } } }, "FieldtypeCreate" : { "required" : [ "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" } } }, "FieldtypeCreateFull" : { "required" : [ "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" } } }, "FieldtypeUpdate" : { }, "StockmanagementUserrolescopeGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "permanent" : { "type" : "boolean" }, "activeFrom" : { "type" : "string", "format" : "date-time" }, "activeTo" : { "type" : "string", "format" : "date-time" }, "enabled" : { "type" : "boolean" }, "locations" : { "type" : "array" }, "operationTypes" : { "type" : "array" } } }, "StockmanagementUserrolescopeGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" } } }, "StockmanagementUserrolescopeGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "permanent" : { "type" : "boolean" }, "activeFrom" : { "type" : "string", "format" : "date-time" }, "activeTo" : { "type" : "string", "format" : "date-time" }, "enabled" : { "type" : "boolean" }, "locations" : { "type" : "array" }, "operationTypes" : { "type" : "array" } } }, "MetadatamappingMetadatasetGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "MetadatamappingMetadatasetGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "MetadatamappingMetadatasetGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "retired" : { "type" : "boolean" } } }, "MetadatamappingMetadatasetCreate" : { "required" : [ "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" } } }, "MetadatamappingMetadatasetCreateFull" : { "required" : [ "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" } } }, "MetadatamappingMetadatasetUpdate" : { "required" : [ "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" } } }, "DrugGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "doseStrength" : { "type" : "number", "format" : "double" }, "maximumDailyDose" : { "type" : "number", "format" : "double" }, "minimumDailyDose" : { "type" : "number", "format" : "double" }, "units" : { "type" : "string" }, "combination" : { "type" : "boolean", "default" : false }, "dosageForm" : { "$ref" : "#/definitions/ConceptGetRef" }, "concept" : { "$ref" : "#/definitions/ConceptGetRef" }, "route" : { "$ref" : "#/definitions/ConceptGetRef" }, "drugReferenceMaps" : { "$ref" : "#/definitions/DrugreferencemapGetRef" } } }, "DrugGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "DrugGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "retired" : { "type" : "boolean" }, "doseStrength" : { "type" : "number", "format" : "double" }, "maximumDailyDose" : { "type" : "number", "format" : "double" }, "minimumDailyDose" : { "type" : "number", "format" : "double" }, "units" : { "type" : "string" }, "combination" : { "type" : "boolean", "default" : false }, "dosageForm" : { "$ref" : "#/definitions/ConceptGet" }, "concept" : { "$ref" : "#/definitions/ConceptGet" }, "route" : { "$ref" : "#/definitions/ConceptGet" }, "drugReferenceMaps" : { "$ref" : "#/definitions/DrugreferencemapGet" } } }, "DrugCreate" : { "properties" : { "drugReferenceMaps" : { "$ref" : "#/definitions/DrugreferencemapCreate" } } }, "DrugCreateFull" : { "properties" : { "drugReferenceMaps" : { "$ref" : "#/definitions/DrugreferencemapCreate" } } }, "DrugUpdate" : { "properties" : { "drugReferenceMaps" : { "$ref" : "#/definitions/DrugreferencemapCreate" } } }, "AdmissionLocationGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "ward" : { "type" : "string" }, "totalBeds" : { "type" : "string" }, "occupiedBeds" : { "type" : "string" } } }, "AdmissionLocationGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "AdmissionLocationGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "ward" : { "type" : "string" }, "totalBeds" : { "type" : "string" }, "occupiedBeds" : { "type" : "string" }, "bedLayouts" : { "type" : "string" } } }, "AdmissionLocationCreate" : { "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "parentLocationUuid" : { "type" : "string" } } }, "AdmissionLocationCreateFull" : { "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "parentLocationUuid" : { "type" : "string" } } }, "AdmissionLocationUpdate" : { "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "parentLocationUuid" : { "type" : "string" } } }, "StockmanagementStockitemreferenceGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "referenceCode" : { "type" : "string" }, "stockSourceUuid" : { "type" : "string" }, "stockSourceName" : { "type" : "string" }, "stockItemUuid" : { "type" : "string" } } }, "StockmanagementStockitemreferenceGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "referenceCode" : { "type" : "string" }, "stockSourceUuid" : { "type" : "string" }, "stockSourceName" : { "type" : "string" }, "stockItemUuid" : { "type" : "string" } } }, "StockmanagementStockitemreferenceGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "referenceCode" : { "type" : "string" }, "stockSourceUuid" : { "type" : "string" }, "stockSourceName" : { "type" : "string" }, "stockItemUuid" : { "type" : "string" } } }, "Queue-roomGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "Queue-roomGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "Queue-roomGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "ReportingrestCohortDefinitionGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "ReportingrestCohortDefinitionGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "ReportingrestCohortDefinitionGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "retired" : { "type" : "boolean" } } }, "ReportingrestCohortDefinitionCreate" : { "required" : [ "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" } } }, "ReportingrestCohortDefinitionCreateFull" : { "required" : [ "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" } } }, "ReportingrestCohortDefinitionUpdate" : { "required" : [ "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" } } }, "CustomdatatypeGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "datatypeClassname" : { "type" : "string" }, "handlers" : { "type" : "array", "items" : { "$ref" : "#/definitions/CustomdatatypeHandlersGetRef" } } } }, "CustomdatatypeGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "CustomdatatypeGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "datatypeClassname" : { "type" : "string" }, "handlers" : { "type" : "array", "items" : { "$ref" : "#/definitions/CustomdatatypeHandlersGet" } } } }, "IdgenIdentifiersourceGet" : { "properties" : { "uuid" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "identifierType" : { "$ref" : "#/definitions/PatientidentifiertypeGet" } } }, "IdgenIdentifiersourceGetRef" : { "properties" : { "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "IdgenIdentifiersourceGetFull" : { "properties" : { "uuid" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "identifierType" : { "$ref" : "#/definitions/PatientidentifiertypeGet" } } }, "IdgenIdentifiersourceCreate" : { "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "identifierType" : { "$ref" : "#/definitions/PatientidentifiertypeGet" } } }, "IdgenIdentifiersourceCreateFull" : { "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "identifierType" : { "$ref" : "#/definitions/PatientidentifiertypeGet" } } }, "IdgenIdentifiersourceUpdate" : { "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "identifierType" : { "$ref" : "#/definitions/PatientidentifiertypeGet" } } }, "VisitattributetypeGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "minOccurs" : { "type" : "integer", "format" : "int32" }, "maxOccurs" : { "type" : "integer", "format" : "int32" }, "datatypeClassname" : { "type" : "string" }, "preferredHandlerClassname" : { "type" : "string" } } }, "VisitattributetypeGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "VisitattributetypeGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "retired" : { "type" : "boolean" }, "minOccurs" : { "type" : "integer", "format" : "int32" }, "maxOccurs" : { "type" : "integer", "format" : "int32" }, "datatypeClassname" : { "type" : "string" }, "preferredHandlerClassname" : { "type" : "string" }, "datatypeConfig" : { "type" : "string" }, "handlerConfig" : { "type" : "string" } } }, "VisitattributetypeCreate" : { "required" : [ "datatypeClassname", "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "datatypeClassname" : { "type" : "string" }, "minOccurs" : { "type" : "integer", "format" : "int32" }, "maxOccurs" : { "type" : "integer", "format" : "int32" }, "datatypeConfig" : { "type" : "string" }, "preferredHandlerClassname" : { "type" : "string" }, "handlerConfig" : { "type" : "string" } } }, "VisitattributetypeCreateFull" : { "required" : [ "datatypeClassname", "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "datatypeClassname" : { "type" : "string" }, "minOccurs" : { "type" : "integer", "format" : "int32" }, "maxOccurs" : { "type" : "integer", "format" : "int32" }, "datatypeConfig" : { "type" : "string" }, "preferredHandlerClassname" : { "type" : "string" }, "handlerConfig" : { "type" : "string" } } }, "VisitattributetypeUpdate" : { "required" : [ "datatypeClassname", "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "datatypeClassname" : { "type" : "string" }, "minOccurs" : { "type" : "integer", "format" : "int32" }, "maxOccurs" : { "type" : "integer", "format" : "int32" }, "datatypeConfig" : { "type" : "string" }, "preferredHandlerClassname" : { "type" : "string" }, "handlerConfig" : { "type" : "string" } } }, "StockmanagementStockoperationactionlineitemGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "amount" : { "type" : "number" }, "packagingUoMUuId" : { "type" : "string" } } }, "StockmanagementStockoperationactionlineitemGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" } } }, "StockmanagementStockoperationactionlineitemGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "amount" : { "type" : "number" }, "packagingUoMUuId" : { "type" : "string" } } }, "CohortmCohorttypeGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "CohortmCohorttypeGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "CohortmCohorttypeGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "Queue-entryGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "Queue-entryGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "Queue-entryGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "ReportingrestReportdataGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "dataSets" : { "type" : "string" }, "context" : { "type" : "string" }, "definition" : { "type" : "string" } } }, "ReportingrestReportdataGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "ReportingrestReportdataGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "ReportingrestReportdataCreate" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "dataSets" : { "type" : "string" }, "context" : { "type" : "string" }, "definition" : { "type" : "string" } } }, "ReportingrestReportdataCreateFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "dataSets" : { "type" : "string" }, "context" : { "type" : "string" }, "definition" : { "type" : "string" } } }, "ReportingrestReportdataUpdate" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "dataSets" : { "type" : "string" }, "context" : { "type" : "string" }, "definition" : { "type" : "string" } } }, "UserGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "username" : { "type" : "string" }, "systemId" : { "type" : "string" }, "userProperties" : { "type" : "object" }, "person" : { "$ref" : "#/definitions/PersonGetRef" }, "privileges" : { "type" : "array", "items" : { "$ref" : "#/definitions/PrivilegeGetRef" } }, "roles" : { "type" : "array", "items" : { "$ref" : "#/definitions/RoleGetRef" } } } }, "UserGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "UserGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "retired" : { "type" : "boolean" }, "username" : { "type" : "string" }, "systemId" : { "type" : "string" }, "userProperties" : { "type" : "object" }, "person" : { "$ref" : "#/definitions/PersonGet" }, "privileges" : { "type" : "array", "items" : { "$ref" : "#/definitions/PrivilegeGet" } }, "roles" : { "type" : "array", "items" : { "$ref" : "#/definitions/RoleGet" } }, "allRoles" : { "type" : "array", "items" : { "$ref" : "#/definitions/RoleGet" } }, "proficientLocales" : { "type" : "array", "items" : { "type" : "object" } }, "secretQuestion" : { "type" : "string" } } }, "UserCreate" : { "required" : [ "name", "password", "person", "username" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "username" : { "type" : "string" }, "password" : { "type" : "string" }, "person" : { "$ref" : "#/definitions/PersonCreate" }, "systemId" : { "type" : "string" }, "userProperties" : { "type" : "object" }, "roles" : { "type" : "array", "items" : { "$ref" : "#/definitions/RoleCreate" } }, "proficientLocales" : { "type" : "array", "items" : { "type" : "object" } }, "secretQuestion" : { "type" : "string" } } }, "UserCreateFull" : { "required" : [ "name", "password", "person", "username" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "username" : { "type" : "string" }, "password" : { "type" : "string" }, "person" : { "$ref" : "#/definitions/PersonCreate" }, "systemId" : { "type" : "string" }, "userProperties" : { "type" : "object" }, "roles" : { "type" : "array", "items" : { "$ref" : "#/definitions/RoleCreate" } }, "proficientLocales" : { "type" : "array", "items" : { "type" : "object" } }, "secretQuestion" : { "type" : "string" } } }, "UserUpdate" : { "required" : [ "name", "password", "person", "username" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "username" : { "type" : "string" }, "password" : { "type" : "string" }, "person" : { "$ref" : "#/definitions/PersonCreate" }, "systemId" : { "type" : "string" }, "userProperties" : { "type" : "object" }, "roles" : { "type" : "array", "items" : { "$ref" : "#/definitions/RoleCreate" } }, "proficientLocales" : { "type" : "array", "items" : { "type" : "object" } }, "secretQuestion" : { "type" : "string" } } }, "BedsGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "BedsGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "BedsGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "StockmanagementStockoperationitemcostGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "stockItemUuid" : { "type" : "string" }, "stockItemPackagingUOMUuid" : { "type" : "string" }, "stockItemPackagingUOMName" : { "type" : "string" }, "stockBatchUuid" : { "type" : "string" }, "batchNo" : { "type" : "string" }, "quantity" : { "type" : "number" }, "unitCost" : { "type" : "number" }, "unitCostUOMUuid" : { "type" : "string" }, "unitCostUOMName" : { "type" : "string" }, "totalCost" : { "type" : "number" } } }, "StockmanagementStockoperationitemcostGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" } } }, "StockmanagementStockoperationitemcostGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "stockItemUuid" : { "type" : "string" }, "stockItemPackagingUOMUuid" : { "type" : "string" }, "stockItemPackagingUOMName" : { "type" : "string" }, "stockBatchUuid" : { "type" : "string" }, "batchNo" : { "type" : "string" }, "quantity" : { "type" : "number" }, "unitCost" : { "type" : "number" }, "unitCostUOMUuid" : { "type" : "string" }, "unitCostUOMName" : { "type" : "string" }, "totalCost" : { "type" : "number" } } }, "FormGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "version" : { "type" : "string" }, "build" : { "type" : "integer", "format" : "int32" }, "published" : { "type" : "boolean", "default" : false }, "retired" : { "type" : "boolean" }, "encounterType" : { "$ref" : "#/definitions/EncountertypeGetRef" }, "formFields" : { "type" : "array", "items" : { "$ref" : "#/definitions/FormFormfieldGetRef" } } } }, "FormGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "FormGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "retired" : { "type" : "boolean" }, "version" : { "type" : "string" }, "build" : { "type" : "integer", "format" : "int32" }, "published" : { "type" : "boolean", "default" : false }, "encounterType" : { "$ref" : "#/definitions/EncountertypeGet" }, "formFields" : { "type" : "array", "items" : { "$ref" : "#/definitions/FormFormfieldGet" } } } }, "FormCreate" : { "required" : [ "name", "version" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "version" : { "type" : "string" }, "encounterType" : { "type" : "string" }, "build" : { "type" : "integer", "format" : "int32" }, "published" : { "type" : "boolean", "default" : false }, "formFields" : { "type" : "array", "items" : { "type" : "string" } }, "xslt" : { "type" : "string" }, "template" : { "type" : "string" } } }, "FormCreateFull" : { "required" : [ "name", "version" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "version" : { "type" : "string" }, "encounterType" : { "$ref" : "#/definitions/EncountertypeCreate" }, "build" : { "type" : "integer", "format" : "int32" }, "published" : { "type" : "boolean", "default" : false }, "formFields" : { "type" : "array", "items" : { "$ref" : "#/definitions/FormFormfieldCreate" } }, "xslt" : { "type" : "string" }, "template" : { "type" : "string" } } }, "FormUpdate" : { "required" : [ "name", "version" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "version" : { "type" : "string" }, "encounterType" : { "type" : "string" }, "build" : { "type" : "integer", "format" : "int32" }, "published" : { "type" : "boolean", "default" : false }, "formFields" : { "type" : "array", "items" : { "type" : "string" } }, "xslt" : { "type" : "string" }, "template" : { "type" : "string" } } }, "PatientidentifiertypeGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "format" : { "type" : "string" }, "formatDescription" : { "type" : "string" }, "required" : { "type" : "boolean" }, "checkDigit" : { "type" : "boolean" }, "validator" : { "type" : "string" }, "locationBehavior" : { "type" : "string", "enum" : [ "REQUIRED", "NOT_USED" ] }, "uniquenessBehavior" : { "type" : "string" } } }, "PatientidentifiertypeGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "PatientidentifiertypeGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "retired" : { "type" : "boolean" }, "format" : { "type" : "string" }, "formatDescription" : { "type" : "string" }, "required" : { "type" : "boolean" }, "checkDigit" : { "type" : "boolean" }, "validator" : { "type" : "string" }, "locationBehavior" : { "type" : "string", "enum" : [ "REQUIRED", "NOT_USED" ] }, "uniquenessBehavior" : { "type" : "string" } } }, "PatientidentifiertypeCreate" : { "required" : [ "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "format" : { "type" : "string" }, "formatDescription" : { "type" : "string" }, "required" : { "type" : "boolean" }, "checkDigit" : { "type" : "boolean" }, "validator" : { "type" : "string" }, "locationBehavior" : { "type" : "string", "enum" : [ "REQUIRED", "NOT_USED" ] }, "uniquenessBehavior" : { "type" : "string" } } }, "PatientidentifiertypeCreateFull" : { "required" : [ "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "format" : { "type" : "string" }, "formatDescription" : { "type" : "string" }, "required" : { "type" : "boolean" }, "checkDigit" : { "type" : "boolean" }, "validator" : { "type" : "string" }, "locationBehavior" : { "type" : "string", "enum" : [ "REQUIRED", "NOT_USED" ] }, "uniquenessBehavior" : { "type" : "string" } } }, "PatientidentifiertypeUpdate" : { "required" : [ "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "format" : { "type" : "string" }, "formatDescription" : { "type" : "string" }, "required" : { "type" : "boolean" }, "checkDigit" : { "type" : "boolean" }, "validator" : { "type" : "string" }, "locationBehavior" : { "type" : "string", "enum" : [ "REQUIRED", "NOT_USED" ] }, "uniquenessBehavior" : { "type" : "string" } } }, "DrugreferencemapGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "display" : { "type" : "string" }, "uuid" : { "type" : "string" }, "drug" : { "$ref" : "#/definitions/DrugGetRef" }, "conceptReferenceTerm" : { "$ref" : "#/definitions/ConceptreferencetermGetRef" }, "conceptMapType" : { "$ref" : "#/definitions/ConceptmaptypeGetRef" } } }, "DrugreferencemapGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "DrugreferencemapGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "display" : { "type" : "string" }, "uuid" : { "type" : "string" }, "drug" : { "$ref" : "#/definitions/DrugGet" }, "conceptReferenceTerm" : { "$ref" : "#/definitions/ConceptreferencetermGet" }, "conceptMapType" : { "$ref" : "#/definitions/ConceptmaptypeGet" } } }, "DrugreferencemapCreate" : { "properties" : { "conceptReferenceTerm" : { "type" : "string", "example" : "uuid" }, "conceptMapType" : { "type" : "string", "example" : "uuid" }, "drug" : { "type" : "string", "example" : "uuid" } } }, "DrugreferencemapCreateFull" : { "properties" : { "conceptReferenceTerm" : { "type" : "string", "example" : "uuid" }, "conceptMapType" : { "type" : "string", "example" : "uuid" }, "drug" : { "type" : "string", "example" : "uuid" } } }, "DrugreferencemapUpdate" : { "properties" : { "conceptReferenceTerm" : { "type" : "string", "example" : "uuid" }, "conceptMapType" : { "type" : "string", "example" : "uuid" }, "drug" : { "type" : "string", "example" : "uuid" } } }, "Hl7Get" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "messageState" : { "type" : "integer", "format" : "int32" } } }, "Hl7GetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "Hl7GetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "source" : { "$ref" : "#/definitions/Hl7sourceGet" }, "sourceKey" : { "type" : "string" }, "data" : { "type" : "string" }, "messageState" : { "type" : "integer", "format" : "int32" } } }, "Hl7Create" : { "required" : [ "hl7" ], "properties" : { "hl7" : { "type" : "string" } } }, "Hl7CreateFull" : { "required" : [ "hl7" ], "properties" : { "hl7" : { "type" : "string" } } }, "ConditionGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "condition" : { "type" : "string" }, "patient" : { "$ref" : "#/definitions/PatientGetRef" }, "clinicalStatus" : { "type" : "string" }, "verificationStatus" : { "type" : "string" }, "previousVersion" : { "type" : "string" }, "onsetDate" : { "type" : "string" }, "endDate" : { "type" : "string" }, "additionalDetail" : { "type" : "string" }, "voided" : { "type" : "string" } } }, "ConditionGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "ConditionGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "condition" : { "type" : "string" }, "patient" : { "$ref" : "#/definitions/PatientGetRef" }, "clinicalStatus" : { "type" : "string" }, "verificationStatus" : { "type" : "string" }, "previousVersion" : { "type" : "string" }, "onsetDate" : { "type" : "string" }, "endDate" : { "type" : "string" }, "additionalDetail" : { "type" : "string" }, "voided" : { "type" : "string" } } }, "ConditionCreate" : { "properties" : { "condition" : { "type" : "string" }, "patient" : { "type" : "string", "example" : "uuid" }, "clinicalStatus" : { "type" : "string" }, "verificationStatus" : { "type" : "string" }, "previousVersion" : { "type" : "string" }, "onsetDate" : { "type" : "string" }, "endDate" : { "type" : "string" }, "additionalDetail" : { "type" : "string" } } }, "ConditionCreateFull" : { "properties" : { "condition" : { "type" : "string" }, "patient" : { "type" : "string", "example" : "uuid" }, "clinicalStatus" : { "type" : "string" }, "verificationStatus" : { "type" : "string" }, "previousVersion" : { "type" : "string" }, "onsetDate" : { "type" : "string" }, "endDate" : { "type" : "string" }, "additionalDetail" : { "type" : "string" } } }, "ConditionUpdate" : { "properties" : { "condition" : { "type" : "string" }, "clinicalStatus" : { "type" : "string" }, "verificationStatus" : { "type" : "string" }, "previousVersion" : { "type" : "string" }, "onsetDate" : { "type" : "string" }, "endDate" : { "type" : "string" }, "additionalDetail" : { "type" : "string" }, "voided" : { "type" : "string" } } }, "PatientflagsPatientflagGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "PatientflagsPatientflagGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "PatientflagsPatientflagGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "AttachmentGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "dateTime" : { "type" : "string", "format" : "date" }, "filename" : { "type" : "string" }, "comment" : { "type" : "string" }, "bytesMimeType" : { "type" : "string" }, "bytesContentFamily" : { "type" : "string", "enum" : [ "IMAGE", "PDF", "OTHER" ] } } }, "AttachmentGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "dateTime" : { "type" : "string", "format" : "date" }, "filename" : { "type" : "string" }, "comment" : { "type" : "string" }, "bytesMimeType" : { "type" : "string" }, "bytesContentFamily" : { "type" : "string", "enum" : [ "IMAGE", "PDF", "OTHER" ] } } }, "AttachmentGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "dateTime" : { "type" : "string", "format" : "date" }, "filename" : { "type" : "string" }, "comment" : { "type" : "string" }, "bytesMimeType" : { "type" : "string" }, "bytesContentFamily" : { "type" : "string", "enum" : [ "IMAGE", "PDF", "OTHER" ] } } }, "AttachmentCreate" : { "properties" : { "comment" : { "type" : "string" }, "dateTime" : { "type" : "string", "format" : "date" }, "filename" : { "type" : "string" }, "bytesMimeType" : { "type" : "string" }, "bytesContentFamily" : { "type" : "string", "enum" : [ "IMAGE", "PDF", "OTHER" ] }, "complexData" : { "type" : "string", "format" : "uri" } } }, "AttachmentCreateFull" : { "properties" : { "comment" : { "type" : "string" }, "dateTime" : { "type" : "string", "format" : "date" }, "filename" : { "type" : "string" }, "bytesMimeType" : { "type" : "string" }, "bytesContentFamily" : { "type" : "string", "enum" : [ "IMAGE", "PDF", "OTHER" ] }, "complexData" : { "type" : "string", "format" : "uri" } } }, "AttachmentUpdate" : { "properties" : { "comment" : { "type" : "string" }, "dateTime" : { "type" : "string", "format" : "date" }, "filename" : { "type" : "string" }, "bytesMimeType" : { "type" : "string" }, "bytesContentFamily" : { "type" : "string", "enum" : [ "IMAGE", "PDF", "OTHER" ] }, "complexData" : { "type" : "string", "format" : "uri" } } }, "ServerlogGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "ServerlogGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "ServerlogGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "ConceptreferencetermGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string", "format" : "uuid" }, "display" : { "type" : "string" }, "conceptSource" : { "$ref" : "#/definitions/ConceptsourceGetRef" }, "code" : { "type" : "string" }, "version" : { "type" : "string" } } }, "ConceptreferencetermGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "ConceptreferencetermGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string", "format" : "uuid" }, "display" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "retired" : { "type" : "boolean" }, "conceptSource" : { "$ref" : "#/definitions/ConceptsourceGetFull" }, "code" : { "type" : "string" }, "version" : { "type" : "string" } } }, "ConceptreferencetermCreate" : { "required" : [ "code", "conceptSource", "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "code" : { "type" : "string" }, "conceptSource" : { "$ref" : "#/definitions/ConceptsourceCreate" }, "version" : { "type" : "string" } } }, "ConceptreferencetermCreateFull" : { "required" : [ "code", "conceptSource", "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "code" : { "type" : "string" }, "conceptSource" : { "$ref" : "#/definitions/ConceptsourceCreate" }, "version" : { "type" : "string" } } }, "ConceptreferencetermUpdate" : { }, "CohortGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "voided" : { "type" : "string" }, "size" : { "type" : "integer", "format" : "int32" } } }, "CohortGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "size" : { "type" : "integer", "format" : "int32" } } }, "CohortGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "voided" : { "type" : "string" }, "size" : { "type" : "integer", "format" : "int32" } } }, "CohortCreate" : { "required" : [ "description", "memberIds", "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "memberIds" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } } } }, "CohortCreateFull" : { "required" : [ "description", "memberIds", "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "memberIds" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } } } }, "CohortUpdate" : { "required" : [ "description", "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" } } }, "StockmanagementStocksourceGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "name" : { "type" : "string" }, "acronym" : { "type" : "string" }, "sourceType" : { "$ref" : "#/definitions/ConceptGetRef" } } }, "StockmanagementStocksourceGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "name" : { "type" : "string" } } }, "StockmanagementStocksourceGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "name" : { "type" : "string" }, "acronym" : { "type" : "string" }, "sourceType" : { "$ref" : "#/definitions/ConceptGet" } } }, "EncounterroleGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "EncounterroleGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "EncounterroleGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "retired" : { "type" : "boolean" } } }, "EncounterroleCreate" : { "required" : [ "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" } } }, "EncounterroleCreateFull" : { "required" : [ "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" } } }, "EncounterroleUpdate" : { "required" : [ "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" } } }, "IdgenAutogenerationoptionGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "identifierType" : { "$ref" : "#/definitions/PatientidentifiertypeGet" }, "location" : { "$ref" : "#/definitions/LocationGet" }, "source" : { "$ref" : "#/definitions/IdgenIdentifiersourceGet" }, "manualEntryEnabled" : { "type" : "boolean" }, "automaticGenerationEnabled" : { "type" : "boolean" }, "full" : { "type" : "string" } } }, "IdgenAutogenerationoptionGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "IdgenAutogenerationoptionGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "retired" : { "type" : "boolean" }, "identifierType" : { "$ref" : "#/definitions/PatientidentifiertypeGet" }, "location" : { "$ref" : "#/definitions/LocationGet" }, "source" : { "$ref" : "#/definitions/IdgenIdentifiersourceGet" }, "manualEntryEnabled" : { "type" : "boolean" }, "automaticGenerationEnabled" : { "type" : "boolean" } } }, "IdgenAutogenerationoptionCreate" : { "properties" : { "identifierType" : { "$ref" : "#/definitions/PatientidentifiertypeGet" }, "location" : { "$ref" : "#/definitions/LocationGet" }, "source" : { "$ref" : "#/definitions/IdgenIdentifiersourceGet" }, "manualEntryEnabled" : { "type" : "boolean" }, "automaticGenerationEnabled" : { "type" : "boolean" } } }, "IdgenAutogenerationoptionCreateFull" : { "properties" : { "identifierType" : { "$ref" : "#/definitions/PatientidentifiertypeGet" }, "location" : { "$ref" : "#/definitions/LocationGet" }, "source" : { "$ref" : "#/definitions/IdgenIdentifiersourceGet" }, "manualEntryEnabled" : { "type" : "boolean" }, "automaticGenerationEnabled" : { "type" : "boolean" } } }, "IdgenAutogenerationoptionUpdate" : { "properties" : { "location" : { "$ref" : "#/definitions/LocationGet" }, "source" : { "$ref" : "#/definitions/IdgenIdentifiersourceGet" }, "manualEntryEnabled" : { "type" : "boolean" }, "automaticGenerationEnabled" : { "type" : "boolean" } } }, "TaskdefinitionGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "TaskdefinitionGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "TaskdefinitionGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "retired" : { "type" : "boolean" } } }, "TaskdefinitionCreate" : { "required" : [ "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" } } }, "TaskdefinitionCreateFull" : { "required" : [ "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" } } }, "TaskdefinitionUpdate" : { "required" : [ "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" } } }, "AdministrationlinksGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "title" : { "type" : "string" }, "administrationLinks" : { "type" : "array", "items" : { "type" : "object" } } } }, "AdministrationlinksGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "AdministrationlinksGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "title" : { "type" : "string" }, "administrationLinks" : { "type" : "array", "items" : { "type" : "object" } } } }, "StockmanagementPrivilegescopeGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "privilege" : { "type" : "string" }, "operationTypeUuid" : { "type" : "string" }, "locationUuid" : { "type" : "string" }, "partyUuid" : { "type" : "string" }, "isPermanent" : { "type" : "boolean" }, "activeFrom" : { "type" : "string", "format" : "date" }, "activeTo" : { "type" : "string", "format" : "date" } } }, "StockmanagementPrivilegescopeGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "StockmanagementPrivilegescopeGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "privilege" : { "type" : "string" }, "operationTypeUuid" : { "type" : "string" }, "locationUuid" : { "type" : "string" }, "partyUuid" : { "type" : "string" }, "isPermanent" : { "type" : "boolean" }, "activeFrom" : { "type" : "string", "format" : "date" }, "activeTo" : { "type" : "string", "format" : "date" } } }, "Hl7sourceGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "Hl7sourceGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "Hl7sourceGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "retired" : { "type" : "boolean" } } }, "Hl7sourceCreate" : { "required" : [ "description", "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" } } }, "Hl7sourceCreateFull" : { "required" : [ "description", "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" } } }, "Hl7sourceUpdate" : { "required" : [ "description", "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" } } }, "IdgenNextIdentifierGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "IdgenNextIdentifierGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "IdgenNextIdentifierGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "PersonGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "gender" : { "type" : "string", "enum" : [ "M", "F" ] }, "age" : { "type" : "integer", "format" : "int32" }, "birthdate" : { "type" : "string", "format" : "date-time" }, "birthdateEstimated" : { "type" : "boolean" }, "dead" : { "type" : "boolean" }, "deathDate" : { "type" : "string", "format" : "date" }, "causeOfDeath" : { "type" : "string" }, "attributes" : { "type" : "array", "items" : { "$ref" : "#/definitions/PersonAttributeGetRef" } }, "voided" : { "type" : "boolean" }, "preferredName" : { "$ref" : "#/definitions/PersonNameGetRef" }, "preferredAddress" : { "$ref" : "#/definitions/PersonAddressGetRef" }, "deathdateEstimated" : { "type" : "boolean", "default" : false } } }, "PersonGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "PersonGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "gender" : { "type" : "string", "enum" : [ "M", "F" ] }, "age" : { "type" : "integer", "format" : "int32" }, "birthdate" : { "type" : "string", "format" : "date-time" }, "birthdateEstimated" : { "type" : "boolean" }, "dead" : { "type" : "boolean" }, "deathDate" : { "type" : "string", "format" : "date" }, "causeOfDeath" : { "type" : "string" }, "attributes" : { "type" : "array", "items" : { "$ref" : "#/definitions/PersonAttributeGetRef" } }, "voided" : { "type" : "boolean" }, "preferredName" : { "$ref" : "#/definitions/PersonNameGet" }, "preferredAddress" : { "$ref" : "#/definitions/PersonAddressGet" }, "names" : { "type" : "array", "items" : { "$ref" : "#/definitions/PersonNameGet" } }, "addresses" : { "type" : "array", "items" : { "$ref" : "#/definitions/PersonAddressGet" } }, "deathdateEstimated" : { "type" : "boolean", "default" : false } } }, "PersonCreate" : { "required" : [ "gender", "names" ], "properties" : { "names" : { "type" : "array", "items" : { "$ref" : "#/definitions/PersonNameCreate" } }, "gender" : { "type" : "string", "enum" : [ "M", "F" ] }, "age" : { "type" : "integer", "format" : "int32" }, "birthdate" : { "type" : "string", "format" : "date" }, "birthdateEstimated" : { "type" : "boolean", "default" : false }, "dead" : { "type" : "boolean", "default" : false }, "deathDate" : { "type" : "string", "format" : "date" }, "causeOfDeath" : { "type" : "string" }, "addresses" : { "type" : "array", "items" : { "$ref" : "#/definitions/PersonAddressCreate" } }, "attributes" : { "type" : "array", "items" : { "$ref" : "#/definitions/PersonAttributeCreate" } }, "deathdateEstimated" : { "type" : "boolean", "default" : false } } }, "PersonCreateFull" : { "required" : [ "gender", "names" ], "properties" : { "names" : { "type" : "array", "items" : { "$ref" : "#/definitions/PersonNameCreate" } }, "gender" : { "type" : "string", "enum" : [ "M", "F" ] }, "age" : { "type" : "integer", "format" : "int32" }, "birthdate" : { "type" : "string", "format" : "date" }, "birthdateEstimated" : { "type" : "boolean", "default" : false }, "dead" : { "type" : "boolean", "default" : false }, "deathDate" : { "type" : "string", "format" : "date" }, "causeOfDeath" : { "type" : "string" }, "addresses" : { "type" : "array", "items" : { "$ref" : "#/definitions/PersonAddressCreate" } }, "attributes" : { "type" : "array", "items" : { "$ref" : "#/definitions/PersonAttributeCreate" } }, "deathdateEstimated" : { "type" : "boolean", "default" : false } } }, "PersonUpdate" : { "required" : [ "causeOfDeath", "dead" ], "properties" : { "dead" : { "type" : "boolean" }, "causeOfDeath" : { "type" : "string" }, "deathDate" : { "type" : "string", "format" : "date" }, "age" : { "type" : "integer", "format" : "int32" }, "gender" : { "type" : "string", "enum" : [ "M", "F" ] }, "birthdate" : { "type" : "string", "format" : "date" }, "birthdateEstimated" : { "type" : "boolean", "default" : false }, "preferredName" : { "type" : "string", "example" : "uuid" }, "preferredAddress" : { "type" : "string", "example" : "uuid" }, "attributes" : { "type" : "array", "items" : { "$ref" : "#/definitions/PersonAttributeCreate" } }, "deathdateEstimated" : { "type" : "boolean", "default" : false } } }, "BedtypeGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "name" : { "type" : "string" }, "displayName" : { "type" : "string" }, "description" : { "type" : "string" } } }, "BedtypeGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "name" : { "type" : "string" }, "displayName" : { "type" : "string" }, "description" : { "type" : "string" } } }, "BedtypeGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "name" : { "type" : "string" }, "displayName" : { "type" : "string" }, "description" : { "type" : "string" } } }, "BedtypeCreate" : { "properties" : { "name" : { "type" : "string" }, "displayName" : { "type" : "string" }, "description" : { "type" : "string" } } }, "BedtypeCreateFull" : { "properties" : { "name" : { "type" : "string" }, "displayName" : { "type" : "string" }, "description" : { "type" : "string" } } }, "BedtypeUpdate" : { "properties" : { "name" : { "type" : "string" }, "displayName" : { "type" : "string" }, "description" : { "type" : "string" } } }, "BillingPaymentAttributeGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "BillingPaymentAttributeGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "BillingPaymentAttributeGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "CaresettingGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "careSettingType" : { "type" : "string", "enum" : [ "OUTPATIENT", "INPATIENT" ] } } }, "CaresettingGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "CaresettingGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "retired" : { "type" : "boolean" }, "careSettingType" : { "type" : "string", "enum" : [ "OUTPATIENT", "INPATIENT" ] } } }, "FieldGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "tableName" : { "type" : "string" }, "attributeName" : { "type" : "string" }, "defaultValue" : { "type" : "string" }, "selectMultiple" : { "type" : "boolean", "default" : false }, "fieldType" : { "$ref" : "#/definitions/FieldtypeGetRef" }, "concept" : { "$ref" : "#/definitions/ConceptGetRef" } } }, "FieldGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "FieldGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "retired" : { "type" : "boolean" }, "tableName" : { "type" : "string" }, "attributeName" : { "type" : "string" }, "defaultValue" : { "type" : "string" }, "selectMultiple" : { "type" : "boolean", "default" : false }, "fieldType" : { "$ref" : "#/definitions/FieldtypeGet" }, "concept" : { "$ref" : "#/definitions/ConceptGet" } } }, "FieldCreate" : { "required" : [ "fieldType", "name", "selectMultiple" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "fieldType" : { "$ref" : "#/definitions/FieldtypeCreate" }, "selectMultiple" : { "type" : "boolean", "default" : false }, "concept" : { "$ref" : "#/definitions/ConceptCreate" }, "tableName" : { "type" : "string" }, "attributeName" : { "type" : "string" }, "defaultValue" : { "type" : "string" } } }, "FieldCreateFull" : { "required" : [ "fieldType", "name", "selectMultiple" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "fieldType" : { "$ref" : "#/definitions/FieldtypeCreate" }, "selectMultiple" : { "type" : "boolean", "default" : false }, "concept" : { "$ref" : "#/definitions/ConceptCreate" }, "tableName" : { "type" : "string" }, "attributeName" : { "type" : "string" }, "defaultValue" : { "type" : "string" } } }, "FieldUpdate" : { }, "StockmanagementStockitemtransactionGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "dateCreated" : { "type" : "string", "format" : "date-time" }, "partyUuid" : { "type" : "string" }, "partyName" : { "type" : "string" }, "isPatientTransaction" : { "type" : "boolean" }, "quantity" : { "type" : "number" }, "stockBatchUuid" : { "type" : "string" }, "stockBatchNo" : { "type" : "string" }, "expiration" : { "type" : "string" }, "stockItemUuid" : { "type" : "string" }, "stockOperationUuid" : { "type" : "string" }, "stockOperationStatus" : { "type" : "string" }, "stockOperationNumber" : { "type" : "string" }, "stockOperationTypeName" : { "type" : "string" }, "stockItemPackagingUOMUuid" : { "type" : "string" }, "packagingUomName" : { "type" : "string" }, "packagingUomFactor" : { "type" : "number" }, "operationSourcePartyName" : { "type" : "string" }, "operationDestinationPartyName" : { "type" : "string" } } }, "StockmanagementStockitemtransactionGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" } } }, "StockmanagementStockitemtransactionGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "dateCreated" : { "type" : "string", "format" : "date-time" }, "partyUuid" : { "type" : "string" }, "partyName" : { "type" : "string" }, "isPatientTransaction" : { "type" : "boolean" }, "quantity" : { "type" : "number" }, "stockBatchUuid" : { "type" : "string" }, "stockBatchNo" : { "type" : "string" }, "expiration" : { "type" : "string" }, "stockItemUuid" : { "type" : "string" }, "stockOperationUuid" : { "type" : "string" }, "stockOperationStatus" : { "type" : "string" }, "stockOperationNumber" : { "type" : "string" }, "stockOperationTypeName" : { "type" : "string" }, "stockItemPackagingUOMUuid" : { "type" : "string" }, "packagingUomName" : { "type" : "string" }, "packagingUomFactor" : { "type" : "number" }, "operationSourcePartyName" : { "type" : "string" }, "operationDestinationPartyName" : { "type" : "string" } } }, "MetadatamappingSourceGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "MetadatamappingSourceGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "MetadatamappingSourceGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "retired" : { "type" : "boolean" } } }, "MetadatamappingSourceCreate" : { "required" : [ "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" } } }, "MetadatamappingSourceCreateFull" : { "required" : [ "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" } } }, "MetadatamappingSourceUpdate" : { "required" : [ "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" } } }, "LocationtagGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "LocationtagGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "LocationtagGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "retired" : { "type" : "boolean" } } }, "LocationtagCreate" : { "required" : [ "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "retired" : { "type" : "boolean" }, "retiredReason" : { "type" : "string" } } }, "LocationtagCreateFull" : { "required" : [ "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "retired" : { "type" : "boolean" }, "retiredReason" : { "type" : "string" } } }, "LocationtagUpdate" : { "required" : [ "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "retired" : { "type" : "boolean" }, "retiredReason" : { "type" : "string" } } }, "VisitGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "startDatetime" : { "type" : "string", "format" : "date" }, "stopDatetime" : { "type" : "string", "format" : "date" }, "attributes" : { "type" : "array", "items" : { "type" : "string" } }, "voided" : { "type" : "boolean" }, "patient" : { "$ref" : "#/definitions/PatientGetRef" }, "visitType" : { "$ref" : "#/definitions/VisittypeGetRef" }, "indication" : { "$ref" : "#/definitions/ConceptGetRef" }, "location" : { "$ref" : "#/definitions/LocationGetRef" }, "encounters" : { "type" : "array", "items" : { "$ref" : "#/definitions/EncounterGetRef" } } } }, "VisitGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "VisitGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "startDatetime" : { "type" : "string", "format" : "date" }, "stopDatetime" : { "type" : "string", "format" : "date" }, "attributes" : { "type" : "array", "items" : { "type" : "string" } }, "voided" : { "type" : "boolean" }, "patient" : { "$ref" : "#/definitions/PatientGet" }, "visitType" : { "$ref" : "#/definitions/VisittypeGet" }, "indication" : { "$ref" : "#/definitions/ConceptGet" }, "location" : { "$ref" : "#/definitions/LocationGet" }, "encounters" : { "type" : "array", "items" : { "$ref" : "#/definitions/EncounterGet" } } } }, "VisitCreate" : { "required" : [ "patient", "visitType" ], "properties" : { "patient" : { "type" : "string", "example" : "uuid" }, "visitType" : { "type" : "string", "example" : "uuid" }, "startDatetime" : { "type" : "string", "format" : "date" }, "location" : { "type" : "string", "example" : "uuid" }, "indication" : { "type" : "string" }, "stopDatetime" : { "type" : "string", "format" : "date" }, "encounters" : { "type" : "array", "items" : { "type" : "string", "example" : "uuid" } }, "attributes" : { "type" : "array", "items" : { "$ref" : "#/definitions/VisitAttributeCreate" } } } }, "VisitCreateFull" : { "required" : [ "patient", "visitType" ], "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" } } } }, "VisitUpdate" : { "properties" : { "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" : { "type" : "string" } } } }, "PatientflagsPriorityGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "PatientflagsPriorityGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "PatientflagsPriorityGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "retired" : { "type" : "boolean" } } }, "PatientflagsPriorityCreate" : { "required" : [ "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" } } }, "PatientflagsPriorityCreateFull" : { "required" : [ "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" } } }, "PatientflagsPriorityUpdate" : { "required" : [ "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" } } }, "BillingAttributetypeGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "BillingAttributetypeGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "BillingAttributetypeGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "retired" : { "type" : "boolean" } } }, "BillingAttributetypeCreate" : { "required" : [ "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" } } }, "BillingAttributetypeCreateFull" : { "required" : [ "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" } } }, "BillingAttributetypeUpdate" : { "required" : [ "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" } } }, "IdgenLogentryGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "name" : { "type" : "string" }, "identifier" : { "type" : "string" }, "comment" : { "type" : "string" }, "generatedBy" : { "$ref" : "#/definitions/UserGet" }, "dateGenerated" : { "type" : "string", "format" : "date" }, "description" : { "type" : "string" }, "full" : { "type" : "string" } } }, "IdgenLogentryGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "identifier" : { "type" : "string" }, "name" : { "type" : "string" }, "comment" : { "type" : "string" }, "generatedBy" : { "$ref" : "#/definitions/UserGet" }, "dateGenerated" : { "type" : "string", "format" : "date" }, "description" : { "type" : "string" } } }, "IdgenLogentryGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "retired" : { "type" : "boolean" } } }, "ObsGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "obsDatetime" : { "type" : "string", "format" : "date" }, "accessionNumber" : { "type" : "string" }, "comment" : { "type" : "string" }, "voided" : { "type" : "boolean" }, "value" : { "type" : "string" }, "valueModifier" : { "type" : "string" }, "concept" : { "$ref" : "#/definitions/ConceptGetRef" }, "person" : { "$ref" : "#/definitions/PersonGetRef" }, "obsGroup" : { "$ref" : "#/definitions/ObsGetRef" }, "groupMembers" : { "type" : "array", "items" : { "$ref" : "#/definitions/ObsGetRef" } }, "valueCodedName" : { "$ref" : "#/definitions/ConceptNameGetRef" }, "location" : { "$ref" : "#/definitions/LocationGetRef" }, "order" : { "$ref" : "#/definitions/OrderGetRef" }, "encounter" : { "$ref" : "#/definitions/EncounterGetRef" }, "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" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "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" ] } } }, "ObsGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "obsDatetime" : { "type" : "string", "format" : "date" }, "accessionNumber" : { "type" : "string" }, "comment" : { "type" : "string" }, "voided" : { "type" : "boolean" }, "value" : { "type" : "string" }, "valueModifier" : { "type" : "string" }, "concept" : { "$ref" : "#/definitions/ConceptGet" }, "person" : { "$ref" : "#/definitions/PersonGet" }, "obsGroup" : { "$ref" : "#/definitions/ObsGet" }, "groupMembers" : { "type" : "array", "items" : { "$ref" : "#/definitions/ObsGet" } }, "valueCodedName" : { "$ref" : "#/definitions/ConceptNameGet" }, "location" : { "$ref" : "#/definitions/LocationGet" }, "order" : { "$ref" : "#/definitions/OrderGet" }, "encounter" : { "$ref" : "#/definitions/EncounterGet" }, "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" : { "required" : [ "concept", "obsDatetime", "person" ], "properties" : { "person" : { "type" : "string", "example" : "uuid" }, "obsDatetime" : { "type" : "string", "format" : "date-time" }, "concept" : { "type" : "string", "example" : "uuid" }, "location" : { "type" : "string" }, "order" : { "type" : "string" }, "encounter" : { "type" : "string" }, "accessionNumber" : { "type" : "string" }, "groupMembers" : { "type" : "array", "items" : { "type" : "string" } }, "valueCodedName" : { "type" : "string" }, "comment" : { "type" : "string" }, "voided" : { "type" : "boolean" }, "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" : { "required" : [ "concept", "obsDatetime", "person" ], "properties" : { "person" : { "type" : "string", "example" : "uuid" }, "obsDatetime" : { "type" : "string", "format" : "date-time" }, "concept" : { "type" : "string", "example" : "uuid" }, "location" : { "type" : "string" }, "order" : { "type" : "string" }, "encounter" : { "type" : "string" }, "accessionNumber" : { "type" : "string" }, "groupMembers" : { "type" : "array", "items" : { "type" : "string" } }, "valueCodedName" : { "type" : "string" }, "comment" : { "type" : "string" }, "voided" : { "type" : "boolean" }, "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" : { "required" : [ "concept", "obsDatetime", "person" ], "properties" : { "person" : { "type" : "string", "example" : "uuid" }, "obsDatetime" : { "type" : "string", "format" : "date-time" }, "concept" : { "type" : "string", "example" : "uuid" }, "location" : { "type" : "string" }, "order" : { "type" : "string" }, "encounter" : { "type" : "string" }, "accessionNumber" : { "type" : "string" }, "groupMembers" : { "type" : "array", "items" : { "type" : "string" } }, "valueCodedName" : { "type" : "string" }, "comment" : { "type" : "string" }, "voided" : { "type" : "boolean" }, "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" ] } } }, "BedGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "id" : { "type" : "integer", "format" : "int32" }, "uuid" : { "type" : "string" }, "row" : { "type" : "integer", "format" : "int32" }, "column" : { "type" : "integer", "format" : "int32" }, "bedNumber" : { "type" : "string" }, "status" : { "type" : "string" } } }, "BedGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "id" : { "type" : "integer", "format" : "int32" }, "uuid" : { "type" : "string" }, "row" : { "type" : "integer", "format" : "int32" }, "column" : { "type" : "integer", "format" : "int32" }, "bedNumber" : { "type" : "string" }, "status" : { "type" : "string" } } }, "BedGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "id" : { "type" : "integer", "format" : "int32" }, "uuid" : { "type" : "string" }, "row" : { "type" : "integer", "format" : "int32" }, "column" : { "type" : "integer", "format" : "int32" }, "bedNumber" : { "type" : "string" }, "status" : { "type" : "string" } } }, "BedCreate" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "id" : { "type" : "integer", "format" : "int32" }, "uuid" : { "type" : "string" }, "row" : { "type" : "integer", "format" : "int32" }, "column" : { "type" : "integer", "format" : "int32" }, "bedNumber" : { "type" : "string" }, "status" : { "type" : "string" } } }, "BedCreateFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "id" : { "type" : "integer", "format" : "int32" }, "uuid" : { "type" : "string" }, "row" : { "type" : "integer", "format" : "int32" }, "column" : { "type" : "integer", "format" : "int32" }, "bedNumber" : { "type" : "string" }, "status" : { "type" : "string" } } }, "BedUpdate" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "id" : { "type" : "integer", "format" : "int32" }, "uuid" : { "type" : "string" }, "row" : { "type" : "integer", "format" : "int32" }, "column" : { "type" : "integer", "format" : "int32" }, "bedNumber" : { "type" : "string" }, "status" : { "type" : "string" } } }, "PatientprofileGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "PatientprofileGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "PatientprofileGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "OrdertemplatesOrderTemplateGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "OrdertemplatesOrderTemplateGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "OrdertemplatesOrderTemplateGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "CohortmCohortattributetypeGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "minOccurs" : { "type" : "integer", "format" : "int32" }, "maxOccurs" : { "type" : "integer", "format" : "int32" }, "datatypeClassname" : { "type" : "string" }, "preferredHandlerClassname" : { "type" : "string" } } }, "CohortmCohortattributetypeGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "CohortmCohortattributetypeGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "retired" : { "type" : "boolean" }, "minOccurs" : { "type" : "integer", "format" : "int32" }, "maxOccurs" : { "type" : "integer", "format" : "int32" }, "datatypeClassname" : { "type" : "string" }, "preferredHandlerClassname" : { "type" : "string" }, "datatypeConfig" : { "type" : "string" }, "handlerConfig" : { "type" : "string" } } }, "CohortmCohortattributetypeCreate" : { "required" : [ "datatypeClassname", "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "datatypeClassname" : { "type" : "string" }, "minOccurs" : { "type" : "integer", "format" : "int32" }, "maxOccurs" : { "type" : "integer", "format" : "int32" }, "datatypeConfig" : { "type" : "string" }, "preferredHandlerClassname" : { "type" : "string" }, "handlerConfig" : { "type" : "string" } } }, "CohortmCohortattributetypeCreateFull" : { "required" : [ "datatypeClassname", "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "datatypeClassname" : { "type" : "string" }, "minOccurs" : { "type" : "integer", "format" : "int32" }, "maxOccurs" : { "type" : "integer", "format" : "int32" }, "datatypeConfig" : { "type" : "string" }, "preferredHandlerClassname" : { "type" : "string" }, "handlerConfig" : { "type" : "string" } } }, "CohortmCohortattributetypeUpdate" : { "required" : [ "datatypeClassname", "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "datatypeClassname" : { "type" : "string" }, "minOccurs" : { "type" : "integer", "format" : "int32" }, "maxOccurs" : { "type" : "integer", "format" : "int32" }, "datatypeConfig" : { "type" : "string" }, "preferredHandlerClassname" : { "type" : "string" }, "handlerConfig" : { "type" : "string" } } }, "StockmanagementStockitemGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "drugUuid" : { "type" : "string" }, "drugName" : { "type" : "string" }, "conceptUuid" : { "type" : "string" }, "conceptName" : { "type" : "string" }, "hasExpiration" : { "type" : "boolean" }, "preferredVendorUuid" : { "type" : "string" }, "preferredVendorName" : { "type" : "string" }, "purchasePrice" : { "type" : "number" }, "purchasePriceUoMUuid" : { "type" : "string" }, "purchasePriceUoMName" : { "type" : "string" }, "purchasePriceUoMFactor" : { "type" : "number" }, "dispensingUnitName" : { "type" : "string" }, "dispensingUnitUuid" : { "type" : "string" }, "dispensingUnitPackagingUoMUuid" : { "type" : "string" }, "dispensingUnitPackagingUoMName" : { "type" : "string" }, "dispensingUnitPackagingUoMFactor" : { "type" : "number" }, "defaultStockOperationsUoMUuid" : { "type" : "string" }, "defaultStockOperationsUoMName" : { "type" : "string" }, "defaultStockOperationsUoMFactor" : { "type" : "number" }, "categoryUuid" : { "type" : "string" }, "categoryName" : { "type" : "string" }, "dateCreated" : { "type" : "string", "format" : "date-time" }, "creatorGivenName" : { "type" : "string" }, "creatorFamilyName" : { "type" : "string" }, "voided" : { "type" : "boolean" }, "commonName" : { "type" : "string" }, "acronym" : { "type" : "string" }, "reorderLevel" : { "type" : "number" }, "reorderLevelUoMUuid" : { "type" : "string" }, "reorderLevelUoMName" : { "type" : "string" }, "reorderLevelUoMFactor" : { "type" : "number" }, "expiryNotice" : { "type" : "integer", "format" : "int32" } } }, "StockmanagementStockitemGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "drugUuid" : { "type" : "string" }, "drugName" : { "type" : "string" }, "conceptUuid" : { "type" : "string" }, "conceptName" : { "type" : "string" } } }, "StockmanagementStockitemGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "drugUuid" : { "type" : "string" }, "drugName" : { "type" : "string" }, "conceptUuid" : { "type" : "string" }, "conceptName" : { "type" : "string" }, "hasExpiration" : { "type" : "boolean" }, "preferredVendorUuid" : { "type" : "string" }, "preferredVendorName" : { "type" : "string" }, "purchasePrice" : { "type" : "number" }, "purchasePriceUoMUuid" : { "type" : "string" }, "purchasePriceUoMName" : { "type" : "string" }, "purchasePriceUoMFactor" : { "type" : "number" }, "dispensingUnitName" : { "type" : "string" }, "dispensingUnitUuid" : { "type" : "string" }, "dispensingUnitPackagingUoMUuid" : { "type" : "string" }, "dispensingUnitPackagingUoMName" : { "type" : "string" }, "dispensingUnitPackagingUoMFactor" : { "type" : "number" }, "defaultStockOperationsUoMUuid" : { "type" : "string" }, "defaultStockOperationsUoMName" : { "type" : "string" }, "defaultStockOperationsUoMFactor" : { "type" : "number" }, "categoryUuid" : { "type" : "string" }, "categoryName" : { "type" : "string" }, "dateCreated" : { "type" : "string", "format" : "date-time" }, "creatorGivenName" : { "type" : "string" }, "creatorFamilyName" : { "type" : "string" }, "voided" : { "type" : "boolean" }, "commonName" : { "type" : "string" }, "acronym" : { "type" : "string" }, "reorderLevel" : { "type" : "number" }, "reorderLevelUoMUuid" : { "type" : "string" }, "reorderLevelUoMName" : { "type" : "string" }, "reorderLevelUoMFactor" : { "type" : "number" }, "expiryNotice" : { "type" : "integer", "format" : "int32" } } }, "ConceptstateconversionGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "concept" : { "$ref" : "#/definitions/ConceptGetRef" }, "programWorkflow" : { "type" : "array", "items" : { "$ref" : "#/definitions/WorkflowGetRef" } }, "programWorkflowState" : { "type" : "array", "items" : { "$ref" : "#/definitions/WorkflowStateGetRef" } } } }, "ConceptstateconversionGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "concept" : { "$ref" : "#/definitions/ConceptGetRef" }, "programWorkflow" : { "type" : "array", "items" : { "$ref" : "#/definitions/WorkflowGetRef" } }, "programWorkflowState" : { "type" : "array", "items" : { "$ref" : "#/definitions/WorkflowStateGetRef" } } } }, "ConceptstateconversionGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "concept" : { "$ref" : "#/definitions/ConceptGetRef" }, "programWorkflow" : { "type" : "array", "items" : { "$ref" : "#/definitions/WorkflowGetRef" } }, "programWorkflowState" : { "type" : "array", "items" : { "$ref" : "#/definitions/WorkflowStateGetRef" } } } }, "ConceptstateconversionCreate" : { "properties" : { "concept" : { "$ref" : "#/definitions/ConceptCreate" }, "programWorkflow" : { "type" : "array", "items" : { "$ref" : "#/definitions/WorkflowCreate" } }, "programWorkflowState" : { "type" : "array", "items" : { "$ref" : "#/definitions/WorkflowStateCreate" } } } }, "ConceptstateconversionCreateFull" : { "properties" : { "concept" : { "$ref" : "#/definitions/ConceptCreateFull" }, "programWorkflow" : { "type" : "array", "items" : { "$ref" : "#/definitions/WorkflowCreateFull" } }, "programWorkflowState" : { "type" : "array", "items" : { "$ref" : "#/definitions/WorkflowStateGet" } } } }, "ConceptstateconversionUpdate" : { "properties" : { "concept" : { "$ref" : "#/definitions/ConceptCreate" }, "programWorkflow" : { "type" : "array", "items" : { "$ref" : "#/definitions/WorkflowCreate" } }, "programWorkflowState" : { "type" : "array", "items" : { "$ref" : "#/definitions/WorkflowStateCreate" } } } }, "StockmanagementStockoperationtypelocationscopeGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "dateCreated" : { "type" : "string", "format" : "date-time" }, "dateChanged" : { "type" : "string", "format" : "date-time" }, "locationTag" : { "type" : "string" }, "isSource" : { "type" : "boolean" }, "isDestination" : { "type" : "boolean" } } }, "StockmanagementStockoperationtypelocationscopeGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "locationTag" : { "type" : "string" } } }, "StockmanagementStockoperationtypelocationscopeGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "dateCreated" : { "type" : "string", "format" : "date-time" }, "dateChanged" : { "type" : "string", "format" : "date-time" }, "locationTag" : { "type" : "string" }, "isSource" : { "type" : "boolean" }, "isDestination" : { "type" : "boolean" } } }, "StockmanagementStockoperationlinkGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "parentUuid" : { "type" : "string" }, "parentOperationNumber" : { "type" : "string" }, "parentOperationTypeName" : { "type" : "string" }, "parentStatus" : { "type" : "string" }, "parentVoided" : { "type" : "boolean" }, "childUuid" : { "type" : "string" }, "childOperationNumber" : { "type" : "string" }, "childOperationTypeName" : { "type" : "string" }, "childStatus" : { "type" : "string" }, "childVoided" : { "type" : "boolean" } } }, "StockmanagementStockoperationlinkGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" } } }, "StockmanagementStockoperationlinkGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "parentUuid" : { "type" : "string" }, "parentOperationNumber" : { "type" : "string" }, "parentOperationTypeName" : { "type" : "string" }, "parentStatus" : { "type" : "string" }, "parentVoided" : { "type" : "boolean" }, "childUuid" : { "type" : "string" }, "childOperationNumber" : { "type" : "string" }, "childOperationTypeName" : { "type" : "string" }, "childStatus" : { "type" : "string" }, "childVoided" : { "type" : "boolean" } } }, "ConceptproposalGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string", "example" : "uuid" }, "display" : { "type" : "string" }, "encounter" : { "$ref" : "#/definitions/EncounterGetRef" }, "originalText" : { "type" : "string" }, "finalText" : { "type" : "string" }, "state" : { "type" : "string" }, "comments" : { "type" : "string" }, "occurrences" : { "type" : "string" }, "creator" : { "$ref" : "#/definitions/UserGetRef" }, "dateCreated" : { "type" : "string", "format" : "date" } } }, "ConceptproposalGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string", "example" : "uuid" }, "display" : { "type" : "string" }, "encounter" : { "$ref" : "#/definitions/EncounterGetRef" }, "originalText" : { "type" : "string" }, "state" : { "type" : "string" }, "occurrences" : { "type" : "string" }, "changedBy" : { "$ref" : "#/definitions/UserGetRef" }, "dateChanged" : { "type" : "string", "format" : "date" } } }, "ConceptproposalGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string", "example" : "uuid" }, "display" : { "type" : "string" }, "encounter" : { "$ref" : "#/definitions/EncounterGet" }, "obsConcept" : { "$ref" : "#/definitions/ConceptGet" }, "obs" : { "$ref" : "#/definitions/ObsGet" }, "mappedConcept" : { "$ref" : "#/definitions/ConceptGet" }, "originalText" : { "type" : "string" }, "finalText" : { "type" : "string" }, "state" : { "type" : "string" }, "comments" : { "type" : "string" }, "occurrences" : { "type" : "string" }, "creator" : { "$ref" : "#/definitions/UserGet" }, "dateCreated" : { "type" : "string", "format" : "date" }, "changedBy" : { "$ref" : "#/definitions/UserGet" }, "dateChanged" : { "type" : "string", "format" : "date" } } }, "ConceptproposalCreate" : { "properties" : { "originalText" : { "type" : "string" }, "mappedConcept" : { "$ref" : "#/definitions/ConceptCreate" }, "encounter" : { "$ref" : "#/definitions/EncounterCreate" }, "obsConcept" : { "$ref" : "#/definitions/ConceptCreate" } } }, "ConceptproposalCreateFull" : { "properties" : { "originalText" : { "type" : "string" }, "mappedConcept" : { "$ref" : "#/definitions/ConceptCreate" }, "encounter" : { "$ref" : "#/definitions/EncounterCreate" }, "obsConcept" : { "$ref" : "#/definitions/ConceptCreate" } } }, "ConceptproposalUpdate" : { "properties" : { "originalText" : { "type" : "string" }, "mappedConcept" : { "$ref" : "#/definitions/ConceptCreate" }, "encounter" : { "$ref" : "#/definitions/EncounterCreate" }, "obsConcept" : { "$ref" : "#/definitions/ConceptCreate" }, "finalText" : { "type" : "string" }, "comments" : { "type" : "string" } } }, "StockmanagementStockoperationitemGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "stockItemUuid" : { "type" : "string" }, "stockItemName" : { "type" : "string" }, "stockItemPackagingUOMUuid" : { "type" : "string" }, "stockItemPackagingUOMName" : { "type" : "string" }, "stockItemPackagingUOMFactor" : { "type" : "number" }, "stockBatchUuid" : { "type" : "string" }, "stockOperationUuid" : { "type" : "string" }, "batchNo" : { "type" : "string" }, "expiration" : { "type" : "string", "format" : "date-time" }, "quantity" : { "type" : "number" }, "quantityReceived" : { "type" : "number" }, "quantityReceivedPackagingUOMUuid" : { "type" : "string" }, "quantityReceivedPackagingUOMName" : { "type" : "string" }, "quantityReceivedPackagingUOMFactor" : { "type" : "number" }, "quantityRequested" : { "type" : "number" }, "quantityRequestedPackagingUOMUuid" : { "type" : "string" }, "quantityRequestedPackagingUOMName" : { "type" : "string" }, "quantityRequestedPackagingUOMFactor" : { "type" : "number" }, "commonName" : { "type" : "string" }, "acronym" : { "type" : "string" }, "purchasePrice" : { "type" : "number" }, "hasExpiration" : { "type" : "boolean" }, "packagingUnits" : { "type" : "array" } } }, "StockmanagementStockoperationitemGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "stockItemName" : { "type" : "string" } } }, "StockmanagementStockoperationitemGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "stockItemUuid" : { "type" : "string" }, "stockItemName" : { "type" : "string" }, "stockItemPackagingUOMUuid" : { "type" : "string" }, "stockItemPackagingUOMName" : { "type" : "string" }, "stockItemPackagingUOMFactor" : { "type" : "number" }, "stockBatchUuid" : { "type" : "string" }, "stockOperationUuid" : { "type" : "string" }, "batchNo" : { "type" : "string" }, "expiration" : { "type" : "string", "format" : "date-time" }, "quantity" : { "type" : "number" }, "quantityReceived" : { "type" : "number" }, "quantityReceivedPackagingUOMUuid" : { "type" : "string" }, "quantityReceivedPackagingUOMName" : { "type" : "string" }, "quantityReceivedPackagingUOMFactor" : { "type" : "number" }, "quantityRequested" : { "type" : "number" }, "quantityRequestedPackagingUOMUuid" : { "type" : "string" }, "quantityRequestedPackagingUOMName" : { "type" : "string" }, "quantityRequestedPackagingUOMFactor" : { "type" : "number" }, "commonName" : { "type" : "string" }, "acronym" : { "type" : "string" }, "purchasePrice" : { "type" : "number" }, "hasExpiration" : { "type" : "boolean" }, "packagingUnits" : { "type" : "array" } } }, "StockmanagementBatchjobGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "batchJobType" : { "type" : "string" }, "status" : { "type" : "string" }, "description" : { "type" : "string" }, "startTime" : { "type" : "string", "format" : "date-time" }, "endTime" : { "type" : "string", "format" : "date-time" }, "expiration" : { "type" : "string", "format" : "date-time" }, "parameters" : { "type" : "string" }, "privilegeScope" : { "type" : "string" }, "locationScope" : { "type" : "string" }, "locationScopeUuid" : { "type" : "integer", "format" : "int32" }, "executionState" : { "type" : "string" }, "cancelReason" : { "type" : "string" }, "cancelledByUuid" : { "type" : "string" }, "cancelledByGivenName" : { "type" : "string" }, "cancelledByFamilyName" : { "type" : "string" }, "cancelledDate" : { "type" : "string", "format" : "date-time" }, "exitMessage" : { "type" : "string" }, "completedDate" : { "type" : "string", "format" : "date-time" }, "dateCreated" : { "type" : "string", "format" : "date-time" }, "creatorUuid" : { "type" : "string" }, "creatorGivenName" : { "type" : "string" }, "creatorFamilyName" : { "type" : "string" }, "uuid" : { "type" : "string" }, "owners" : { "type" : "array" }, "outputArtifactSize" : { "type" : "integer", "format" : "int64" }, "outputArtifactFileExt" : { "type" : "string" }, "outputArtifactViewable" : { "type" : "boolean" } } }, "StockmanagementBatchjobGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "StockmanagementBatchjobGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "batchJobType" : { "type" : "string" }, "status" : { "type" : "string" }, "description" : { "type" : "string" }, "startTime" : { "type" : "string", "format" : "date-time" }, "endTime" : { "type" : "string", "format" : "date-time" }, "expiration" : { "type" : "string", "format" : "date-time" }, "parameters" : { "type" : "string" }, "privilegeScope" : { "type" : "string" }, "locationScope" : { "type" : "string" }, "locationScopeUuid" : { "type" : "integer", "format" : "int32" }, "executionState" : { "type" : "string" }, "cancelReason" : { "type" : "string" }, "cancelledByUuid" : { "type" : "string" }, "cancelledByGivenName" : { "type" : "string" }, "cancelledByFamilyName" : { "type" : "string" }, "cancelledDate" : { "type" : "string", "format" : "date-time" }, "exitMessage" : { "type" : "string" }, "completedDate" : { "type" : "string", "format" : "date-time" }, "dateCreated" : { "type" : "string", "format" : "date-time" }, "creatorUuid" : { "type" : "string" }, "creatorGivenName" : { "type" : "string" }, "creatorFamilyName" : { "type" : "string" }, "uuid" : { "type" : "string" }, "owners" : { "type" : "array" }, "outputArtifactSize" : { "type" : "integer", "format" : "int64" }, "outputArtifactFileExt" : { "type" : "string" }, "outputArtifactViewable" : { "type" : "boolean" } } }, "StockmanagementStockoperationbatchnumbersGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "batchNumbers" : { "type" : "array" } } }, "StockmanagementStockoperationbatchnumbersGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" } } }, "StockmanagementStockoperationbatchnumbersGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "batchNumbers" : { "type" : "array" } } }, "ProgramenrollmentGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "dateEnrolled" : { "type" : "string", "format" : "date" }, "dateCompleted" : { "type" : "string", "format" : "date" }, "voided" : { "type" : "boolean" }, "patient" : { "$ref" : "#/definitions/PatientGetRef" }, "program" : { "$ref" : "#/definitions/ProgramGetRef" }, "location" : { "$ref" : "#/definitions/LocationGetRef" } } }, "ProgramenrollmentGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "ProgramenrollmentGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "dateEnrolled" : { "type" : "string", "format" : "date" }, "dateCompleted" : { "type" : "string", "format" : "date" }, "voided" : { "type" : "boolean" }, "patient" : { "$ref" : "#/definitions/PatientGet" }, "program" : { "$ref" : "#/definitions/ProgramGet" }, "location" : { "$ref" : "#/definitions/LocationGet" } } }, "ProgramenrollmentCreate" : { "required" : [ "dateEnrolled", "patient", "program" ], "properties" : { "patient" : { "type" : "string", "example" : "uuid" }, "program" : { "type" : "string", "example" : "uuid" }, "dateEnrolled" : { "type" : "string", "format" : "date" }, "dateCompleted" : { "type" : "string", "format" : "date" }, "location" : { "type" : "string", "example" : "uuid" }, "voided" : { "type" : "boolean" }, "states" : { "type" : "array", "items" : { "$ref" : "#/definitions/ProgramenrollmentStateCreate" } }, "outcome" : { "$ref" : "#/definitions/ConceptCreate" } } }, "ProgramenrollmentCreateFull" : { "required" : [ "dateEnrolled", "patient", "program" ], "properties" : { "patient" : { "$ref" : "#/definitions/PatientCreate" }, "program" : { "$ref" : "#/definitions/ProgramCreate" }, "dateEnrolled" : { "type" : "string", "format" : "date" }, "dateCompleted" : { "type" : "string", "format" : "date" }, "location" : { "$ref" : "#/definitions/LocationCreate" }, "voided" : { "type" : "boolean" }, "states" : { "type" : "array", "items" : { "$ref" : "#/definitions/ProgramenrollmentStateCreate" } }, "outcome" : { "$ref" : "#/definitions/ConceptCreate" } } }, "ProgramenrollmentUpdate" : { "required" : [ "dateEnrolled" ], "properties" : { "dateEnrolled" : { "type" : "string", "format" : "date" }, "states" : { "type" : "array", "items" : { "$ref" : "#/definitions/ProgramenrollmentStateCreate" } }, "outcome" : { "$ref" : "#/definitions/ConceptCreate" }, "location" : { "$ref" : "#/definitions/LocationCreate" }, "voided" : { "type" : "boolean" }, "dateCompleted" : { "type" : "string", "format" : "date" } } }, "StockmanagementStockbatchGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "batchNo" : { "type" : "string" }, "expiration" : { "type" : "string", "format" : "date-time" }, "expiryNotificationDate" : { "type" : "string", "format" : "date-time" }, "stockItemUuid" : { "type" : "string" }, "voided" : { "type" : "boolean" } } }, "StockmanagementStockbatchGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "batchNo" : { "type" : "string" } } }, "StockmanagementStockbatchGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "batchNo" : { "type" : "string" }, "expiration" : { "type" : "string", "format" : "date-time" }, "expiryNotificationDate" : { "type" : "string", "format" : "date-time" }, "stockItemUuid" : { "type" : "string" }, "voided" : { "type" : "boolean" } } }, "QueueGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "QueueGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "QueueGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "EncounterGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "encounterDatetime" : { "type" : "string", "format" : "date" }, "provider" : { "type" : "string" }, "voided" : { "type" : "boolean" }, "patient" : { "$ref" : "#/definitions/PatientGetRef" }, "location" : { "$ref" : "#/definitions/LocationGetRef" }, "form" : { "$ref" : "#/definitions/FormGetRef" }, "encounterType" : { "$ref" : "#/definitions/EncountertypeGetRef" }, "obs" : { "type" : "array", "items" : { "$ref" : "#/definitions/ObsGetRef" } }, "orders" : { "type" : "array", "items" : { "$ref" : "#/definitions/OrderGetRef" } } } }, "EncounterGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "EncounterGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "encounterDatetime" : { "type" : "string", "format" : "date" }, "provider" : { "type" : "string" }, "voided" : { "type" : "boolean" }, "patient" : { "$ref" : "#/definitions/PatientGet" }, "location" : { "$ref" : "#/definitions/LocationGet" }, "form" : { "$ref" : "#/definitions/FormGet" }, "encounterType" : { "$ref" : "#/definitions/EncountertypeGet" }, "obs" : { "type" : "array", "items" : { "$ref" : "#/definitions/ObsGet" } }, "orders" : { "type" : "array", "items" : { "$ref" : "#/definitions/OrderGet" } } } }, "EncounterCreate" : { "required" : [ "encounterType", "patient" ], "properties" : { "patient" : { "$ref" : "#/definitions/PatientCreate" }, "encounterType" : { "$ref" : "#/definitions/EncountertypeCreate" }, "encounterDatetime" : { "type" : "string", "format" : "date" }, "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" } } } }, "EncounterCreateFull" : { "required" : [ "encounterType", "patient" ], "properties" : { "patient" : { "$ref" : "#/definitions/PatientCreate" }, "encounterType" : { "$ref" : "#/definitions/EncountertypeCreate" }, "encounterDatetime" : { "type" : "string", "format" : "date" }, "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" } } } }, "EncounterUpdate" : { "required" : [ "encounterType", "patient" ], "properties" : { "patient" : { "$ref" : "#/definitions/PatientCreate" }, "encounterType" : { "$ref" : "#/definitions/EncountertypeCreate" }, "encounterDatetime" : { "type" : "string", "format" : "date" }, "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" } } } }, "ConceptGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "name" : { "$ref" : "#/definitions/ConceptNameGet" }, "datatype" : { "$ref" : "#/definitions/ConceptdatatypeGetRef" }, "conceptClass" : { "$ref" : "#/definitions/ConceptclassGetRef" }, "set" : { "type" : "boolean" }, "version" : { "type" : "string" }, "retired" : { "type" : "boolean" }, "names" : { "type" : "array", "items" : { "$ref" : "#/definitions/ConceptNameGetRef" } }, "descriptions" : { "type" : "array", "items" : { "$ref" : "#/definitions/ConceptDescriptionGetRef" } }, "mappings" : { "type" : "array", "items" : { "$ref" : "#/definitions/ConceptMappingGetRef" } }, "answers" : { "type" : "array", "items" : { "type" : "object" } }, "setMembers" : { "type" : "array", "items" : { "type" : "object" } } } }, "ConceptGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "ConceptGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "ConceptCreate" : { "required" : [ "conceptClass", "datatype", "names" ], "properties" : { "names" : { "type" : "array", "items" : { "$ref" : "#/definitions/ConceptNameCreate" } }, "datatype" : { "type" : "string", "example" : "uuid" }, "set" : { "type" : "boolean" }, "version" : { "type" : "string" }, "answers" : { "type" : "array", "items" : { "type" : "string", "example" : "uuid" } }, "setMembers" : { "type" : "array", "items" : { "type" : "string", "example" : "uuid" } }, "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" }, "conceptClass" : { "type" : "string" }, "descriptions" : { "type" : "array", "items" : { "type" : "string" } }, "mappings" : { "type" : "array", "items" : { "type" : "string" } } } }, "ConceptCreateFull" : { "required" : [ "conceptClass", "datatype", "names" ], "properties" : { "names" : { "type" : "array", "items" : { "$ref" : "#/definitions/ConceptNameCreate" } }, "datatype" : { "type" : "string", "example" : "uuid" }, "set" : { "type" : "boolean" }, "version" : { "type" : "string" }, "answers" : { "type" : "array", "items" : { "type" : "string", "example" : "uuid" } }, "setMembers" : { "type" : "array", "items" : { "type" : "string", "example" : "uuid" } }, "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" }, "conceptClass" : { "$ref" : "#/definitions/ConceptclassCreate" }, "descriptions" : { "type" : "array", "items" : { "$ref" : "#/definitions/ConceptDescriptionCreate" } }, "mappings" : { "type" : "array", "items" : { "$ref" : "#/definitions/ConceptMappingCreate" } } } }, "ConceptUpdate" : { "properties" : { "name" : { "$ref" : "#/definitions/ConceptNameCreate" }, "names" : { "type" : "array", "items" : { "$ref" : "#/definitions/ConceptNameCreate" } }, "descriptions" : { "type" : "array", "items" : { "$ref" : "#/definitions/ConceptDescriptionCreate" } } } }, "BedTagGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "id" : { "type" : "string" }, "name" : { "type" : "string" }, "uuid" : { "type" : "string" } } }, "BedTagGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "id" : { "type" : "string" }, "name" : { "type" : "string" }, "uuid" : { "type" : "string" } } }, "BedTagGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "id" : { "type" : "string" }, "name" : { "type" : "string" }, "uuid" : { "type" : "string" } } }, "BedTagCreate" : { "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" } } }, "BedTagCreateFull" : { "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" } } }, "BedTagUpdate" : { "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" } } }, "VisittypeGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "VisittypeGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "VisittypeGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "retired" : { "type" : "boolean" } } }, "VisittypeCreate" : { "required" : [ "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" } } }, "VisittypeCreateFull" : { "required" : [ "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" } } }, "VisittypeUpdate" : { "required" : [ "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" } } }, "LocationGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "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/LocationtagGetRef" } }, "parentLocation" : { "$ref" : "#/definitions/LocationGetRef" }, "childLocations" : { "type" : "array", "items" : { "$ref" : "#/definitions/LocationGetRef" } } } }, "LocationGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "LocationGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "retired" : { "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" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/definitions/LocationtagGet" } }, "parentLocation" : { "$ref" : "#/definitions/LocationGet" }, "childLocations" : { "type" : "array", "items" : { "$ref" : "#/definitions/LocationGet" } } } }, "LocationCreate" : { "required" : [ "name" ], "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" : { "type" : "string" } }, "parentLocation" : { "type" : "string" }, "childLocations" : { "type" : "array", "items" : { "type" : "string" } } } }, "LocationCreateFull" : { "required" : [ "name" ], "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" : { "type" : "string" } }, "parentLocation" : { "type" : "string" }, "childLocations" : { "type" : "array", "items" : { "type" : "string" } } } }, "LocationUpdate" : { "required" : [ "name" ], "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" : { "type" : "string" } }, "parentLocation" : { "type" : "string" }, "childLocations" : { "type" : "array", "items" : { "type" : "string" } } } }, "StockmanagementDispenserequestGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "dispenseLocation" : { "type" : "string" }, "patient" : { "type" : "string" }, "order" : { "type" : "string" }, "encounter" : { "type" : "string" }, "stockItem" : { "type" : "string" }, "stockBatch" : { "type" : "string" }, "quantity" : { "type" : "string" } } }, "StockmanagementDispenserequestGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "dispenseLocation" : { "type" : "string" }, "patient" : { "type" : "string" }, "order" : { "type" : "string" }, "encounter" : { "type" : "string" }, "stockItem" : { "type" : "string" }, "stockBatch" : { "type" : "string" }, "quantity" : { "type" : "string" } } }, "StockmanagementDispenserequestGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "dispenseLocation" : { "type" : "string" }, "patient" : { "type" : "string" }, "order" : { "type" : "string" }, "encounter" : { "type" : "string" }, "stockItem" : { "type" : "string" }, "stockBatch" : { "type" : "string" }, "quantity" : { "type" : "string" } } }, "PatientGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "identifiers" : { "type" : "array", "items" : { "$ref" : "#/definitions/PatientIdentifierGetRef" } }, "preferred" : { "type" : "boolean", "default" : false }, "voided" : { "type" : "boolean" }, "person" : { "$ref" : "#/definitions/PersonGetRef" } } }, "PatientGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "PatientGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "identifiers" : { "type" : "array", "items" : { "$ref" : "#/definitions/PatientIdentifierGetRef" } }, "preferred" : { "type" : "boolean", "default" : false }, "voided" : { "type" : "boolean" }, "person" : { "$ref" : "#/definitions/PersonGet" } } }, "PatientCreate" : { "required" : [ "identifiers", "person" ], "properties" : { "person" : { "type" : "string", "example" : "uuid" }, "identifiers" : { "type" : "array", "items" : { "$ref" : "#/definitions/PatientIdentifierCreate" } } } }, "PatientCreateFull" : { "required" : [ "identifiers", "person" ], "properties" : { "person" : { "$ref" : "#/definitions/PersonCreate" }, "identifiers" : { "type" : "array", "items" : { "$ref" : "#/definitions/PatientIdentifierCreate" } } } }, "PatientUpdate" : { "required" : [ "person" ], "properties" : { "person" : { "$ref" : "#/definitions/PersonGet" } } }, "OrdersetGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "operator" : { "type" : "string", "enum" : [ "ALL", "ONE", "ANY" ] }, "orderSetMembers" : { "type" : "array", "items" : { "$ref" : "#/definitions/OrdersetOrdersetmemberGetRef" } } } }, "OrdersetGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "OrdersetGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "retired" : { "type" : "boolean" }, "operator" : { "type" : "string", "enum" : [ "ALL", "ONE", "ANY" ] }, "orderSetMembers" : { "type" : "array", "items" : { "$ref" : "#/definitions/OrdersetOrdersetmemberGet" } } } }, "OrdersetCreate" : { "properties" : { "operator" : { "type" : "string", "enum" : [ "ALL", "ONE", "ANY" ] }, "orderSetMembers" : { "type" : "array", "items" : { "$ref" : "#/definitions/OrdersetOrdersetmemberCreate" } } } }, "OrdersetCreateFull" : { "properties" : { "operator" : { "type" : "string", "enum" : [ "ALL", "ONE", "ANY" ] }, "orderSetMembers" : { "type" : "array", "items" : { "$ref" : "#/definitions/OrdersetOrdersetmemberCreate" } } } }, "OrdersetUpdate" : { "properties" : { "operator" : { "type" : "string", "enum" : [ "ALL", "ONE", "ANY" ] }, "orderSetMembers" : { "type" : "array", "items" : { "$ref" : "#/definitions/OrdersetOrdersetmemberCreate" } } } }, "StockmanagementStockoperationactionGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "reason" : { "type" : "string" }, "name" : { "type" : "string" }, "uuid" : { "type" : "string" }, "lineItems" : { "type" : "array" } } }, "StockmanagementStockoperationactionGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "StockmanagementStockoperationactionGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "reason" : { "type" : "string" }, "name" : { "type" : "string" }, "uuid" : { "type" : "string" }, "lineItems" : { "type" : "array" } } }, "PatientflagsDisplaypointGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "PatientflagsDisplaypointGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "PatientflagsDisplaypointGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "retired" : { "type" : "boolean" } } }, "PatientflagsDisplaypointCreate" : { "required" : [ "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" } } }, "PatientflagsDisplaypointCreateFull" : { "required" : [ "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" } } }, "PatientflagsDisplaypointUpdate" : { "required" : [ "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" } } }, "ProgramGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "concept" : { "$ref" : "#/definitions/ConceptGetRef" }, "allWorkflows" : { "type" : "array", "items" : { "$ref" : "#/definitions/WorkflowGetRef" } } } }, "ProgramGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "allWorkflows" : { "type" : "array", "items" : { "$ref" : "#/definitions/WorkflowGetRef" } } } }, "ProgramGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "retired" : { "type" : "boolean" }, "concept" : { "$ref" : "#/definitions/ConceptGet" }, "allWorkflows" : { "type" : "array", "items" : { "$ref" : "#/definitions/WorkflowGet" } } } }, "ProgramCreate" : { "required" : [ "concept", "description", "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "concept" : { "type" : "string", "example" : "uuid" }, "retired" : { "type" : "boolean" }, "outcomesConcept" : { "type" : "string", "example" : "uuid" } } }, "ProgramCreateFull" : { "required" : [ "concept", "description", "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "concept" : { "$ref" : "#/definitions/ConceptCreate" }, "retired" : { "type" : "boolean" }, "outcomesConcept" : { "$ref" : "#/definitions/ConceptCreate" } } }, "ProgramUpdate" : { }, "OrderfrequencyGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "OrderfrequencyGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "OrderfrequencyGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "retired" : { "type" : "boolean" } } }, "OrderfrequencyCreate" : { "required" : [ "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" } } }, "OrderfrequencyCreateFull" : { "required" : [ "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" } } }, "OrderfrequencyUpdate" : { "required" : [ "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" } } }, "ReportingrestReportDefinitionGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "ReportingrestReportDefinitionGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "ReportingrestReportDefinitionGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "retired" : { "type" : "boolean" } } }, "ReportingrestReportDefinitionCreate" : { "required" : [ "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" } } }, "ReportingrestReportDefinitionCreateFull" : { "required" : [ "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" } } }, "ReportingrestReportDefinitionUpdate" : { "required" : [ "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" } } }, "ModuleGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "started" : { "type" : "boolean" }, "startupErrorMessage" : { "type" : "string" } } }, "ModuleGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "ModuleGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "started" : { "type" : "boolean" }, "startupErrorMessage" : { "type" : "string" }, "packageName" : { "type" : "string" }, "author" : { "type" : "string" }, "version" : { "type" : "string" }, "requireOpenmrsVersion" : { "type" : "string" }, "awareOfModules" : { "type" : "array", "items" : { "type" : "string" } }, "requiredModules" : { "type" : "array", "items" : { "type" : "string" } } } }, "ReportingrestDataSetDefinitionGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "ReportingrestDataSetDefinitionGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "ReportingrestDataSetDefinitionGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "retired" : { "type" : "boolean" } } }, "ReportingrestDataSetDefinitionCreate" : { "required" : [ "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" } } }, "ReportingrestDataSetDefinitionCreateFull" : { "required" : [ "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" } } }, "ReportingrestDataSetDefinitionUpdate" : { "required" : [ "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" } } }, "BillingBillLineItemGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "BillingBillLineItemGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "BillingBillLineItemGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "StockmanagementStockiteminventoryGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "partyUuid" : { "type" : "string" }, "locationUuid" : { "type" : "string" }, "partyName" : { "type" : "string" }, "stockItemUuid" : { "type" : "string" }, "drugId" : { "type" : "string" }, "drugUuid" : { "type" : "string" }, "drugStrength" : { "type" : "string" }, "conceptId" : { "type" : "string" }, "conceptUuid" : { "type" : "string" }, "stockBatchUuid" : { "type" : "string" }, "batchNumber" : { "type" : "string" }, "quantity" : { "type" : "number" }, "quantityUoM" : { "type" : "string" }, "quantityFactor" : { "type" : "number" }, "quantityUoMUuid" : { "type" : "string" }, "expiration" : { "type" : "string", "format" : "date-time" }, "commonName" : { "type" : "string" }, "acronym" : { "type" : "string" }, "drugName" : { "type" : "string" }, "conceptName" : { "type" : "string" } } }, "StockmanagementStockiteminventoryGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "StockmanagementStockiteminventoryGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "partyUuid" : { "type" : "string" }, "locationUuid" : { "type" : "string" }, "partyName" : { "type" : "string" }, "stockItemUuid" : { "type" : "string" }, "drugId" : { "type" : "string" }, "drugUuid" : { "type" : "string" }, "drugStrength" : { "type" : "string" }, "conceptId" : { "type" : "string" }, "conceptUuid" : { "type" : "string" }, "stockBatchUuid" : { "type" : "string" }, "batchNumber" : { "type" : "string" }, "quantity" : { "type" : "number" }, "quantityUoM" : { "type" : "string" }, "quantityFactor" : { "type" : "number" }, "quantityUoMUuid" : { "type" : "string" }, "expiration" : { "type" : "string", "format" : "date-time" }, "commonName" : { "type" : "string" }, "acronym" : { "type" : "string" }, "drugName" : { "type" : "string" }, "conceptName" : { "type" : "string" } } }, "StockmanagementOrderitemGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "orderUuid" : { "type" : "string" }, "action" : { "type" : "string" }, "orderNumber" : { "type" : "string" }, "encounterUuid" : { "type" : "string" }, "stockItemUuid" : { "type" : "string" }, "drugUuid" : { "type" : "string" }, "drugName" : { "type" : "string" }, "conceptUuid" : { "type" : "string" }, "conceptId" : { "type" : "integer", "format" : "int32" }, "conceptName" : { "type" : "string" }, "commonName" : { "type" : "string" }, "acronym" : { "type" : "string" }, "quantity" : { "type" : "number" }, "duration" : { "type" : "integer", "format" : "int32" }, "stockItemPackagingUOMConceptId" : { "type" : "integer", "format" : "int32" }, "stockItemPackagingUOMUuid" : { "type" : "string" }, "stockItemPackagingUOMName" : { "type" : "string" }, "createdFromName" : { "type" : "string" }, "createdFrom" : { "type" : "integer", "format" : "int32" }, "createdFromUuid" : { "type" : "string" }, "createdFromPartyUuid" : { "type" : "string" }, "fulfilmentLocationName" : { "type" : "string" }, "fulfilmentLocationUuid" : { "type" : "string" }, "fulfilmentPartyUuid" : { "type" : "string" }, "creator" : { "type" : "integer", "format" : "int32" }, "dateCreated" : { "type" : "string", "format" : "date-time" }, "creatorGivenName" : { "type" : "string" }, "creatorFamilyName" : { "type" : "string" }, "patientId" : { "type" : "integer", "format" : "int32" }, "patientGivenName" : { "type" : "string" }, "patientFamilyName" : { "type" : "string" }, "scheduledDate" : { "type" : "string", "format" : "date" } } }, "StockmanagementOrderitemGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" } } }, "StockmanagementOrderitemGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "orderUuid" : { "type" : "string" }, "action" : { "type" : "string" }, "orderNumber" : { "type" : "string" }, "encounterUuid" : { "type" : "string" }, "stockItemUuid" : { "type" : "string" }, "drugUuid" : { "type" : "string" }, "drugName" : { "type" : "string" }, "conceptUuid" : { "type" : "string" }, "conceptId" : { "type" : "integer", "format" : "int32" }, "conceptName" : { "type" : "string" }, "commonName" : { "type" : "string" }, "acronym" : { "type" : "string" }, "quantity" : { "type" : "number" }, "duration" : { "type" : "integer", "format" : "int32" }, "stockItemPackagingUOMConceptId" : { "type" : "integer", "format" : "int32" }, "stockItemPackagingUOMUuid" : { "type" : "string" }, "stockItemPackagingUOMName" : { "type" : "string" }, "createdFromName" : { "type" : "string" }, "createdFrom" : { "type" : "integer", "format" : "int32" }, "createdFromUuid" : { "type" : "string" }, "createdFromPartyUuid" : { "type" : "string" }, "fulfilmentLocationName" : { "type" : "string" }, "fulfilmentLocationUuid" : { "type" : "string" }, "fulfilmentPartyUuid" : { "type" : "string" }, "creator" : { "type" : "integer", "format" : "int32" }, "dateCreated" : { "type" : "string", "format" : "date-time" }, "creatorGivenName" : { "type" : "string" }, "creatorFamilyName" : { "type" : "string" }, "patientId" : { "type" : "integer", "format" : "int32" }, "patientGivenName" : { "type" : "string" }, "patientFamilyName" : { "type" : "string" }, "scheduledDate" : { "type" : "string", "format" : "date" } } }, "RelationshiptypeGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "aIsToB" : { "type" : "string" }, "bIsToA" : { "type" : "string" } } }, "RelationshiptypeGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "RelationshiptypeGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "retired" : { "type" : "boolean" }, "aIsToB" : { "type" : "string" }, "bIsToA" : { "type" : "string" }, "weight" : { "type" : "integer", "format" : "int32" } } }, "RelationshiptypeCreate" : { "required" : [ "aIsToB", "bIsToA", "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "aIsToB" : { "type" : "string" }, "bIsToA" : { "type" : "string" }, "weight" : { "type" : "integer", "format" : "int32" } } }, "RelationshiptypeCreateFull" : { "required" : [ "aIsToB", "bIsToA", "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "aIsToB" : { "type" : "string" }, "bIsToA" : { "type" : "string" }, "weight" : { "type" : "integer", "format" : "int32" } } }, "RelationshiptypeUpdate" : { }, "StockmanagementPartyGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "name" : { "type" : "string" }, "acronym" : { "type" : "string" }, "locationUuid" : { "type" : "string" }, "stockSourceUuid" : { "type" : "string" }, "tags" : { "type" : "array" } } }, "StockmanagementPartyGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "name" : { "type" : "string" } } }, "StockmanagementPartyGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "name" : { "type" : "string" }, "acronym" : { "type" : "string" }, "locationUuid" : { "type" : "string" }, "stockSourceUuid" : { "type" : "string" }, "tags" : { "type" : "array" } } }, "AlertGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "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" }, "recipients" : { "type" : "array", "items" : { "$ref" : "#/definitions/AlertRecipientGetRef" } } } }, "AlertGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "alertId" : { "type" : "integer", "format" : "int32" } } }, "AlertGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "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" : "object" }, "dateCreated" : { "type" : "string", "format" : "date-time" }, "changedBy" : { "type" : "object" }, "dateChanged" : { "type" : "string", "format" : "date-time" }, "recipients" : { "type" : "array", "items" : { "$ref" : "#/definitions/AlertRecipientGetRef" } } } }, "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/AlertRecipientCreate" } }, "satisfiedByAny" : { "type" : "boolean" }, "dateToExpire" : { "type" : "string", "format" : "date" } } }, "AlertUpdate" : { "properties" : { "text" : { "type" : "string" }, "recipients" : { "type" : "array", "items" : { "$ref" : "#/definitions/AlertRecipientCreate" } }, "satisfiedByAny" : { "type" : "boolean" }, "dateToExpire" : { "type" : "string", "format" : "date" } } }, "CohortmCohortGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "CohortmCohortGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "CohortmCohortGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "RelationshipGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "voided" : { "type" : "boolean" }, "personA" : { "$ref" : "#/definitions/PersonGetRef" }, "relationshipType" : { "$ref" : "#/definitions/RelationshiptypeGetRef" }, "personB" : { "$ref" : "#/definitions/PersonGetRef" } } }, "RelationshipGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "RelationshipGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "voided" : { "type" : "boolean" }, "personA" : { "$ref" : "#/definitions/PersonGet" }, "relationshipType" : { "$ref" : "#/definitions/RelationshiptypeGet" }, "personB" : { "$ref" : "#/definitions/PersonGet" } } }, "RelationshipCreate" : { "required" : [ "personA", "personB", "relationshipType" ], "properties" : { "personA" : { "type" : "string", "example" : "uuid" }, "relationshipType" : { "type" : "string", "example" : "uuid" }, "personB" : { "type" : "string", "example" : "uuid" }, "startDate" : { "type" : "string", "format" : "date" }, "endDate" : { "type" : "string", "format" : "date" } } }, "RelationshipCreateFull" : { "required" : [ "personA", "personB", "relationshipType" ], "properties" : { "personA" : { "$ref" : "#/definitions/PersonCreate" }, "relationshipType" : { "$ref" : "#/definitions/RelationshiptypeCreate" }, "personB" : { "$ref" : "#/definitions/PersonCreate" }, "startDate" : { "type" : "string", "format" : "date" }, "endDate" : { "type" : "string", "format" : "date" } } }, "RelationshipUpdate" : { "properties" : { "voided" : { "type" : "boolean" } } }, "OrdertypeGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "javaClassName" : { "type" : "string" }, "conceptClasses" : { "type" : "array", "items" : { "$ref" : "#/definitions/ConceptclassGetRef" } }, "parent" : { "$ref" : "#/definitions/OrdertypeGetRef" } } }, "OrdertypeGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "OrdertypeGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "retired" : { "type" : "boolean" }, "javaClassName" : { "type" : "string" }, "conceptClasses" : { "type" : "array", "items" : { "$ref" : "#/definitions/ConceptclassGet" } }, "parent" : { "$ref" : "#/definitions/OrdertypeGet" } } }, "OrdertypeCreate" : { "required" : [ "javaClassName", "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "javaClassName" : { "type" : "string" }, "parent" : { "type" : "string", "example" : "uuid" }, "conceptClasses" : { "type" : "array", "items" : { "type" : "string", "example" : "uuid" } } } }, "OrdertypeCreateFull" : { "required" : [ "javaClassName", "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "javaClassName" : { "type" : "string" }, "parent" : { "type" : "string", "example" : "uuid" }, "conceptClasses" : { "type" : "array", "items" : { "type" : "string", "example" : "uuid" } } } }, "OrdertypeUpdate" : { "required" : [ "javaClassName", "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "javaClassName" : { "type" : "string" }, "parent" : { "type" : "string", "example" : "uuid" }, "conceptClasses" : { "type" : "array", "items" : { "type" : "string", "example" : "uuid" } } } }, "PrivilegeGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "PrivilegeGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "PrivilegeGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "retired" : { "type" : "boolean" } } }, "PrivilegeCreate" : { "required" : [ "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" } } }, "PrivilegeCreateFull" : { "required" : [ "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" } } }, "PrivilegeUpdate" : { "properties" : { "description" : { "type" : "string" } } }, "ConceptattributetypeGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "minOccurs" : { "type" : "integer", "format" : "int32" }, "maxOccurs" : { "type" : "integer", "format" : "int32" }, "datatypeClassname" : { "type" : "string" }, "preferredHandlerClassname" : { "type" : "string" } } }, "ConceptattributetypeGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" } } }, "ConceptattributetypeGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "display" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "retired" : { "type" : "boolean" }, "minOccurs" : { "type" : "integer", "format" : "int32" }, "maxOccurs" : { "type" : "integer", "format" : "int32" }, "datatypeClassname" : { "type" : "string" }, "preferredHandlerClassname" : { "type" : "string" }, "datatypeConfig" : { "type" : "string" }, "handlerConfig" : { "type" : "string" } } }, "ConceptattributetypeCreate" : { "required" : [ "datatypeClassname", "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "datatypeClassname" : { "type" : "string" }, "minOccurs" : { "type" : "integer", "format" : "int32" }, "maxOccurs" : { "type" : "integer", "format" : "int32" }, "datatypeConfig" : { "type" : "string" }, "preferredHandlerClassname" : { "type" : "string" }, "handlerConfig" : { "type" : "string" } } }, "ConceptattributetypeCreateFull" : { "required" : [ "datatypeClassname", "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "datatypeClassname" : { "type" : "string" }, "minOccurs" : { "type" : "integer", "format" : "int32" }, "maxOccurs" : { "type" : "integer", "format" : "int32" }, "datatypeConfig" : { "type" : "string" }, "preferredHandlerClassname" : { "type" : "string" }, "handlerConfig" : { "type" : "string" } } }, "ConceptattributetypeUpdate" : { "required" : [ "datatypeClassname", "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "datatypeClassname" : { "type" : "string" }, "minOccurs" : { "type" : "integer", "format" : "int32" }, "maxOccurs" : { "type" : "integer", "format" : "int32" }, "datatypeConfig" : { "type" : "string" }, "preferredHandlerClassname" : { "type" : "string" }, "handlerConfig" : { "type" : "string" } } }, "StockmanagementStockoperationtypeGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "dateCreated" : { "type" : "string", "format" : "date-time" }, "dateChanged" : { "type" : "string", "format" : "date-time" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "operationType" : { "type" : "string" }, "hasSource" : { "type" : "boolean" }, "sourceType" : { "type" : "string" }, "hasDestination" : { "type" : "boolean" }, "destinationType" : { "type" : "string" }, "availableWhenReserved" : { "type" : "boolean" }, "allowExpiredBatchNumbers" : { "type" : "boolean" }, "stockOperationTypeLocationScopes" : { "type" : "array", "items" : { "$ref" : "#/definitions/StockOperationTypeLocationScopeResourceGet" } } } }, "StockmanagementStockoperationtypeGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "name" : { "type" : "string" } } }, "StockmanagementStockoperationtypeGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "dateCreated" : { "type" : "string", "format" : "date-time" }, "dateChanged" : { "type" : "string", "format" : "date-time" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "operationType" : { "type" : "string" }, "hasSource" : { "type" : "boolean" }, "sourceType" : { "type" : "string" }, "hasDestination" : { "type" : "boolean" }, "destinationType" : { "type" : "string" }, "availableWhenReserved" : { "type" : "boolean" }, "allowExpiredBatchNumbers" : { "type" : "boolean" }, "stockOperationTypeLocationScopes" : { "type" : "array", "items" : { "$ref" : "#/definitions/StockOperationTypeLocationScopeResourceGet" } } } }, "TaskactionCreate" : { "required" : [ "action" ], "properties" : { "tasks" : { "type" : "array", "items" : { "type" : "string" } }, "allTasks" : { "type" : "boolean" }, "action" : { "type" : "string", "enum" : [ "SCHEDULETASK", "SHUTDOWNTASK", "RESCHEDULETASK", "RESCHEDULEALLTASKS", "DELETE", "RUNTASK" ] } } }, "TaskactionCreateFull" : { "required" : [ "action" ], "properties" : { "tasks" : { "type" : "array", "items" : { "type" : "string" } }, "allTasks" : { "type" : "boolean" }, "action" : { "type" : "string", "enum" : [ "SCHEDULETASK", "SHUTDOWNTASK", "RESCHEDULETASK", "RESCHEDULEALLTASKS", "DELETE", "RUNTASK" ] } } }, "TaskactionGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "TaskactionGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "TaskactionGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } } } }, "StockmanagementStockoperationGet" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self|full" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "cancelReason" : { "type" : "string" }, "cancelledBy" : { "type" : "integer", "format" : "int32" }, "cancelledByGivenName" : { "type" : "string" }, "cancelledByFamilyName" : { "type" : "string" }, "cancelledDate" : { "type" : "string", "format" : "date-time" }, "completedBy" : { "type" : "integer", "format" : "int32" }, "completedByGivenName" : { "type" : "string" }, "completedByFamilyName" : { "type" : "string" }, "completedDate" : { "type" : "string", "format" : "date-time" }, "destinationUuid" : { "type" : "string" }, "destinationName" : { "type" : "string" }, "externalReference" : { "type" : "string" }, "atLocationUuid" : { "type" : "string" }, "atLocationName" : { "type" : "string" }, "operationDate" : { "type" : "string", "format" : "date-time" }, "locked" : { "type" : "boolean" }, "operationNumber" : { "type" : "string" }, "operationOrder" : { "type" : "integer", "format" : "int32" }, "reasonUuid" : { "type" : "string" }, "reasonName" : { "type" : "string" }, "remarks" : { "type" : "string" }, "sourceUuid" : { "type" : "string" }, "sourceName" : { "type" : "string" }, "status" : { "type" : "string" }, "returnReason" : { "type" : "string" }, "rejectionReason" : { "type" : "string" }, "operationTypeUuid" : { "type" : "string" }, "operationType" : { "type" : "string" }, "operationTypeName" : { "type" : "string" }, "responsiblePersonUuid" : { "type" : "string" }, "responsiblePersonGivenName" : { "type" : "string" }, "responsiblePersonFamilyName" : { "type" : "string" }, "responsiblePersonOther" : { "type" : "string" }, "approvalRequired" : { "type" : "boolean" }, "dateCreated" : { "type" : "string", "format" : "date-time" }, "creatorGivenName" : { "type" : "string" }, "creatorFamilyName" : { "type" : "string" }, "submittedByGivenName" : { "type" : "string" }, "submittedByFamilyName" : { "type" : "string" }, "submittedDate" : { "type" : "string", "format" : "date" }, "returnedByGivenName" : { "type" : "string" }, "returnedByFamilyName" : { "type" : "string" }, "returnedDate" : { "type" : "string", "format" : "date" }, "rejectedByGivenName" : { "type" : "string" }, "rejectedByFamilyName" : { "type" : "string" }, "rejectedDate" : { "type" : "string", "format" : "date" } } }, "StockmanagementStockoperationGetRef" : { "properties" : { "links" : { "type" : "array", "items" : { "type" : "object", "properties" : { "rel" : { "type" : "string", "example" : "self" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "operationNumber" : { "type" : "string" } } }, "StockmanagementStockoperationGetFull" : { "properties" : { "auditInfo" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "type" : "object", "example" : "self", "properties" : { "rel" : { "type" : "string" }, "uri" : { "type" : "string", "format" : "uri" } } } }, "uuid" : { "type" : "string" }, "cancelReason" : { "type" : "string" }, "cancelledBy" : { "type" : "integer", "format" : "int32" }, "cancelledByGivenName" : { "type" : "string" }, "cancelledByFamilyName" : { "type" : "string" }, "cancelledDate" : { "type" : "string", "format" : "date-time" }, "completedBy" : { "type" : "integer", "format" : "int32" }, "completedByGivenName" : { "type" : "string" }, "completedByFamilyName" : { "type" : "string" }, "completedDate" : { "type" : "string", "format" : "date-time" }, "destinationUuid" : { "type" : "string" }, "destinationName" : { "type" : "string" }, "externalReference" : { "type" : "string" }, "atLocationUuid" : { "type" : "string" }, "atLocationName" : { "type" : "string" }, "operationDate" : { "type" : "string", "format" : "date-time" }, "locked" : { "type" : "boolean" }, "operationNumber" : { "type" : "string" }, "operationOrder" : { "type" : "integer", "format" : "int32" }, "reasonUuid" : { "type" : "string" }, "reasonName" : { "type" : "string" }, "remarks" : { "type" : "string" }, "sourceUuid" : { "type" : "string" }, "sourceName" : { "type" : "string" }, "status" : { "type" : "string" }, "returnReason" : { "type" : "string" }, "rejectionReason" : { "type" : "string" }, "operationTypeUuid" : { "type" : "string" }, "operationType" : { "type" : "string" }, "operationTypeName" : { "type" : "string" }, "responsiblePersonUuid" : { "type" : "string" }, "responsiblePersonGivenName" : { "type" : "string" }, "responsiblePersonFamilyName" : { "type" : "string" }, "responsiblePersonOther" : { "type" : "string" }, "approvalRequired" : { "type" : "boolean" }, "dateCreated" : { "type" : "string", "format" : "date-time" }, "creatorGivenName" : { "type" : "string" }, "creatorFamilyName" : { "type" : "string" }, "submittedByGivenName" : { "type" : "string" }, "submittedByFamilyName" : { "type" : "string" }, "submittedDate" : { "type" : "string", "format" : "date" }, "returnedByGivenName" : { "type" : "string" }, "returnedByFamilyName" : { "type" : "string" }, "returnedDate" : { "type" : "string", "format" : "date" }, "rejectedByGivenName" : { "type" : "string" }, "rejectedByFamilyName" : { "type" : "string" }, "rejectedDate" : { "type" : "string", "format" : "date" }, "stockOperationItems" : { "type" : "array" } } } }, "externalDocs" : { "description" : "Find more info on REST Module Wiki", "url" : "https://wiki.openmrs.org/x/xoAaAQ" } }