Created
July 28, 2025 08:35
-
-
Save yogesh-aggarwal/5362f6b364285d6ab2d3c6024ddc16eb to your computer and use it in GitHub Desktop.
This file has been truncated, but you can view the full file.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "swagger": "2.0", | |
| "info": { | |
| "version": "1.0", | |
| "title": "Enterprise API USCDI Routes", | |
| "description": "NextGen Enterprise API - USCDI Routes\r\n______________________________________________________\r\nGENERAL USAGE INFORMATION:\r\n______________________________________________________\r\n______________________________________________________\r\nAuthentication:\r\n______________________________________________________\r\nNo testing capabilities are available via the functions on this documentation page; therefore the \"Authorize\" button will not function. Additionally, the \"Execute\" button revealed by selecting the Try it out button in individual routes will produce request code, but will not send a request nor return a response. Enterprise API testing capablities are available via the sandbox referenced below. Enterprise API Authentication documentation is available from within the material available at https://www.nextgen.com/api. The direct link to this documentation is https://www.nextgen.com/api/EntAPI-GSA-Auth-Docs-Guide.pdf.\r\n\r\n3rd Party Developer Organizations or a NextGen Healthcare Clients who have an Enterprise API-powered application in mind and wish to apply to our API Program should visit https://www.nextgen.com/partner-program and choose the \"Learn More\" link below the most appropriate program description on that page. Each \"Learn More\" link leads to the API Partner Program Onboarding form. The Open Access Partner Program applies solely to NextGen Healthcare Clients. The Open API Consumer Partner Program and the Premier Partner Program are each applicable solely to 3rd Party Developer Organizations.\r\n\r\nPartner applicants can obtain access to the NextGen Developer Portal (which includes additional resources for developers, including a functional Enterprise API sandbox) following submission of an onboarding form and completion of the self-registration process that will be described in the automated email response to onboarding form submissions.\r\n______________________________________________________\r\nID Naming Conventions:\r\n______________________________________________________\r\n- Unique records (whose values are guids) are all named \"id\" in the result sets of various Enterprise API USCDI GET Routes;\r\n- However in every other context, the name of an ID is determined by the GET route that returns the ID.\r\n\r\nExamples:\r\nGET /persons/lookup \"id\" values are the expected values for {personId} in all other routes.\r\nGET /persons/{personId}/chart/encounters \"id\" values are the expected values for {encounterId} in all other routes.\r\nGET /persons/{personId}/chart/allergies \"id\" values are the expected values for {allergyId} in all other routes.\r\netc.\r\n______________________________________________________\r\nStart with GET /persons/lookup\r\n______________________________________________________\r\nAlmost all routes will require prior knowledge of a valid {personId}.\r\n\r\nPlease note that the Patient Demographics documentation section contains:\r\n\r\n- The GET /persons/lookup route, which is used to obtain one or more {personId} values based on lookup criteria.\r\n- The GET /persons/{personId}/chart/encounters route, which requires a valid {personId} and is used to obtain the {encounterId} value that is required by some (but not all) of the routes in this API. An encounter is an interaction between a provider and patient that took place at a specific date & time.\r\n______________________________________________________\r\nHow to Use OData ($) Parameters\r\n______________________________________________________\r\nManaging Results from NextGen Enterprise API GET Routes:\r\n\r\nThere are several OData-based \"result management\" parameters (each beginning with a dollar sign $) that may be used as query string parameters in supported routes. These OData parameters add valuable functionality & flexibility to many NextGen Enterprise USCDI API GET routes.\r\n\r\nIf a given GET route supports OData result management, the available parameters for that route will be listed within the route details.\r\n\r\nThe OData v3.0 Core Protocol (https://www.odata.org/documentation/odata-version-3-0/odata-version-3-0-core-protocol/) has comprehensive details on each of these parameters, but a more focused (and NextGen-specific) explanation of each follows here.\r\n___________________________\r\n$top\r\n___________________________\r\n$top specifies the number of records to be returned (Note: if the $top parameter is omitted from a request, the default set of 25 results are returned; see $skip).\r\n\r\n- $top expects a value that is a positive integer between 1 and 1000. The maximum possible number of results per request is 1000, even if the value of $top in a request exceeds 1000 (Obtaining all data from a result set that exceeds 1000 records requires use of $skip).\r\n- Examples:\r\n$top=100 will return up to the 1st 100 results.\r\n$top=1234 will return up to the 1st 1000 results.\r\n___________________________\r\n$skip\r\n___________________________\r\n$skip may be used to ignore the 1st n results.\r\n\r\n-$skip expects a value that is a positive integer – ex. $skip=25 will begin the result set at the 26th result.\r\n-$skip is helpful if you want to “paginate” result sets.\r\n-Invoking $skip causes the response set to begin at the n+1 result.\r\n___________________________\r\n$count\r\n___________________________\r\n$count will not return results, but instead return a count of the number of results that would have been returned had $count not been invoked.\r\n\r\n- $count=true invokes this function ($count=false is the default state); $count will honor $filter criteria.\r\n- You can (optionally) program your app to use the $count response value in conjunction with additional OData parameters to dictate a path through a logic tree should you choose to define one in your app. Here are a few examples:\r\n\r\nConditional use of $count to invoke $top - IF n>[$count value], THEN $top=n OR\r\n\r\nA $skip series: (e.g. $skip=null, $skip=25, $skip=50, etc.) - A series of responses with results 1-25, 26-50, 51-75, etc. until $skip=[$count value]-25 is reached) OR\r\n\r\nA $skip&$top series (e.g. $top=100 [omitting $skip in the 1st request in this series], $skip=100&$top=100, $skip=200&$top=100, etc.) – a series of larger responses with results 1-100, 101-200, and 201-300, etc. until $skip=[$count value]-100 is reached.)\r\n___________________________\r\n$inlinecount\r\n___________________________\r\n$inlinecount returns the result set and will in addition include a total count of all results.\r\n\r\n- $inlinecount=allpages invokes this function.\r\n- $inlinecount honors $filter criteria, i.e. the count value will reflect the filtered result set per any criteria applied by using the $filter parameter.\r\n___________________________\r\n$orderby\r\n___________________________\r\n$orderby allows sorting the result set according to the values in a specified response field.\r\n\r\n- $orderby expects a value that is a valid data attribute present within the route's response schema.\r\n- The default sorting mode of $orderby is ascending.\r\n- You may specify $orderby=fieldName desc to specify a descending sort order.\r\n___________________________\r\n$filter\r\n___________________________\r\n$filter is a powerful way to limit results by various criteria.\r\n\r\nFor routes that allow $filter, a syntactically exact sequence is expected that uses logical operators with valid data attributes from the response data schema. The \"List of OData $filter Operators\" (below) outlines the supported filter functions, including allowed operators, usage/syntax examples, & explanations that pertain to actual routes within the NextGen Enterprise API set.\r\n\r\n- The $filter parameter value is generally formatted as:\r\n\r\nfieldName logical_operator criteria \r\n\r\n- Specific examples follow in the list of $filter operators.\r\n- Multiple fieldName logical_operator criteria trios can be joined with certain Boolean functions (i.e. and & or). Avoid overly complex/compound use of Boolean conjunctions.\r\n- Most $filter criteria require very specific syntactic usage (see below for $filter usage details & correct examples):\r\n\r\nWhen filtering on a value that is <boolean> (either true or false), that value should be expressed without special syntax, e.g. $filter=fieldName eq true\r\n\r\nCriteria that are Strings must be bounded by single quotes, e.g. $filter=fieldName eq 'string_value' \r\n\r\nCriteria that are Guids must include the exact prefix guid followed immediately (no space) by the guid value bounded by single quotes; e.g. fieldName eq guid'00000000-0000-0000-0000-000000000000'\r\n\r\nCriteria that are date/time strings must be identified by starting the criteria portion with dateTime followed immediately (no space) by a single quote bounded (before and after) declaration of the dateTime value.\r\n\r\n- dateTime Usage Examples (also see the “List of OData $filter Operators” below for further examples, including joining multiple dateTime criteria with and & or):\r\n\r\nExample 1: fieldName gt dateTime'2020-05-31T23:59:59'\r\nExample 2: fieldName lt datetime'2020-07-01'\r\n______________________________________________________\r\nList of OData $filter Operators:\r\nDetails, Syntactic Requirements, and Usage Examples\r\n______________________________________________________\r\nOperator:\t\teq\r\n___________________________\r\nDescription:\tEqual to\r\nUsage Example:\tGET /endpoint?$filter=fieldName eq true\r\n\r\neq - Returns only the records where the binary attribute has a value of true. Unlike strings (see below), Binary values must not include quote boundaries.\r\n___________________________\r\nOperator:\t\tne\r\n___________________________\r\nDescription:\tNot Equal to\r\nUsage Example:\tGET /endpoint?$filter=fieldName ne 'string'\r\n\r\nne - This example will return resources where the fieldName value is not \"string\". Filter criteria that are strings must typically be bounded by single quotes as shown (boolean true/false values are the exception; see \"eq\" example above).\r\n___________________________\r\nOperator:\t\tgt\r\n___________________________\r\nDescription:\tGreater Than\r\nUsage Example:\t$filter=fieldName gt dateTime'2020-05-31T23:59:59'\r\n\r\ngt - Note the syntax is fieldName gt dateTime'YYYY-MM-DDTHH:MM:SS'. (T separates the date and time components of the dateTime expression.) The greater than operator is not the same as \"greater than or equal to\" (Note: the OData operator ge is not supported by NextGen APIs).\r\n___________________________\r\nOperator:\t\tlt\r\n___________________________\r\nDescription:\tLess Than\r\nUsage Example:\t$filter=fieldName lt datetime'2020-07-01'\r\n\r\nlt - Note the syntax is fieldName [operator] dateTime'YYYY-MM-DDTHH:MM:SS'. The less than operator is not the same as \"less than or equal to\" (Note: the OData operator le is not supported by NextGen APIs).\r\n___________________________\r\nOperator:\t\tand\r\n___________________________\r\nDescription:\tConjunction\r\nUsage Example:\t$filter= fieldName gt dateTime'2020-05-31T23:59:59' and fieldName lt datetime'2020-07-01T00:00:00'\r\n\r\nand - Requires each $filter criteria to be true. When used in conjunction with fields that have a dateTime value, “and\" is useful in establishing boundaries limiting responses to a specific date range.\r\n___________________________\r\nOperator:\t\tor\r\n___________________________\r\nDescription:\tInclusive Disjunction\r\nUsage Example:\t$filter= fieldName eq 'string1' or fieldName eq 'string2'\r\n\r\nor - Requires only one of the criteria to be true.\r\n___________________________\r\nOperator:\t\tstartswith\r\n___________________________\r\nDescription:\tRequires partial match at string start.\r\nUsage Example:\t$filter=startswith(fieldName, 'partial-string')\r\n\r\nstartswith - This operator is useful when you want to limit responses to the set that share the same beginning (but not entire) value for a given attribute. Note the single quotes are required around the partial string. This example limits the response set to results that have a fieldName value that starts with “partial-string”.\r\n___________________________\r\nOperator:\t\tendswith\r\n___________________________\r\nDescription:\tRequires partial match at string end.\r\nUsage Example:\t$filter=endswith(fieldName, 'partial-string')\r\n\r\nendswith - This operator is useful when you want to limit responses to the set that share the same ending (but not entire) value for a given attribute. Note the single quotes are required around the partial string.\r\n___________________________\r\nOperator:\t\tsubstringof\r\n___________________________\r\nDescription:\tRequires partial match anywhere within a string.\r\nUsage Example:\t$filter=substringof('partial-string', fieldName)\r\n\r\nsubstringof - This operator is useful when you want to limit responses to the set that share the same partial value anywhere within a specific attribute. Note that the syntax of substringof diverges from startswith & endswith - with substringof, the partial string is defined first and is then followed by the parameter name (whereas the opposite is true with the startswith & endswith functions).\r\n___________________________\r\n___________________________\r\nExpand the USCDI data categories below for individual routes, and select a route to show route-specific details.", | |
| "contact": {} | |
| }, | |
| "host": "nativeapi.nextgen.com", | |
| "basePath": "/nge/prod/nge-api/api", | |
| "securityDefinitions": {}, | |
| "schemes": [ | |
| "https" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "paths": { | |
| "/persons/{personId}/chart/allergies": { | |
| "get": { | |
| "description": "Returns a list of allergy summaries for the specified person id after applying additional OData query operations.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/allergies", | |
| "tags": [ | |
| "Allergies and Intolerances" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/allergies", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "$top", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$filter", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$orderby", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$skip", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$inlinecount", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$count", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose allergies are being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "Items": [ | |
| { | |
| "id": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "personId": "<string>", | |
| "encounterId": "<string>", | |
| "encounterTimestamp": "<string>", | |
| "encounterTimestampTimezone": "<string>", | |
| "allergyId": "<string>", | |
| "allergyTypeId": "<string>", | |
| "description": "<string>", | |
| "allergyType": "<string>", | |
| "locationId": "<string>", | |
| "providerId": "<string>", | |
| "onsetDate": "<string>", | |
| "resolvedDate": "<string>", | |
| "comment": "<string>", | |
| "reactionDescription": "<string>", | |
| "criticalityCode": "<string>", | |
| "isLocked": "<string>", | |
| "isReadOnly": "<string>", | |
| "rxNormCode": "<string>", | |
| "rxNormDescription": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "id": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "personId": "<string>", | |
| "encounterId": "<string>", | |
| "encounterTimestamp": "<string>", | |
| "encounterTimestampTimezone": "<string>", | |
| "allergyId": "<string>", | |
| "allergyTypeId": "<string>", | |
| "description": "<string>", | |
| "allergyType": "<string>", | |
| "locationId": "<string>", | |
| "providerId": "<string>", | |
| "onsetDate": "<string>", | |
| "resolvedDate": "<string>", | |
| "comment": "<string>", | |
| "reactionDescription": "<string>", | |
| "criticalityCode": "<string>", | |
| "isLocked": "<string>", | |
| "isReadOnly": "<string>", | |
| "rxNormCode": "<string>", | |
| "rxNormDescription": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ], | |
| "NextPageLink": "<string>", | |
| "Count": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/allergies/{allergyId}": { | |
| "get": { | |
| "description": "Gets the allergy details for the given person id and allergy id.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/allergies/:allergyId", | |
| "tags": [ | |
| "Allergies and Intolerances" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/allergies/:allergyId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose allergies are being retrieved" | |
| }, | |
| { | |
| "name": "allergyId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the allergy being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "id": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "personId": "<string>", | |
| "encounterId": "<string>", | |
| "encounterTimestamp": "<string>", | |
| "encounterTimestampTimezone": "<string>", | |
| "allergyId": "<string>", | |
| "allergyType": "<string>", | |
| "allergyTypeId": "<string>", | |
| "locationId": "<string>", | |
| "locationName": "<string>", | |
| "providerId": "<string>", | |
| "providerName": "<string>", | |
| "onsetDate": "<string>", | |
| "resolvedDate": "<string>", | |
| "comment": "<string>", | |
| "reactionDescription": "<string>", | |
| "sourceProductId": "<string>", | |
| "auditId": "<string>", | |
| "causativeAgent": "<string>", | |
| "whoReviewed": "<string>", | |
| "whenReviewed": "<string>", | |
| "isLocked": "<string>", | |
| "severityCode": "<string>", | |
| "isIntolerant": "<string>", | |
| "description": "<string>", | |
| "criticalityCode": "<string>", | |
| "createdBy": "<string>", | |
| "createTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "modifiedBy": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "modifyTimestampTimezone": "<string>", | |
| "isReadOnly": "<string>", | |
| "rxNormCode": "<string>", | |
| "rxNormDescription": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/allergies/{allergyId}/dur-check": { | |
| "get": { | |
| "description": "StartFragmentGets a list of interactions for a given allergyId.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/allergies/:allergyId/dur-check", | |
| "tags": [ | |
| "Allergies and Intolerances" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/allergies/:allergyId/dur-check", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose allergies are being retrieved" | |
| }, | |
| { | |
| "name": "allergyId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the allergy being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "id": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "personId": "<string>", | |
| "encounterId": "<string>", | |
| "encounterTimestamp": "<string>", | |
| "encounterTimestampTimezone": "<string>", | |
| "allergyId": "<string>", | |
| "allergyType": "<string>", | |
| "allergyTypeId": "<string>", | |
| "locationId": "<string>", | |
| "locationName": "<string>", | |
| "providerId": "<string>", | |
| "providerName": "<string>", | |
| "onsetDate": "<string>", | |
| "resolvedDate": "<string>", | |
| "comment": "<string>", | |
| "reactionDescription": "<string>", | |
| "sourceProductId": "<string>", | |
| "auditId": "<string>", | |
| "causativeAgent": "<string>", | |
| "whoReviewed": "<string>", | |
| "whenReviewed": "<string>", | |
| "isLocked": "<string>", | |
| "severityCode": "<string>", | |
| "isIntolerant": "<string>", | |
| "description": "<string>", | |
| "criticalityCode": "<string>", | |
| "createdBy": "<string>", | |
| "createTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "modifiedBy": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "modifyTimestampTimezone": "<string>", | |
| "isReadOnly": "<string>", | |
| "rxNormCode": "<string>", | |
| "rxNormDescription": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/deleted-allergies": { | |
| "get": { | |
| "description": "Gets a list of patient deleted allergies after applying additional OData operations.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/deleted-allergies", | |
| "tags": [ | |
| "Allergies and Intolerances" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/deleted-allergies", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "$top", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$filter", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$orderby", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$skip", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$inlinecount", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$count", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose allergies are being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "Items": [ | |
| { | |
| "id": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "personId": "<string>", | |
| "encounterId": "<string>", | |
| "encounterTimestamp": "<string>", | |
| "encounterTimestampTimezone": "<string>", | |
| "allergyId": "<string>", | |
| "allergyTypeId": "<string>", | |
| "description": "<string>", | |
| "allergyType": "<string>", | |
| "locationId": "<string>", | |
| "providerId": "<string>", | |
| "onsetDate": "<string>", | |
| "resolvedDate": "<string>", | |
| "comment": "<string>", | |
| "reactionDescription": "<string>", | |
| "criticalityCode": "<string>", | |
| "isLocked": "<string>", | |
| "isReadOnly": "<string>", | |
| "rxNormCode": "<string>", | |
| "rxNormDescription": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "id": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "personId": "<string>", | |
| "encounterId": "<string>", | |
| "encounterTimestamp": "<string>", | |
| "encounterTimestampTimezone": "<string>", | |
| "allergyId": "<string>", | |
| "allergyTypeId": "<string>", | |
| "description": "<string>", | |
| "allergyType": "<string>", | |
| "locationId": "<string>", | |
| "providerId": "<string>", | |
| "onsetDate": "<string>", | |
| "resolvedDate": "<string>", | |
| "comment": "<string>", | |
| "reactionDescription": "<string>", | |
| "criticalityCode": "<string>", | |
| "isLocked": "<string>", | |
| "isReadOnly": "<string>", | |
| "rxNormCode": "<string>", | |
| "rxNormDescription": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ], | |
| "NextPageLink": "<string>", | |
| "Count": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/encounters/{encounterId}/allergies": { | |
| "get": { | |
| "description": "Gets a list of allergy summaries for the given person id and encounter id, with the option of including resolved allergies.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/allergies", | |
| "tags": [ | |
| "Allergies and Intolerances" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/allergies", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "includeResolved", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "A true or false value that includes or excludes allergies that are resolved" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose allergies are being retrieved" | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the encounter in which the allergies were added" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK4" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "id": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "personId": "<string>", | |
| "encounterId": "<string>", | |
| "encounterTimestamp": "<string>", | |
| "encounterTimestampTimezone": "<string>", | |
| "allergyId": "<string>", | |
| "allergyTypeId": "<string>", | |
| "description": "<string>", | |
| "allergyType": "<string>", | |
| "locationId": "<string>", | |
| "providerId": "<string>", | |
| "onsetDate": "<string>", | |
| "resolvedDate": "<string>", | |
| "comment": "<string>", | |
| "reactionDescription": "<string>", | |
| "criticalityCode": "<string>", | |
| "isLocked": "<string>", | |
| "isReadOnly": "<string>", | |
| "rxNormCode": "<string>", | |
| "rxNormDescription": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "post": { | |
| "description": "Add the allergy to patient's encounter", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/allergies", | |
| "tags": [ | |
| "Allergies and Intolerances" | |
| ], | |
| "operationId": "Post{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/allergies", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose allergy is being added" | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the encounter to which the patient allergy belongs" | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1encounters~1%3AencounterId~1allergiesRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/encounters/{encounterId}/allergies/{allergyId}": { | |
| "delete": { | |
| "description": "Delete a patient's allergy", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/allergies/:allergyId", | |
| "tags": [ | |
| "Allergies and Intolerances" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/allergies/:allergyId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose allergy is being deleted" | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the encounter to which the patient allergy belongs" | |
| }, | |
| { | |
| "name": "allergyId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient's allergy to be deleted" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "get": { | |
| "description": "Gets the allergy details for the given person id, encounter id, and allergy id.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/allergies/:allergyId1", | |
| "tags": [ | |
| "Allergies and Intolerances" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/allergies/:allergyId1", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose allergies are being retrieved" | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the encounter in which the allergy was added" | |
| }, | |
| { | |
| "name": "allergyId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the allergy being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "id": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "personId": "<string>", | |
| "encounterId": "<string>", | |
| "encounterTimestamp": "<string>", | |
| "encounterTimestampTimezone": "<string>", | |
| "allergyId": "<string>", | |
| "allergyType": "<string>", | |
| "allergyTypeId": "<string>", | |
| "locationId": "<string>", | |
| "locationName": "<string>", | |
| "providerId": "<string>", | |
| "providerName": "<string>", | |
| "onsetDate": "<string>", | |
| "resolvedDate": "<string>", | |
| "comment": "<string>", | |
| "reactionDescription": "<string>", | |
| "sourceProductId": "<string>", | |
| "auditId": "<string>", | |
| "causativeAgent": "<string>", | |
| "whoReviewed": "<string>", | |
| "whenReviewed": "<string>", | |
| "isLocked": "<string>", | |
| "severityCode": "<string>", | |
| "isIntolerant": "<string>", | |
| "description": "<string>", | |
| "criticalityCode": "<string>", | |
| "createdBy": "<string>", | |
| "createTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "modifiedBy": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "modifyTimestampTimezone": "<string>", | |
| "isReadOnly": "<string>", | |
| "rxNormCode": "<string>", | |
| "rxNormDescription": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "put": { | |
| "description": "Update a patient allergy", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/allergies/:allergyId", | |
| "tags": [ | |
| "Allergies and Intolerances" | |
| ], | |
| "operationId": "Put{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/allergies/:allergyId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose allergy is being updated" | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the encounter to which the patient allergy belongs" | |
| }, | |
| { | |
| "name": "allergyId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient's allergy to be updated" | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1encounters~1%3AencounterId~1allergies~1%3AallergyIdRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/encounters/{encounterId}/allergies/{allergyId}/reactions": { | |
| "get": { | |
| "description": "Gets a list of reactions a patient experiences for the given allergy id.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/allergies/:allergyId/reactions", | |
| "tags": [ | |
| "Allergies and Intolerances" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/allergies/:allergyId/reactions", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose allergies are being retrieved" | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the encounter to which the patient allergy belongs" | |
| }, | |
| { | |
| "name": "allergyId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the allergy being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK6" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "id": "<string>", | |
| "patientAllergyId": "<string>", | |
| "reactionDescription": "<string>", | |
| "snomedCode": "<string>", | |
| "severityCode": "<string>", | |
| "severityDescription": "<string>", | |
| "rank": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "post": { | |
| "description": "Adds a reaction that the patient experiences for the given allergy id", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/allergies/:allergyId/reactions", | |
| "tags": [ | |
| "Allergies and Intolerances" | |
| ], | |
| "operationId": "Post{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/allergies/:allergyId/reactions", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose allergy reaction is being added" | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the encounter to which the patient allergy belongs" | |
| }, | |
| { | |
| "name": "allergyId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient's allergy to which the reaction belongs" | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1encounters~1%3AencounterId~1allergies~1%3AallergyId~1reactionsRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/encounters/{encounterId}/allergies/{allergyId}/reactions/{reactionId}": { | |
| "delete": { | |
| "description": "Deletes a reaction that the patient experiences for the given allergy id", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/allergies/:allergyId/reactions/:reactionId", | |
| "tags": [ | |
| "Allergies and Intolerances" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/allergies/:allergyId/reactions/:reactionId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose allergy reaction is being deleted" | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the encounter to which the patient allergy belongs" | |
| }, | |
| { | |
| "name": "allergyId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient's allergy to which the reaction belongs" | |
| }, | |
| { | |
| "name": "reactionId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient's allergy reaction to be deleted" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "put": { | |
| "description": "Updates a reaction that the patient experiences for the given allergy id", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/allergies/:allergyId/reactions/:reactionId", | |
| "tags": [ | |
| "Allergies and Intolerances" | |
| ], | |
| "operationId": "Put{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/allergies/:allergyId/reactions/:reactionId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose allergy reaction is being updated" | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the encounter to which the patient allergy belongs" | |
| }, | |
| { | |
| "name": "allergyId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient's allergy to which the reaction belongs" | |
| }, | |
| { | |
| "name": "reactionId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient's allergy reaction to be updated" | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1encounters~1%3AencounterId~1allergies~1%3AallergyId~1reactions~1%3AreactionIdRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/health-concerns/allergies": { | |
| "get": { | |
| "description": "Gets a patient's health concerns allergies.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/health-concerns/allergies", | |
| "tags": [ | |
| "Allergies and Intolerances" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/health-concerns/allergies", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "$top", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$filter", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$orderby", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$skip", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$inlinecount", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$count", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose health concerns allergies are being retrieved." | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK7" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "Items": [ | |
| { | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "encounterId": "<string>", | |
| "personId": "<string>", | |
| "snomedConceptId": "<string>", | |
| "dateOnset": "<string>", | |
| "dateResolved": "<string>", | |
| "allergyType": "<string>", | |
| "encounterTimestamp": "<string>", | |
| "allergyComment": "<string>", | |
| "id": "<string>", | |
| "category": "<string>", | |
| "healthConcern": "<string>", | |
| "description": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "encounterId": "<string>", | |
| "personId": "<string>", | |
| "snomedConceptId": "<string>", | |
| "dateOnset": "<string>", | |
| "dateResolved": "<string>", | |
| "allergyType": "<string>", | |
| "encounterTimestamp": "<string>", | |
| "allergyComment": "<string>", | |
| "id": "<string>", | |
| "category": "<string>", | |
| "healthConcern": "<string>", | |
| "description": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ], | |
| "NextPageLink": "<string>", | |
| "Count": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/assessments": { | |
| "get": { | |
| "description": "Gets all assessment plans for the specified patient.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/assessments", | |
| "tags": [ | |
| "Assessment and Plan of Treatment" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/assessments", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "$top", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$filter", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$orderby", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$skip", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$inlinecount", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$count", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required)" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK8" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "Items": [ | |
| { | |
| "id": "<string>", | |
| "personId": "<string>", | |
| "encounterId": "<string>", | |
| "encounterDate": "<string>", | |
| "practiceId": "<string>", | |
| "enterpriseId": "<string>", | |
| "aip": "<string>", | |
| "aipPriority": "<string>", | |
| "description": "<string>", | |
| "diagnosisCode": "<string>", | |
| "diagnosisId": "<string>", | |
| "encounterDiagnosisPriority": "<string>", | |
| "icd9cmCodeId": "<string>", | |
| "reportDisplay": "<string>", | |
| "axis": "<string>", | |
| "chiefComplaint": "<string>", | |
| "detailType": "<string>", | |
| "detailTypePriority": "<string>", | |
| "differentialDiagnosis": "<string>", | |
| "episode": "<string>", | |
| "side": "<string>", | |
| "site": "<string>", | |
| "hasHistoryRecord": "<string>", | |
| "specifiers": "<string>", | |
| "isSupplemental": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "id": "<string>", | |
| "personId": "<string>", | |
| "encounterId": "<string>", | |
| "encounterDate": "<string>", | |
| "practiceId": "<string>", | |
| "enterpriseId": "<string>", | |
| "aip": "<string>", | |
| "aipPriority": "<string>", | |
| "description": "<string>", | |
| "diagnosisCode": "<string>", | |
| "diagnosisId": "<string>", | |
| "encounterDiagnosisPriority": "<string>", | |
| "icd9cmCodeId": "<string>", | |
| "reportDisplay": "<string>", | |
| "axis": "<string>", | |
| "chiefComplaint": "<string>", | |
| "detailType": "<string>", | |
| "detailTypePriority": "<string>", | |
| "differentialDiagnosis": "<string>", | |
| "episode": "<string>", | |
| "side": "<string>", | |
| "site": "<string>", | |
| "hasHistoryRecord": "<string>", | |
| "specifiers": "<string>", | |
| "isSupplemental": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ], | |
| "NextPageLink": "<string>", | |
| "Count": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/care-plan-assessments": { | |
| "get": { | |
| "description": "Returns care plan assessments for a patient.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/care-plan-assessments", | |
| "tags": [ | |
| "Assessment and Plan of Treatment" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/care-plan-assessments", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "$top", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$filter", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$orderby", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$skip", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$inlinecount", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$count", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required)" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK8" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "Items": [ | |
| { | |
| "id": "<string>", | |
| "personId": "<string>", | |
| "encounterId": "<string>", | |
| "encounterDate": "<string>", | |
| "practiceId": "<string>", | |
| "enterpriseId": "<string>", | |
| "aip": "<string>", | |
| "aipPriority": "<string>", | |
| "description": "<string>", | |
| "diagnosisCode": "<string>", | |
| "diagnosisId": "<string>", | |
| "encounterDiagnosisPriority": "<string>", | |
| "icd9cmCodeId": "<string>", | |
| "reportDisplay": "<string>", | |
| "axis": "<string>", | |
| "chiefComplaint": "<string>", | |
| "detailType": "<string>", | |
| "detailTypePriority": "<string>", | |
| "differentialDiagnosis": "<string>", | |
| "episode": "<string>", | |
| "side": "<string>", | |
| "site": "<string>", | |
| "hasHistoryRecord": "<string>", | |
| "specifiers": "<string>", | |
| "isSupplemental": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "id": "<string>", | |
| "personId": "<string>", | |
| "encounterId": "<string>", | |
| "encounterDate": "<string>", | |
| "practiceId": "<string>", | |
| "enterpriseId": "<string>", | |
| "aip": "<string>", | |
| "aipPriority": "<string>", | |
| "description": "<string>", | |
| "diagnosisCode": "<string>", | |
| "diagnosisId": "<string>", | |
| "encounterDiagnosisPriority": "<string>", | |
| "icd9cmCodeId": "<string>", | |
| "reportDisplay": "<string>", | |
| "axis": "<string>", | |
| "chiefComplaint": "<string>", | |
| "detailType": "<string>", | |
| "detailTypePriority": "<string>", | |
| "differentialDiagnosis": "<string>", | |
| "episode": "<string>", | |
| "side": "<string>", | |
| "site": "<string>", | |
| "hasHistoryRecord": "<string>", | |
| "specifiers": "<string>", | |
| "isSupplemental": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ], | |
| "NextPageLink": "<string>", | |
| "Count": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/health-concerns/assessment-scales": { | |
| "get": { | |
| "description": "Gets a patient's health concerns assessment scale for health concern.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/health-concerns/assessment-scales", | |
| "tags": [ | |
| "Assessment and Plan of Treatment" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/health-concerns/assessment-scales", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "$top", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$filter", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$orderby", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$skip", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$inlinecount", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$count", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose health concerns assessment scale are being retrieved." | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK10" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "Items": [ | |
| { | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "personId": "<string>", | |
| "id": "<string>", | |
| "completedDate": "<string>", | |
| "instrument": "<string>", | |
| "score": "<string>", | |
| "severity": "<string>", | |
| "encounterDate": "<string>", | |
| "createTimestamp": "<string>", | |
| "healthConcern": "<string>", | |
| "category": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "personId": "<string>", | |
| "id": "<string>", | |
| "completedDate": "<string>", | |
| "instrument": "<string>", | |
| "score": "<string>", | |
| "severity": "<string>", | |
| "encounterDate": "<string>", | |
| "createTimestamp": "<string>", | |
| "healthConcern": "<string>", | |
| "category": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ], | |
| "NextPageLink": "<string>", | |
| "Count": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/care-team-members": { | |
| "get": { | |
| "description": "Returns a list of care team members for the specified person id after applying additional OData query operations.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/care-team-members", | |
| "tags": [ | |
| "Care Team Members" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/care-team-members", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "$top", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$filter", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$orderby", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$skip", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$inlinecount", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$count", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose care team members are being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK11" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "Items": [ | |
| { | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "personId": "<string>", | |
| "id": "<string>", | |
| "providerId": "<string>", | |
| "encounterId": "<string>", | |
| "firstName": "<string>", | |
| "lastName": "<string>", | |
| "email": "<string>", | |
| "activeDate": "<string>", | |
| "inactiveDate": "<string>", | |
| "address": "<string>", | |
| "city": "<string>", | |
| "state": "<string>", | |
| "zip": "<string>", | |
| "homePhone": "<string>", | |
| "cellPhone": "<string>", | |
| "fax": "<string>", | |
| "agencyName": "<string>", | |
| "agencyType": "<string>", | |
| "patientRelationship": "<string>", | |
| "supportRole": "<string>", | |
| "specialty": "<string>", | |
| "roleClass": "<string>", | |
| "roleCode": "<string>", | |
| "isReadOnly": "<string>", | |
| "status": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "personId": "<string>", | |
| "id": "<string>", | |
| "providerId": "<string>", | |
| "encounterId": "<string>", | |
| "firstName": "<string>", | |
| "lastName": "<string>", | |
| "email": "<string>", | |
| "activeDate": "<string>", | |
| "inactiveDate": "<string>", | |
| "address": "<string>", | |
| "city": "<string>", | |
| "state": "<string>", | |
| "zip": "<string>", | |
| "homePhone": "<string>", | |
| "cellPhone": "<string>", | |
| "fax": "<string>", | |
| "agencyName": "<string>", | |
| "agencyType": "<string>", | |
| "patientRelationship": "<string>", | |
| "supportRole": "<string>", | |
| "specialty": "<string>", | |
| "roleClass": "<string>", | |
| "roleCode": "<string>", | |
| "isReadOnly": "<string>", | |
| "status": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ], | |
| "NextPageLink": "<string>", | |
| "Count": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "post": { | |
| "description": "Add care team member for the specified person id", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/care-team-members", | |
| "tags": [ | |
| "Care Team Members" | |
| ], | |
| "operationId": "Post{{baseUrl}}/persons/:personId/chart/care-team-members", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose care team members are being saved" | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1care-team-members-Request" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "string", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": "<string>" | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/care-team-members/{careTeamMemberId}": { | |
| "delete": { | |
| "description": "Deletes a patient's care team member", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/care-team-members/:careTeamMemberId", | |
| "tags": [ | |
| "Care Team Members" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/care-team-members/:careTeamMemberId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of patient whose care team member record is being deleted" | |
| }, | |
| { | |
| "name": "careTeamMemberId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the care team member being deleted" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "put": { | |
| "description": "Updates a patient's care team member record", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/care-team-members/:careTeamMemberId", | |
| "tags": [ | |
| "Care Team Members" | |
| ], | |
| "operationId": "Put{{baseUrl}}/persons/:personId/chart/care-team-members/:careTeamMemberId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of patient whose care team member record is being updated" | |
| }, | |
| { | |
| "name": "careTeamMemberId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the care team member being updated" | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1care-team-members~1%3AcareTeamMemberId-Request" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/clinical-notes": { | |
| "get": { | |
| "description": "Gets a list of clinical notes after performing additional OData query operations.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/clinical-notes", | |
| "tags": [ | |
| "Clinical Notes" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/clinical-notes", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "$top", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$filter", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$orderby", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$skip", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$inlinecount", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$count", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose documents are being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK12" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "id": "<string>", | |
| "personId": "<string>", | |
| "description": "<string>", | |
| "itemType": "<string>", | |
| "createTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "modifyTimestampTimezone": "<string>", | |
| "encounterId": "<string>", | |
| "isRestricted": "<string>", | |
| "signoffStatus": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/encounters/{encounterId}/clinical-notes": { | |
| "get": { | |
| "description": "Gets a list of clinical notes for a given encounter.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/clinical-notes", | |
| "tags": [ | |
| "Clinical Notes" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/clinical-notes", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "$top", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$filter", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$orderby", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$skip", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$inlinecount", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$count", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose documents are being retrieved" | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK12" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "id": "<string>", | |
| "personId": "<string>", | |
| "description": "<string>", | |
| "itemType": "<string>", | |
| "createTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "modifyTimestampTimezone": "<string>", | |
| "encounterId": "<string>", | |
| "isRestricted": "<string>", | |
| "signoffStatus": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/documents": { | |
| "get": { | |
| "description": "Gets a list of documents for the specified person id after performing additional OData query operations.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/documents", | |
| "tags": [ | |
| "Clinical Notes" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/documents", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "$top", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$filter", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$orderby", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$skip", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$inlinecount", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$count", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose documents are being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK12" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "id": "<string>", | |
| "personId": "<string>", | |
| "description": "<string>", | |
| "itemType": "<string>", | |
| "createTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "modifyTimestampTimezone": "<string>", | |
| "encounterId": "<string>", | |
| "isRestricted": "<string>", | |
| "signoffStatus": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/documents/{documentId}": { | |
| "get": { | |
| "description": "Gets the document details for the given person id and document id.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/documents/:documentId", | |
| "tags": [ | |
| "Clinical Notes" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/documents/:documentId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose document is being retrieved" | |
| }, | |
| { | |
| "name": "documentId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the document being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK15" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "id": "<string>", | |
| "personId": "<string>", | |
| "description": "<string>", | |
| "itemType": "<string>", | |
| "createTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "modifyTimestampTimezone": "<string>", | |
| "encounterId": "<string>", | |
| "categories": [ | |
| "<string>", | |
| "<string>" | |
| ], | |
| "totalPages": "<string>", | |
| "icsDateOfService": "<string>", | |
| "encounterTimestamp": "<string>", | |
| "appCreatedBy": "<string>", | |
| "docTypeId": "<string>", | |
| "isRestricted": "<string>", | |
| "signoffStatus": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/documents/{documentId}/pdf": { | |
| "get": { | |
| "description": "Gets the full document in pdf format for the given person id and document id.\r\n\r\nResponse will include PDF encoded binary content:\r\n\r\n%PDF\r\n...\r\n%EOF)\r\n\r\n200 response details show JSON component of response.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/documents/:documentId/pdf", | |
| "tags": [ | |
| "Clinical Notes" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/documents/:documentId/pdf", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose document is being retrieved." | |
| }, | |
| { | |
| "name": "documentId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the document being retrieved." | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK16" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "FileBytes": "<string>", | |
| "FileName": "<string>", | |
| "MimeType": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/encounters/{encounterId}/documents": { | |
| "post": { | |
| "description": "Adds a document for the specified person and encounter.\r\n\r\nThis POST route does not use a simple JSON request body - this route requires a multipart/form-data request structure (and a Content-Type header of multipart/form-data that also includes a boundary definition).\r\nComments (which each begin with //DELETE ME) have been inserted into the POST body in this documentation. Removing each of these comment lines will result in a valid request body schema.\r\n\r\nWhen comments are removed and values are entered for each variable request element, this will result in a request body with the structure shown in the example below:\r\n\r\nExample Request Header:\r\n\r\n\"Content-Type\": \"multipart/form data; boundary=threequarksformustermark\"\r\n\r\nExample Multipart Request Body: \r\n\r\n--thr33quarks4mustermark\r\nContent-Disposition: form-data; name=\"request\"\r\nContent-Type: application/json\r\n{\r\n\"documentType\": \"EHRImage\",\r\n\"fileDescription\": \"Text Description of Document to Appear in UI\"\r\n}\r\n\r\n--thr33quarks4mustermark\r\nContent-Disposition: form-data; name=\"file\"; filename=\"this-will-be-the-filename.PDF\"\r\nContent-Type: application/pdf\r\n\r\n%PDF-1.7\r\n%µµµµ\r\n //truncated for brevity;\r\n%%EOF\r\n\r\n--thr33quarks4mustermark--", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/documents", | |
| "tags": [ | |
| "Clinical Notes" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/documents", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The person identifier." | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The encounter id to associate this document with." | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "example": "<string>", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/care-plan/goals": { | |
| "get": { | |
| "description": "Gets a patient's care plan goals.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/care-plan/goals", | |
| "tags": [ | |
| "Goals" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/care-plan/goals", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "$top", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$filter", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$orderby", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$skip", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$inlinecount", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$count", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose goals are being fetched" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK17" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "Items": [ | |
| { | |
| "goalId": "<string>", | |
| "personId": "<string>", | |
| "encounterId": "<string>", | |
| "healthConcernId": "<string>", | |
| "codeDescription": "<string>", | |
| "codeSystem": "<string>", | |
| "codeValue": "<string>", | |
| "comments": "<string>", | |
| "isDeleted": "<string>", | |
| "description": "<string>", | |
| "isGoalAchieved": "<string>", | |
| "goalAchievedDetails": "<string>", | |
| "goalCompletionDate": "<string>", | |
| "goalStartDate": "<string>", | |
| "isPatientGoal": "<string>", | |
| "patientPriority": "<string>", | |
| "isProviderGoal": "<string>", | |
| "providerPriority": "<string>", | |
| "documentedBy": "<string>", | |
| "encounterDate": "<string>", | |
| "sequenceNumber": "<string>", | |
| "createdBy": "<string>", | |
| "createTimestamp": "<string>", | |
| "modifiedBy": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "modifyTimestampTimezone": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "goalId": "<string>", | |
| "personId": "<string>", | |
| "encounterId": "<string>", | |
| "healthConcernId": "<string>", | |
| "codeDescription": "<string>", | |
| "codeSystem": "<string>", | |
| "codeValue": "<string>", | |
| "comments": "<string>", | |
| "isDeleted": "<string>", | |
| "description": "<string>", | |
| "isGoalAchieved": "<string>", | |
| "goalAchievedDetails": "<string>", | |
| "goalCompletionDate": "<string>", | |
| "goalStartDate": "<string>", | |
| "isPatientGoal": "<string>", | |
| "patientPriority": "<string>", | |
| "isProviderGoal": "<string>", | |
| "providerPriority": "<string>", | |
| "documentedBy": "<string>", | |
| "encounterDate": "<string>", | |
| "sequenceNumber": "<string>", | |
| "createdBy": "<string>", | |
| "createTimestamp": "<string>", | |
| "modifiedBy": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "modifyTimestampTimezone": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ], | |
| "NextPageLink": "<string>", | |
| "Count": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/encounters/{encounterId}/care-plan/health-concerns/{healthConcernId}/goals": { | |
| "get": { | |
| "description": "Gets a patient's care plan goals for a specified encounter and health concern.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId/goals", | |
| "tags": [ | |
| "Goals" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId/goals", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "$top", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$filter", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$orderby", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$skip", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$inlinecount", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$count", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose goals are being fetched" | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient encounter whose goals are being fetched" | |
| }, | |
| { | |
| "name": "healthConcernId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the health concern whose goals are being fetched" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK17" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "Items": [ | |
| { | |
| "goalId": "<string>", | |
| "personId": "<string>", | |
| "encounterId": "<string>", | |
| "healthConcernId": "<string>", | |
| "codeDescription": "<string>", | |
| "codeSystem": "<string>", | |
| "codeValue": "<string>", | |
| "comments": "<string>", | |
| "isDeleted": "<string>", | |
| "description": "<string>", | |
| "isGoalAchieved": "<string>", | |
| "goalAchievedDetails": "<string>", | |
| "goalCompletionDate": "<string>", | |
| "goalStartDate": "<string>", | |
| "isPatientGoal": "<string>", | |
| "patientPriority": "<string>", | |
| "isProviderGoal": "<string>", | |
| "providerPriority": "<string>", | |
| "documentedBy": "<string>", | |
| "encounterDate": "<string>", | |
| "sequenceNumber": "<string>", | |
| "createdBy": "<string>", | |
| "createTimestamp": "<string>", | |
| "modifiedBy": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "modifyTimestampTimezone": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "goalId": "<string>", | |
| "personId": "<string>", | |
| "encounterId": "<string>", | |
| "healthConcernId": "<string>", | |
| "codeDescription": "<string>", | |
| "codeSystem": "<string>", | |
| "codeValue": "<string>", | |
| "comments": "<string>", | |
| "isDeleted": "<string>", | |
| "description": "<string>", | |
| "isGoalAchieved": "<string>", | |
| "goalAchievedDetails": "<string>", | |
| "goalCompletionDate": "<string>", | |
| "goalStartDate": "<string>", | |
| "isPatientGoal": "<string>", | |
| "patientPriority": "<string>", | |
| "isProviderGoal": "<string>", | |
| "providerPriority": "<string>", | |
| "documentedBy": "<string>", | |
| "encounterDate": "<string>", | |
| "sequenceNumber": "<string>", | |
| "createdBy": "<string>", | |
| "createTimestamp": "<string>", | |
| "modifiedBy": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "modifyTimestampTimezone": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ], | |
| "NextPageLink": "<string>", | |
| "Count": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "post": { | |
| "description": "Creates a new care plan goal for a patient for specified encounter and health concern", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId/goals", | |
| "tags": [ | |
| "Goals" | |
| ], | |
| "operationId": "Post{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId/goals", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) id of the Patient" | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) id of the encounter" | |
| }, | |
| { | |
| "name": "healthConcernId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) id of Health Concern" | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1encounters~1%3AencounterId~1care-plan~1health-concerns~1%3AhealthConcernId~1goals-Request" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/encounters/{encounterId}/care-plan/health-concerns/{healthConcernId}/goals/{goalId}": { | |
| "delete": { | |
| "description": "Delete a Care Plan Goal", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId/goals/:goalId", | |
| "tags": [ | |
| "Goals" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId/goals/:goalId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient" | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient encounter" | |
| }, | |
| { | |
| "name": "healthConcernId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the health concern" | |
| }, | |
| { | |
| "name": "goalId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) Care plan goal id of patient" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "get": { | |
| "description": "Gets a patient's care plan goal details.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId/goals/:goalId1", | |
| "tags": [ | |
| "Goals" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId/goals/:goalId1", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient" | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the encounter" | |
| }, | |
| { | |
| "name": "healthConcernId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the health concern" | |
| }, | |
| { | |
| "name": "goalId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the goal" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK19" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "goalId": "<string>", | |
| "personId": "<string>", | |
| "encounterId": "<string>", | |
| "healthConcernId": "<string>", | |
| "codeDescription": "<string>", | |
| "codeSystem": "<string>", | |
| "codeValue": "<string>", | |
| "comments": "<string>", | |
| "isDeleted": "<string>", | |
| "description": "<string>", | |
| "isGoalAchieved": "<string>", | |
| "goalAchievedDetails": "<string>", | |
| "goalCompletionDate": "<string>", | |
| "goalStartDate": "<string>", | |
| "isPatientGoal": "<string>", | |
| "patientPriority": "<string>", | |
| "isProviderGoal": "<string>", | |
| "providerPriority": "<string>", | |
| "documentedBy": "<string>", | |
| "encounterDate": "<string>", | |
| "sequenceNumber": "<string>", | |
| "createdBy": "<string>", | |
| "createTimestamp": "<string>", | |
| "modifiedBy": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "modifyTimestampTimezone": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "put": { | |
| "description": "Update patient's careplan goal.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId/goals/:goalId", | |
| "tags": [ | |
| "Goals" | |
| ], | |
| "operationId": "Put{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId/goals/:goalId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient" | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) Encounter id of the patient" | |
| }, | |
| { | |
| "name": "healthConcernId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) Care plan health concern id of the patient" | |
| }, | |
| { | |
| "name": "goalId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) Care plan goal id of the patient" | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1encounters~1%3AencounterId~1care-plan~1health-concerns~1%3AhealthConcernId~1goals~1%3AgoalId-Request" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/encounters/{encounterId}/care-plan/health-concerns/{healthConcernId}/goals/{goalId}/interventions": { | |
| "get": { | |
| "description": "Returns a list of interventions for the specified person id, encounter id, health concern id and goal id after applying additional OData query operations.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId/goals/:goalId/interventions", | |
| "tags": [ | |
| "Goals" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId/goals/:goalId/interventions", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "$top", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$filter", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$orderby", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$skip", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$inlinecount", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$count", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose interventions are being retrieved" | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the encounter whose interventions are being retrieved" | |
| }, | |
| { | |
| "name": "healthConcernId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the health concern whose interventions are being retrieved" | |
| }, | |
| { | |
| "name": "goalId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the goal whose interventions are being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK20" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "Items": [ | |
| { | |
| "id": "<string>", | |
| "healthConcernId": "<string>", | |
| "goalId": "<string>", | |
| "detail": "<string>", | |
| "category": "<string>", | |
| "frequency": "<string>", | |
| "progress": "<string>", | |
| "reviewDate": "<string>", | |
| "startDate": "<string>", | |
| "status": "<string>", | |
| "codeDescription": "<string>", | |
| "codeSystem": "<string>", | |
| "codeValue": "<string>", | |
| "isDeleted": "<string>", | |
| "personId": "<string>", | |
| "encounterId": "<string>", | |
| "createdBy": "<string>", | |
| "createTimestamp": "<string>", | |
| "modifiedBy": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "modifyTimestampTimezone": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "id": "<string>", | |
| "healthConcernId": "<string>", | |
| "goalId": "<string>", | |
| "detail": "<string>", | |
| "category": "<string>", | |
| "frequency": "<string>", | |
| "progress": "<string>", | |
| "reviewDate": "<string>", | |
| "startDate": "<string>", | |
| "status": "<string>", | |
| "codeDescription": "<string>", | |
| "codeSystem": "<string>", | |
| "codeValue": "<string>", | |
| "isDeleted": "<string>", | |
| "personId": "<string>", | |
| "encounterId": "<string>", | |
| "createdBy": "<string>", | |
| "createTimestamp": "<string>", | |
| "modifiedBy": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "modifyTimestampTimezone": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ], | |
| "NextPageLink": "<string>", | |
| "Count": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "post": { | |
| "description": "Add new intervention details", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId/goals/:goalId/interventions", | |
| "tags": [ | |
| "Goals" | |
| ], | |
| "operationId": "Post{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId/goals/:goalId/interventions", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient" | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient encounter" | |
| }, | |
| { | |
| "name": "healthConcernId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the health concern" | |
| }, | |
| { | |
| "name": "goalId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) Care plan goal id of patient" | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1encounters~1%3AencounterId~1care-plan~1health-concerns~1%3AhealthConcernId~1goals~1%3AgoalId~1interventions-Request" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/encounters/{encounterId}/care-plan/health-concerns/{healthConcernId}/goals/{goalId}/interventions/{interventionId}": { | |
| "delete": { | |
| "description": "Delete Patient intervention details", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId/goals/:goalId/interventions/:interventionId", | |
| "tags": [ | |
| "Goals" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId/goals/:goalId/interventions/:interventionId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient" | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the encounter" | |
| }, | |
| { | |
| "name": "healthConcernId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the health concern" | |
| }, | |
| { | |
| "name": "goalId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the goal" | |
| }, | |
| { | |
| "name": "interventionId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the intervention" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "get": { | |
| "description": "Gets intervention details based on person id, encounter id, health concern id , goal id and intervention id.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId/goals/:goalId/interventions/:interventionId1", | |
| "tags": [ | |
| "Goals" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId/goals/:goalId/interventions/:interventionId1", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose intervention is being retrieved" | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the encounter whose intervention is being retrieved" | |
| }, | |
| { | |
| "name": "healthConcernId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the health concern whose intervention is being retrieved" | |
| }, | |
| { | |
| "name": "goalId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the goal whose intervention is being retrieved" | |
| }, | |
| { | |
| "name": "interventionId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the intervention to be retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK21" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "id": "<string>", | |
| "healthConcernId": "<string>", | |
| "goalId": "<string>", | |
| "detail": "<string>", | |
| "category": "<string>", | |
| "frequency": "<string>", | |
| "progress": "<string>", | |
| "reviewDate": "<string>", | |
| "startDate": "<string>", | |
| "status": "<string>", | |
| "codeDescription": "<string>", | |
| "codeSystem": "<string>", | |
| "codeValue": "<string>", | |
| "isDeleted": "<string>", | |
| "personId": "<string>", | |
| "encounterId": "<string>", | |
| "createdBy": "<string>", | |
| "createTimestamp": "<string>", | |
| "modifiedBy": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "modifyTimestampTimezone": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "put": { | |
| "description": "Updates intervention details", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId/goals/:goalId/interventions/:interventionId", | |
| "tags": [ | |
| "Goals" | |
| ], | |
| "operationId": "Put{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId/goals/:goalId/interventions/:interventionId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient." | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient encounter." | |
| }, | |
| { | |
| "name": "healthConcernId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the health concern." | |
| }, | |
| { | |
| "name": "goalId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) Care plan goal id of patient." | |
| }, | |
| { | |
| "name": "interventionId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) Care plan intervention id for patient." | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1encounters~1%3AencounterId~1care-plan~1health-concerns~1%3AhealthConcernId~1goals~1%3AgoalId~1interventions~1%3AinterventionId-Request" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/encounters/{encounterId}/care-plan/health-concerns/{healthConcernId}/goals/{goalId}/interventions/{interventionId}/outcomes": { | |
| "get": { | |
| "description": "Returns a list of care plan outcomes for the specified person, encounter, concern, and goal after applying additional OData query operations.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId/goals/:goalId/interventions/:interventionId/outcomes", | |
| "tags": [ | |
| "Goals" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId/goals/:goalId/interventions/:interventionId/outcomes", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "$top", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$filter", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$orderby", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$skip", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$inlinecount", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$count", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose care plan outcomes are being retrieved" | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) Encounter id for outcome" | |
| }, | |
| { | |
| "name": "healthConcernId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) Care plan health concern id of patient" | |
| }, | |
| { | |
| "name": "goalId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) Care plan goal id of patient" | |
| }, | |
| { | |
| "name": "interventionId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) Care plan intervention id for patient" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK22" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "Items": [ | |
| { | |
| "personId": "<string>", | |
| "encounterId": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "isDeleted": "<string>", | |
| "goalAchieved": "<string>", | |
| "goalAchievedDetails": "<string>", | |
| "goalId": "<string>", | |
| "healthConcernId": "<string>", | |
| "interventionId": "<string>", | |
| "description": "<string>", | |
| "outcomeDate": "<string>", | |
| "OutcomeId": "<string>", | |
| "createdBy": "<string>", | |
| "createTimestamp": "<string>", | |
| "createTimestampTimeZone": "<string>", | |
| "modifiedBy": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "modifyTimestampTimeZone": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "personId": "<string>", | |
| "encounterId": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "isDeleted": "<string>", | |
| "goalAchieved": "<string>", | |
| "goalAchievedDetails": "<string>", | |
| "goalId": "<string>", | |
| "healthConcernId": "<string>", | |
| "interventionId": "<string>", | |
| "description": "<string>", | |
| "outcomeDate": "<string>", | |
| "OutcomeId": "<string>", | |
| "createdBy": "<string>", | |
| "createTimestamp": "<string>", | |
| "createTimestampTimeZone": "<string>", | |
| "modifiedBy": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "modifyTimestampTimeZone": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ], | |
| "NextPageLink": "<string>", | |
| "Count": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "post": { | |
| "description": "Add new outcome details", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId/goals/:goalId/interventions/:interventionId/outcomes", | |
| "tags": [ | |
| "Goals" | |
| ], | |
| "operationId": "Post{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId/goals/:goalId/interventions/:interventionId/outcomes", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient" | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient encounter" | |
| }, | |
| { | |
| "name": "healthConcernId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the health concern" | |
| }, | |
| { | |
| "name": "goalId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) Care plan goal id of patient" | |
| }, | |
| { | |
| "name": "interventionId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) Care plan intervention id for patient" | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1encounters~1%3AencounterId~1care-plan~1health-concerns~1%3AhealthConcernId~1goals~1%3AgoalId~1interventions~1%3AinterventionId~1outcomes-Request" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/encounters/{encounterId}/care-plan/health-concerns/{healthConcernId}/goals/{goalId}/interventions/{interventionId}/outcomes/{outcomeId}": { | |
| "delete": { | |
| "description": "Delete outcome details", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId/goals/:goalId/interventions/:interventionId/outcomes/:outcomeId", | |
| "tags": [ | |
| "Goals" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId/goals/:goalId/interventions/:interventionId/outcomes/:outcomeId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient" | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient encounter" | |
| }, | |
| { | |
| "name": "healthConcernId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the health concern" | |
| }, | |
| { | |
| "name": "goalId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) Care plan goal id of patient" | |
| }, | |
| { | |
| "name": "interventionId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) Care plan intervention id of the patient" | |
| }, | |
| { | |
| "name": "outcomeId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) Care plan outcome of the patient" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "get": { | |
| "description": "Gets the care plan outcome details for the given outcome id.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId/goals/:goalId/interventions/:interventionId/outcomes/:outcomeId", | |
| "tags": [ | |
| "Goals" | |
| ], | |
| "operationId": "Get{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId/goals/:goalId/interventions/:interventionId/outcomes/:outcomeId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "$expand", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose care plan outcomes are being retrieved" | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) Encounter id for outcome" | |
| }, | |
| { | |
| "name": "healthConcernId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) Care plan health concern id of patient" | |
| }, | |
| { | |
| "name": "goalId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) Care plan goal id of patient" | |
| }, | |
| { | |
| "name": "interventionId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) Care plan intervention id for patient" | |
| }, | |
| { | |
| "name": "outcomeId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) Care plan outcome id for patient" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK23" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "personId": "<string>", | |
| "encounterId": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "isDeleted": "<string>", | |
| "goalAchieved": "<string>", | |
| "goalAchievedDetails": "<string>", | |
| "goalId": "<string>", | |
| "healthConcernId": "<string>", | |
| "interventionId": "<string>", | |
| "description": "<string>", | |
| "outcomeDate": "<string>", | |
| "OutcomeId": "<string>", | |
| "createdBy": "<string>", | |
| "createTimestamp": "<string>", | |
| "createTimestampTimeZone": "<string>", | |
| "modifiedBy": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "modifyTimestampTimeZone": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "put": { | |
| "description": "Updates outcome details", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId/goals/:goalId/interventions/:interventionId/outcomes/:outcomeId", | |
| "tags": [ | |
| "Goals" | |
| ], | |
| "operationId": "Put{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId/goals/:goalId/interventions/:interventionId/outcomes/:outcomeId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient." | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient encounter." | |
| }, | |
| { | |
| "name": "healthConcernId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the health concern." | |
| }, | |
| { | |
| "name": "goalId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) Care plan goal id of patient." | |
| }, | |
| { | |
| "name": "interventionId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) Care plan intervention id for patient." | |
| }, | |
| { | |
| "name": "outcomeId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) Care plan outcome id for patient." | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1encounters~1%3AencounterId~1care-plan~1health-concerns~1%3AhealthConcernId~1goals~1%3AgoalId~1interventions~1%3AinterventionId~1outcomes~1%3AoutcomeId-Request" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/care-plan/health-concerns": { | |
| "get": { | |
| "description": "Returns a list of health concerns for the specified person id after applying additional OData query operations.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/care-plan/health-concerns", | |
| "tags": [ | |
| "Health Concerns" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/care-plan/health-concerns", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "$top", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$filter", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$orderby", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$skip", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$inlinecount", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$count", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose health concerns are being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK24" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "Items": [ | |
| { | |
| "encounterId": "<string>", | |
| "personId": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "category": "<string>", | |
| "comments": "<string>", | |
| "description": "<string>", | |
| "id": "<string>", | |
| "childRecordExists": "<string>", | |
| "isDeleted": "<string>", | |
| "secondaryTo": "<string>", | |
| "identifiedDate": "<string>", | |
| "resolvedDate": "<string>", | |
| "codeDescription": "<string>", | |
| "codeSystem": "<string>", | |
| "codeValue": "<string>", | |
| "status": "<string>", | |
| "sequenceNumber": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "encounterId": "<string>", | |
| "personId": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "category": "<string>", | |
| "comments": "<string>", | |
| "description": "<string>", | |
| "id": "<string>", | |
| "childRecordExists": "<string>", | |
| "isDeleted": "<string>", | |
| "secondaryTo": "<string>", | |
| "identifiedDate": "<string>", | |
| "resolvedDate": "<string>", | |
| "codeDescription": "<string>", | |
| "codeSystem": "<string>", | |
| "codeValue": "<string>", | |
| "status": "<string>", | |
| "sequenceNumber": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ], | |
| "NextPageLink": "<string>", | |
| "Count": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/encounters/{encounterId}/care-plan/health-concerns": { | |
| "post": { | |
| "description": "Creates patient's careplan health concern.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns", | |
| "tags": [ | |
| "Health Concerns" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient." | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) Encounter id for healthconcern" | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1encounters~1%3AencounterId~1care-plan~1health-concerns-Request" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/encounters/{encounterId}/care-plan/health-concerns/{healthConcernId}": { | |
| "delete": { | |
| "description": "Delete health concern details", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId", | |
| "tags": [ | |
| "Health Concerns" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient" | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient encounter" | |
| }, | |
| { | |
| "name": "healthConcernId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the health concern" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "get": { | |
| "description": "Returns specific health concern details for a patient.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId", | |
| "tags": [ | |
| "Health Concerns" | |
| ], | |
| "operationId": "Get{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "$expand", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose health concern are being fetched" | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient encounter whose health concern are being fetched" | |
| }, | |
| { | |
| "name": "healthConcernId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the health concern whose health concern are being fetched" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK25" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "encounterId": "<string>", | |
| "personId": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "category": "<string>", | |
| "comments": "<string>", | |
| "description": "<string>", | |
| "id": "<string>", | |
| "childRecordExists": "<string>", | |
| "isDeleted": "<string>", | |
| "secondaryTo": "<string>", | |
| "identifiedDate": "<string>", | |
| "resolvedDate": "<string>", | |
| "codeDescription": "<string>", | |
| "codeSystem": "<string>", | |
| "codeValue": "<string>", | |
| "status": "<string>", | |
| "sequenceNumber": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "put": { | |
| "description": "Update patient's careplan health concern.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId", | |
| "tags": [ | |
| "Health Concerns" | |
| ], | |
| "operationId": "Put{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient." | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) Encounter id for healthconcern" | |
| }, | |
| { | |
| "name": "healthConcernId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) Care plan health concern id of patient" | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1encounters~1%3AencounterId~1care-plan~1health-concerns~1%3AhealthConcernId-Request" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/health-concerns/encounter-diagnosis": { | |
| "get": { | |
| "description": "Gets a patient's health concerns encounter diagnosis for health concern.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/health-concerns/encounter-diagnosis", | |
| "tags": [ | |
| "Health Concerns" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/health-concerns/encounter-diagnosis", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "$top", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$filter", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$orderby", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$skip", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$inlinecount", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$count", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose health concerns encounter diagnosis are being retrieved." | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK26" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "Items": [ | |
| { | |
| "encounterDate": "<string>", | |
| "description": "<string>", | |
| "icdCode": "<string>", | |
| "isChronic": "<string>", | |
| "id": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "personId": "<string>", | |
| "healthConcern": "<string>", | |
| "category": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "encounterDate": "<string>", | |
| "description": "<string>", | |
| "icdCode": "<string>", | |
| "isChronic": "<string>", | |
| "id": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "personId": "<string>", | |
| "healthConcern": "<string>", | |
| "category": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ], | |
| "NextPageLink": "<string>", | |
| "Count": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/health-concerns/family-histories-organizer": { | |
| "get": { | |
| "description": "Gets a patient's family histories for health concern.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/health-concerns/family-histories-organizer", | |
| "tags": [ | |
| "Health Concerns" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/health-concerns/family-histories-organizer", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "$top", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$filter", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$orderby", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$skip", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$inlinecount", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$count", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose health concerns family histories are being retrieved." | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK28" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "Items": [ | |
| { | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "personId": "<string>", | |
| "relationship": "<string>", | |
| "familyMember": "<string>", | |
| "isDeceased": "<string>", | |
| "age": "<string>", | |
| "condition": "<string>", | |
| "codeSystem": "<string>", | |
| "code": "<string>", | |
| "id": "<string>", | |
| "healthConcern": "<string>", | |
| "category": "<string>", | |
| "createTimestamp": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "personId": "<string>", | |
| "relationship": "<string>", | |
| "familyMember": "<string>", | |
| "isDeceased": "<string>", | |
| "age": "<string>", | |
| "condition": "<string>", | |
| "codeSystem": "<string>", | |
| "code": "<string>", | |
| "id": "<string>", | |
| "healthConcern": "<string>", | |
| "category": "<string>", | |
| "createTimestamp": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ], | |
| "NextPageLink": "<string>", | |
| "Count": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/health-concerns/problem-observations": { | |
| "get": { | |
| "description": "Gets a patient's health concerns problem observation.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/health-concerns/problem-observations", | |
| "tags": [ | |
| "Health Concerns" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/health-concerns/problem-observations", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "$top", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$filter", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$orderby", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$skip", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$inlinecount", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$count", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose health concerns problem observation are being retrieved." | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK29" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "Items": [ | |
| { | |
| "id": "<string>", | |
| "lastAddressedDate": "<string>", | |
| "onsetDate": "<string>", | |
| "description": "<string>", | |
| "isChronic": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "personId": "<string>", | |
| "healthConcern": "<string>", | |
| "category": "<string>", | |
| "snomedId": "<string>", | |
| "isDeleted": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "id": "<string>", | |
| "lastAddressedDate": "<string>", | |
| "onsetDate": "<string>", | |
| "description": "<string>", | |
| "isChronic": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "personId": "<string>", | |
| "healthConcern": "<string>", | |
| "category": "<string>", | |
| "snomedId": "<string>", | |
| "isDeleted": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ], | |
| "NextPageLink": "<string>", | |
| "Count": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/health-concerns/social-history": { | |
| "get": { | |
| "description": "Gets a patient's social history for health concern.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/health-concerns/social-history", | |
| "tags": [ | |
| "Health Concerns" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/health-concerns/social-history", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "$top", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$filter", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$orderby", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$skip", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$inlinecount", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$count", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose health concerns social history are being retrieved." | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK30" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "Items": [ | |
| { | |
| "exerciseType": "<string>", | |
| "exerciseType2": "<string>", | |
| "exerciseType3": "<string>", | |
| "exerciseFrequency": "<string>", | |
| "exerciseHoursWork": "<string>", | |
| "alcoholUsage": "<string>", | |
| "alcoholType": "<string>", | |
| "alcoholFrequency": "<string>", | |
| "amountPerDay": "<string>", | |
| "lastAlcoholicBeverage": "<string>", | |
| "drugs": "<string>", | |
| "drugAge": "<string>", | |
| "drugType1": "<string>", | |
| "drugFrequency1": "<string>", | |
| "drugRoute": "<string>", | |
| "drugType2": "<string>", | |
| "drugFrequency2": "<string>", | |
| "drugRoute2": "<string>", | |
| "drugType3": "<string>", | |
| "drugFrequency3": "<string>", | |
| "drugRoute3": "<string>", | |
| "drugTreatment": "<string>", | |
| "drugTreatmentCount": "<string>", | |
| "drugMedicalAttention": "<string>", | |
| "drugMedicalAttentionCount": "<string>", | |
| "educationLevel": "<string>", | |
| "degree": "<string>", | |
| "passiveSmoker": "<string>", | |
| "encounterId": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "personId": "<string>", | |
| "encounterTimestamp": "<string>", | |
| "tobaccoUserProfile": "<string>", | |
| "passiveTobaccoType": "<string>", | |
| "passiveLengthExposure": "<string>", | |
| "passiveLevelExposure": "<string>", | |
| "employmentName": "<string>", | |
| "employmentStatus": "<string>", | |
| "employmentRestrictions": "<string>", | |
| "occupation": "<string>", | |
| "employmentRetireDate": "<string>", | |
| "employmentId": "<string>", | |
| "tobaccoUseHealthConcern": "<string>", | |
| "tobaccoUseCategory": "<string>", | |
| "exerciseHealthConcern": "<string>", | |
| "exerciseCategory": "<string>", | |
| "alcoholIntakeHealthConcern": "<string>", | |
| "alcoholIntakeCategory": "<string>", | |
| "employmentDetailHealthConcern": "<string>", | |
| "employmentDetailCategory": "<string>", | |
| "drugMisuseBehaviorHealthConcern": "<string>", | |
| "drugMisuseBehaviorCategory": "<string>", | |
| "educationalAchievementHealthConcern": "<string>", | |
| "educationalAchievementCategory": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "exerciseType": "<string>", | |
| "exerciseType2": "<string>", | |
| "exerciseType3": "<string>", | |
| "exerciseFrequency": "<string>", | |
| "exerciseHoursWork": "<string>", | |
| "alcoholUsage": "<string>", | |
| "alcoholType": "<string>", | |
| "alcoholFrequency": "<string>", | |
| "amountPerDay": "<string>", | |
| "lastAlcoholicBeverage": "<string>", | |
| "drugs": "<string>", | |
| "drugAge": "<string>", | |
| "drugType1": "<string>", | |
| "drugFrequency1": "<string>", | |
| "drugRoute": "<string>", | |
| "drugType2": "<string>", | |
| "drugFrequency2": "<string>", | |
| "drugRoute2": "<string>", | |
| "drugType3": "<string>", | |
| "drugFrequency3": "<string>", | |
| "drugRoute3": "<string>", | |
| "drugTreatment": "<string>", | |
| "drugTreatmentCount": "<string>", | |
| "drugMedicalAttention": "<string>", | |
| "drugMedicalAttentionCount": "<string>", | |
| "educationLevel": "<string>", | |
| "degree": "<string>", | |
| "passiveSmoker": "<string>", | |
| "encounterId": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "personId": "<string>", | |
| "encounterTimestamp": "<string>", | |
| "tobaccoUserProfile": "<string>", | |
| "passiveTobaccoType": "<string>", | |
| "passiveLengthExposure": "<string>", | |
| "passiveLevelExposure": "<string>", | |
| "employmentName": "<string>", | |
| "employmentStatus": "<string>", | |
| "employmentRestrictions": "<string>", | |
| "occupation": "<string>", | |
| "employmentRetireDate": "<string>", | |
| "employmentId": "<string>", | |
| "tobaccoUseHealthConcern": "<string>", | |
| "tobaccoUseCategory": "<string>", | |
| "exerciseHealthConcern": "<string>", | |
| "exerciseCategory": "<string>", | |
| "alcoholIntakeHealthConcern": "<string>", | |
| "alcoholIntakeCategory": "<string>", | |
| "employmentDetailHealthConcern": "<string>", | |
| "employmentDetailCategory": "<string>", | |
| "drugMisuseBehaviorHealthConcern": "<string>", | |
| "drugMisuseBehaviorCategory": "<string>", | |
| "educationalAchievementHealthConcern": "<string>", | |
| "educationalAchievementCategory": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ], | |
| "NextPageLink": "<string>", | |
| "Count": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/health-concerns/vitals": { | |
| "get": { | |
| "description": "Gets a patient's vitals for health concern.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/health-concerns/vitals", | |
| "tags": [ | |
| "Health Concerns" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/health-concerns/vitals", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "$top", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$filter", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$orderby", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$skip", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$inlinecount", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$count", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose health concern vitals are being fetched" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK31" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "Items": [ | |
| { | |
| "bloodPressureHealthConcern": "<string>", | |
| "bloodPressureCategory": "<string>", | |
| "bloodPressureSystolicValue": "<string>", | |
| "bloodPressureDiastolicValue": "<string>", | |
| "bloodPressureUnit": "<string>", | |
| "bodyTemperatureHealthConcern": "<string>", | |
| "bodyTemperatureCategory": "<string>", | |
| "bodyTemperatureValue": "<string>", | |
| "bodyTemperatureUnit": "<string>", | |
| "headCircumferenceHealthConcern": "<string>", | |
| "headCircumferenceCategory": "<string>", | |
| "headCircumferenceValue": "<string>", | |
| "headCircumferenceUnit": "<string>", | |
| "heartRateHealthConcern": "<string>", | |
| "heartRateCategory": "<string>", | |
| "heartRateValue": "<string>", | |
| "heartRateUnit": "<string>", | |
| "heightHealthConcern": "<string>", | |
| "heightCategory": "<string>", | |
| "heightValue": "<string>", | |
| "heightUnit": "<string>", | |
| "weightHealthConcern": "<string>", | |
| "weightCategory": "<string>", | |
| "weightValue": "<string>", | |
| "weightUnit": "<string>", | |
| "bmiHealthConcern": "<string>", | |
| "bmiCategory": "<string>", | |
| "bmiValue": "<string>", | |
| "o2BldCOximetryHealthConcern": "<string>", | |
| "o2BldCOximetryCategory": "<string>", | |
| "o2BldCOximetryValue": "<string>", | |
| "o2BldCOximetryUnit": "<string>", | |
| "respiratoryRateHealthConcern": "<string>", | |
| "respiratoryRateCategory": "<string>", | |
| "respiratoryRateValue": "<string>", | |
| "respiratoryRateUnit": "<string>", | |
| "id": "<string>", | |
| "encounterId": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "personId": "<string>", | |
| "encounterTimestamp": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "bloodPressureHealthConcern": "<string>", | |
| "bloodPressureCategory": "<string>", | |
| "bloodPressureSystolicValue": "<string>", | |
| "bloodPressureDiastolicValue": "<string>", | |
| "bloodPressureUnit": "<string>", | |
| "bodyTemperatureHealthConcern": "<string>", | |
| "bodyTemperatureCategory": "<string>", | |
| "bodyTemperatureValue": "<string>", | |
| "bodyTemperatureUnit": "<string>", | |
| "headCircumferenceHealthConcern": "<string>", | |
| "headCircumferenceCategory": "<string>", | |
| "headCircumferenceValue": "<string>", | |
| "headCircumferenceUnit": "<string>", | |
| "heartRateHealthConcern": "<string>", | |
| "heartRateCategory": "<string>", | |
| "heartRateValue": "<string>", | |
| "heartRateUnit": "<string>", | |
| "heightHealthConcern": "<string>", | |
| "heightCategory": "<string>", | |
| "heightValue": "<string>", | |
| "heightUnit": "<string>", | |
| "weightHealthConcern": "<string>", | |
| "weightCategory": "<string>", | |
| "weightValue": "<string>", | |
| "weightUnit": "<string>", | |
| "bmiHealthConcern": "<string>", | |
| "bmiCategory": "<string>", | |
| "bmiValue": "<string>", | |
| "o2BldCOximetryHealthConcern": "<string>", | |
| "o2BldCOximetryCategory": "<string>", | |
| "o2BldCOximetryValue": "<string>", | |
| "o2BldCOximetryUnit": "<string>", | |
| "respiratoryRateHealthConcern": "<string>", | |
| "respiratoryRateCategory": "<string>", | |
| "respiratoryRateValue": "<string>", | |
| "respiratoryRateUnit": "<string>", | |
| "id": "<string>", | |
| "encounterId": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "personId": "<string>", | |
| "encounterTimestamp": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ], | |
| "NextPageLink": "<string>", | |
| "Count": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/charts/immunizations": { | |
| "get": { | |
| "description": "GETs immunizations updated within a given interval. If an oData filter of createTimestamp or modifyTimestamp is not specified, immunizations which are created or updated for the last 7 days are retrieved.", | |
| "summary": "{{baseUrl}}/persons/charts/immunizations", | |
| "tags": [ | |
| "Immunizations" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/charts/immunizations", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "$top", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$filter", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$orderby", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$skip", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$inlinecount", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$count", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK32" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "Items": [ | |
| { | |
| "id": "<string>", | |
| "personId": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "orderId": "<string>", | |
| "orderStatus": "<string>", | |
| "cvxCode": "<string>", | |
| "description": "<string>", | |
| "recordSourceCode": "<string>", | |
| "recordSourceName": "<string>", | |
| "administerCptCode": "<string>", | |
| "isDeleted": "<string>", | |
| "cptCode": "<string>", | |
| "sequenceNumber": "<string>", | |
| "status": "<string>", | |
| "comment": "<string>", | |
| "brandName": "<string>", | |
| "siteCode": "<string>", | |
| "site": "<string>", | |
| "sideCode": "<string>", | |
| "side": "<string>", | |
| "routeCode": "<string>", | |
| "route": "<string>", | |
| "unitsCode": "<string>", | |
| "units": "<string>", | |
| "lotNumber": "<string>", | |
| "expirationDate": "<string>", | |
| "dose": "<string>", | |
| "mvxCode": "<string>", | |
| "manufacturerNumber": "<string>", | |
| "manufacturerName": "<string>", | |
| "notAdministeredReason": "<string>", | |
| "notAdministeredCode": "<string>", | |
| "purchaseType": "<string>", | |
| "strength": "<string>", | |
| "administeredYear": "<string>", | |
| "administeredMonth": "<string>", | |
| "administeredDay": "<string>", | |
| "administeredDate": "<string>", | |
| "administeredTimestamp": "<string>", | |
| "administeredByUserId": "<string>", | |
| "administeredByName": "<string>", | |
| "auditId": "<string>", | |
| "chargeId": "<string>", | |
| "adminChargeId": "<string>", | |
| "isException": "<string>", | |
| "isCounselled": "<string>", | |
| "counselledCode": "<string>", | |
| "counselledUnit": "<string>", | |
| "counselChargeId": "<string>", | |
| "consentFrom": "<string>", | |
| "consentGivenTo": "<string>", | |
| "ndcId": "<string>", | |
| "isError": "<string>", | |
| "snomedImmunity": "<string>", | |
| "isVfc": "<string>", | |
| "vfcCode": "<string>", | |
| "vfcDate": "<string>", | |
| "vfcDateTimezone": "<string>", | |
| "fundingSourceCode": "<string>", | |
| "simCode": "<string>", | |
| "signOffUserId": "<string>", | |
| "signOffName": "<string>", | |
| "signOffDate": "<string>", | |
| "signOffDateTimezone": "<string>", | |
| "signoffComment": "<string>", | |
| "displayName": "<string>", | |
| "hideOnChart": "<string>", | |
| "createdBy": "<string>", | |
| "createTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "modifiedByUserId": "<string>", | |
| "modifiedByName": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "modifyTimestampTimezone": "<string>", | |
| "overrideInvalidDose": "<string>", | |
| "billingUnits": "<string>", | |
| "vaccineInventoryId": "<string>", | |
| "isReported": "<string>", | |
| "wasNotGiven": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "id": "<string>", | |
| "personId": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "orderId": "<string>", | |
| "orderStatus": "<string>", | |
| "cvxCode": "<string>", | |
| "description": "<string>", | |
| "recordSourceCode": "<string>", | |
| "recordSourceName": "<string>", | |
| "administerCptCode": "<string>", | |
| "isDeleted": "<string>", | |
| "cptCode": "<string>", | |
| "sequenceNumber": "<string>", | |
| "status": "<string>", | |
| "comment": "<string>", | |
| "brandName": "<string>", | |
| "siteCode": "<string>", | |
| "site": "<string>", | |
| "sideCode": "<string>", | |
| "side": "<string>", | |
| "routeCode": "<string>", | |
| "route": "<string>", | |
| "unitsCode": "<string>", | |
| "units": "<string>", | |
| "lotNumber": "<string>", | |
| "expirationDate": "<string>", | |
| "dose": "<string>", | |
| "mvxCode": "<string>", | |
| "manufacturerNumber": "<string>", | |
| "manufacturerName": "<string>", | |
| "notAdministeredReason": "<string>", | |
| "notAdministeredCode": "<string>", | |
| "purchaseType": "<string>", | |
| "strength": "<string>", | |
| "administeredYear": "<string>", | |
| "administeredMonth": "<string>", | |
| "administeredDay": "<string>", | |
| "administeredDate": "<string>", | |
| "administeredTimestamp": "<string>", | |
| "administeredByUserId": "<string>", | |
| "administeredByName": "<string>", | |
| "auditId": "<string>", | |
| "chargeId": "<string>", | |
| "adminChargeId": "<string>", | |
| "isException": "<string>", | |
| "isCounselled": "<string>", | |
| "counselledCode": "<string>", | |
| "counselledUnit": "<string>", | |
| "counselChargeId": "<string>", | |
| "consentFrom": "<string>", | |
| "consentGivenTo": "<string>", | |
| "ndcId": "<string>", | |
| "isError": "<string>", | |
| "snomedImmunity": "<string>", | |
| "isVfc": "<string>", | |
| "vfcCode": "<string>", | |
| "vfcDate": "<string>", | |
| "vfcDateTimezone": "<string>", | |
| "fundingSourceCode": "<string>", | |
| "simCode": "<string>", | |
| "signOffUserId": "<string>", | |
| "signOffName": "<string>", | |
| "signOffDate": "<string>", | |
| "signOffDateTimezone": "<string>", | |
| "signoffComment": "<string>", | |
| "displayName": "<string>", | |
| "hideOnChart": "<string>", | |
| "createdBy": "<string>", | |
| "createTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "modifiedByUserId": "<string>", | |
| "modifiedByName": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "modifyTimestampTimezone": "<string>", | |
| "overrideInvalidDose": "<string>", | |
| "billingUnits": "<string>", | |
| "vaccineInventoryId": "<string>", | |
| "isReported": "<string>", | |
| "wasNotGiven": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ], | |
| "NextPageLink": "<string>", | |
| "Count": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/encounters/{encounterId}/immunizations/orders": { | |
| "post": { | |
| "description": "Adds a patient's immunization order record", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/immunizations/orders", | |
| "tags": [ | |
| "Immunizations" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/immunizations/orders", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose immunization order record is being added" | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the encounter for which the immunization order is being added" | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1encounters~1%3AencounterId~1immunizations~1ordersRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/encounters/{encounterId}/immunizations/orders/{orderId}": { | |
| "put": { | |
| "description": "Updates a patient's immunization order record", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/immunizations/orders/:orderId", | |
| "tags": [ | |
| "Immunizations" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/immunizations/orders/:orderId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose immunization order record is being updated" | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the encounter that contains the immunization order is being updated" | |
| }, | |
| { | |
| "name": "orderId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the immunization order being updated" | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1encounters~1%3AencounterId~1immunizations~1orders~1%3AorderIdRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/encounters/{encounterId}/immunizations/orders/{orderId}/vaccines": { | |
| "post": { | |
| "description": "Adds a patient's ordered vaccine record", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/immunizations/orders/:orderId/vaccines", | |
| "tags": [ | |
| "Immunizations" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/immunizations/orders/:orderId/vaccines", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose vaccine record is being added" | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the encounter that contains the immunization order to which vaccine record id being added" | |
| }, | |
| { | |
| "name": "orderId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the immunization order to which vaccine record is being added" | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1encounters~1%3AencounterId~1immunizations~1orders~1%3AorderId~1vaccinesRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/encounters/{encounterId}/immunizations/orders/{orderId}/vaccines/{vaccineId}": { | |
| "put": { | |
| "description": "Updates a patient's vaccine record.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/immunizations/orders/:orderId/vaccines/:vaccineId", | |
| "tags": [ | |
| "Immunizations" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/immunizations/orders/:orderId/vaccines/:vaccineId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose vaccine record is being updated" | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the encounter for the immunization order which contains the vaccine being updated" | |
| }, | |
| { | |
| "name": "orderId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the immunization order which contains the vaccine being updated" | |
| }, | |
| { | |
| "name": "vaccineId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the ordered vaccine being updated" | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1encounters~1%3AencounterId~1immunizations~1orders~1%3AorderId~1vaccines~1%3AvaccineIdRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/encounters/{encounterId}/immunizations/orders/{orderId}/vaccines/{vaccineId}/vis-histories": { | |
| "post": { | |
| "description": "Adds vaccine vis history for the provided ordered vaccine", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/immunizations/orders/:orderId/vaccines/:vaccineId/vis-histories", | |
| "tags": [ | |
| "Immunizations" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/immunizations/orders/:orderId/vaccines/:vaccineId/vis-histories", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person associated with the vaccine vis history that is being added" | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the encounter associated with the vaccine for which vis history is being added" | |
| }, | |
| { | |
| "name": "orderId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the immunization order which contains the vaccine for which vis history is being added" | |
| }, | |
| { | |
| "name": "vaccineId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the vaccine for which vis history is being added" | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1encounters~1%3AencounterId~1immunizations~1orders~1%3AorderId~1vaccines~1%3AvaccineId~1vis-histories-Request" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/encounters/{encounterId}/immunizations/orders/{orderId}/vaccines/{vaccineId}/vis-histories/{visId}": { | |
| "put": { | |
| "description": "Updates a patient's vaccine vis history record.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/immunizations/orders/:orderId/vaccines/:vaccineId/vis-histories/:visId", | |
| "tags": [ | |
| "Immunizations" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/immunizations/orders/:orderId/vaccines/:vaccineId/vis-histories/:visId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person associated with the vaccine vis history that is being updated" | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the encounter associated with the vaccine for which vis history is being updated" | |
| }, | |
| { | |
| "name": "orderId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the immunization order which contains the vaccine for which vis history is being updated" | |
| }, | |
| { | |
| "name": "vaccineId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the vaccine for which vis history is being updated" | |
| }, | |
| { | |
| "name": "visId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the vis history record that is being updated" | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1encounters~1%3AencounterId~1immunizations~1orders~1%3AorderId~1vaccines~1%3AvaccineId~1vis-histories~1%3AvisId-Request" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/encounters/{encounterId}/immunizations/orders/{orderId}/vaccines/{vaccineId}/wasted-vaccines": { | |
| "post": { | |
| "description": "Adds a wasted vaccine record associated with a patient's ordered vaccine.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/immunizations/orders/:orderId/vaccines/:vaccineId/wasted-vaccines", | |
| "tags": [ | |
| "Immunizations" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/immunizations/orders/:orderId/vaccines/:vaccineId/wasted-vaccines", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose ordered vaccine is associated with the wasted vaccine record that is being added" | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the encounter that contains the ordered vaccine that is associated with the wasted vaccine record" | |
| }, | |
| { | |
| "name": "orderId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the immunization order which contains the ordered vaccine associated with the wasted vaccine record" | |
| }, | |
| { | |
| "name": "vaccineId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the ordered vaccine that is associated with the wasted vaccine that is being added" | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1encounters~1%3AencounterId~1immunizations~1orders~1%3AorderId~1vaccines~1%3AvaccineId~1wasted-vaccines-Request" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/immunizations": { | |
| "get": { | |
| "description": "Gets a list of ordered vaccines for the specified person id after performing additional OData query operations.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/immunizations", | |
| "tags": [ | |
| "Immunizations" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/immunizations", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "$top", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$filter", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$orderby", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$skip", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$inlinecount", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$count", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose ordered vaccines are being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK32" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "Items": [ | |
| { | |
| "id": "<string>", | |
| "personId": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "orderId": "<string>", | |
| "orderStatus": "<string>", | |
| "cvxCode": "<string>", | |
| "description": "<string>", | |
| "recordSourceCode": "<string>", | |
| "recordSourceName": "<string>", | |
| "administerCptCode": "<string>", | |
| "isDeleted": "<string>", | |
| "cptCode": "<string>", | |
| "sequenceNumber": "<string>", | |
| "status": "<string>", | |
| "comment": "<string>", | |
| "brandName": "<string>", | |
| "siteCode": "<string>", | |
| "site": "<string>", | |
| "sideCode": "<string>", | |
| "side": "<string>", | |
| "routeCode": "<string>", | |
| "route": "<string>", | |
| "unitsCode": "<string>", | |
| "units": "<string>", | |
| "lotNumber": "<string>", | |
| "expirationDate": "<string>", | |
| "dose": "<string>", | |
| "mvxCode": "<string>", | |
| "manufacturerNumber": "<string>", | |
| "manufacturerName": "<string>", | |
| "notAdministeredReason": "<string>", | |
| "notAdministeredCode": "<string>", | |
| "purchaseType": "<string>", | |
| "strength": "<string>", | |
| "administeredYear": "<string>", | |
| "administeredMonth": "<string>", | |
| "administeredDay": "<string>", | |
| "administeredDate": "<string>", | |
| "administeredTimestamp": "<string>", | |
| "administeredByUserId": "<string>", | |
| "administeredByName": "<string>", | |
| "auditId": "<string>", | |
| "chargeId": "<string>", | |
| "adminChargeId": "<string>", | |
| "isException": "<string>", | |
| "isCounselled": "<string>", | |
| "counselledCode": "<string>", | |
| "counselledUnit": "<string>", | |
| "counselChargeId": "<string>", | |
| "consentFrom": "<string>", | |
| "consentGivenTo": "<string>", | |
| "ndcId": "<string>", | |
| "isError": "<string>", | |
| "snomedImmunity": "<string>", | |
| "isVfc": "<string>", | |
| "vfcCode": "<string>", | |
| "vfcDate": "<string>", | |
| "vfcDateTimezone": "<string>", | |
| "fundingSourceCode": "<string>", | |
| "simCode": "<string>", | |
| "signOffUserId": "<string>", | |
| "signOffName": "<string>", | |
| "signOffDate": "<string>", | |
| "signOffDateTimezone": "<string>", | |
| "signoffComment": "<string>", | |
| "displayName": "<string>", | |
| "hideOnChart": "<string>", | |
| "createdBy": "<string>", | |
| "createTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "modifiedByUserId": "<string>", | |
| "modifiedByName": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "modifyTimestampTimezone": "<string>", | |
| "overrideInvalidDose": "<string>", | |
| "billingUnits": "<string>", | |
| "vaccineInventoryId": "<string>", | |
| "isReported": "<string>", | |
| "wasNotGiven": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "id": "<string>", | |
| "personId": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "orderId": "<string>", | |
| "orderStatus": "<string>", | |
| "cvxCode": "<string>", | |
| "description": "<string>", | |
| "recordSourceCode": "<string>", | |
| "recordSourceName": "<string>", | |
| "administerCptCode": "<string>", | |
| "isDeleted": "<string>", | |
| "cptCode": "<string>", | |
| "sequenceNumber": "<string>", | |
| "status": "<string>", | |
| "comment": "<string>", | |
| "brandName": "<string>", | |
| "siteCode": "<string>", | |
| "site": "<string>", | |
| "sideCode": "<string>", | |
| "side": "<string>", | |
| "routeCode": "<string>", | |
| "route": "<string>", | |
| "unitsCode": "<string>", | |
| "units": "<string>", | |
| "lotNumber": "<string>", | |
| "expirationDate": "<string>", | |
| "dose": "<string>", | |
| "mvxCode": "<string>", | |
| "manufacturerNumber": "<string>", | |
| "manufacturerName": "<string>", | |
| "notAdministeredReason": "<string>", | |
| "notAdministeredCode": "<string>", | |
| "purchaseType": "<string>", | |
| "strength": "<string>", | |
| "administeredYear": "<string>", | |
| "administeredMonth": "<string>", | |
| "administeredDay": "<string>", | |
| "administeredDate": "<string>", | |
| "administeredTimestamp": "<string>", | |
| "administeredByUserId": "<string>", | |
| "administeredByName": "<string>", | |
| "auditId": "<string>", | |
| "chargeId": "<string>", | |
| "adminChargeId": "<string>", | |
| "isException": "<string>", | |
| "isCounselled": "<string>", | |
| "counselledCode": "<string>", | |
| "counselledUnit": "<string>", | |
| "counselChargeId": "<string>", | |
| "consentFrom": "<string>", | |
| "consentGivenTo": "<string>", | |
| "ndcId": "<string>", | |
| "isError": "<string>", | |
| "snomedImmunity": "<string>", | |
| "isVfc": "<string>", | |
| "vfcCode": "<string>", | |
| "vfcDate": "<string>", | |
| "vfcDateTimezone": "<string>", | |
| "fundingSourceCode": "<string>", | |
| "simCode": "<string>", | |
| "signOffUserId": "<string>", | |
| "signOffName": "<string>", | |
| "signOffDate": "<string>", | |
| "signOffDateTimezone": "<string>", | |
| "signoffComment": "<string>", | |
| "displayName": "<string>", | |
| "hideOnChart": "<string>", | |
| "createdBy": "<string>", | |
| "createTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "modifiedByUserId": "<string>", | |
| "modifiedByName": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "modifyTimestampTimezone": "<string>", | |
| "overrideInvalidDose": "<string>", | |
| "billingUnits": "<string>", | |
| "vaccineInventoryId": "<string>", | |
| "isReported": "<string>", | |
| "wasNotGiven": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ], | |
| "NextPageLink": "<string>", | |
| "Count": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/immunizations/dose-validation": { | |
| "get": { | |
| "description": "Gets a list of vaccine dose validation for the specified person id.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/immunizations/dose-validation", | |
| "tags": [ | |
| "Immunizations" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/immunizations/dose-validation", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "$top", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$filter", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$orderby", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$skip", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$inlinecount", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$count", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose vaccine dose validation information is being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK34" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "personId": "<string>", | |
| "administeredDate": "<string>", | |
| "groupName": "<string>", | |
| "statusCode": "<string>", | |
| "statusMessage": "<string>", | |
| "orderVaccineId": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/immunizations/exclusions": { | |
| "get": { | |
| "description": "Gets a list of excluded vaccines for the specified person id after performing additional OData query operations.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/immunizations/exclusions", | |
| "tags": [ | |
| "Immunizations" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/immunizations/exclusions", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "$top", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$filter", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$orderby", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$skip", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$inlinecount", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "$count", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required)" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose excluded vaccines are being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK35" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "Items": [ | |
| { | |
| "id": "<string>", | |
| "personId": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "cvxCode": "<string>", | |
| "name": "<string>", | |
| "reasons": [ | |
| "<string>", | |
| "<string>" | |
| ], | |
| "startDate": "<string>", | |
| "endDate": "<string>", | |
| "comment": "<string>", | |
| "createdBy": "<string>", | |
| "createTimestamp": "<string>", | |
| "modifiedBy": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "practiceName": "<string>", | |
| "excludedBy": "<string>", | |
| "isDeleted": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "id": "<string>", | |
| "personId": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "cvxCode": "<string>", | |
| "name": "<string>", | |
| "reasons": [ | |
| "<string>", | |
| "<string>" | |
| ], | |
| "startDate": "<string>", | |
| "endDate": "<string>", | |
| "comment": "<string>", | |
| "createdBy": "<string>", | |
| "createTimestamp": "<string>", | |
| "modifiedBy": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "practiceName": "<string>", | |
| "excludedBy": "<string>", | |
| "isDeleted": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ], | |
| "NextPageLink": "<string>", | |
| "Count": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "post": { | |
| "description": "Adds a patient's vaccine exclusion record", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/immunizations/exclusions", | |
| "tags": [ | |
| "Immunizations" | |
| ], | |
| "operationId": "Post{{baseUrl}}/persons/:personId/chart/immunizations/exclusions", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose vaccine exclusion record is being added" | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1immunizations~1exclusionsRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/immunizations/exclusions/{exclusionId}": { | |
| "put": { | |
| "description": "Updates a patient's excluded vaccine record", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/immunizations/exclusions/:exclusionId", | |
| "tags": [ | |
| "Immunizations" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/immunizations/exclusions/:exclusionId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose excluded vaccine record is being updated" | |
| }, | |
| { | |
| "name": "exclusionId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the excluded vaccine being updated" | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1immunizations~1exclusions~1%3AexclusionIdRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/immunizations/group-status": { | |
| "get": { | |
| "description": "Gets a list of vaccine group status for the specified person id.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/immunizations/group-status", | |
| "tags": [ | |
| "Immunizations" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/immunizations/group-status", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose vaccine group statuses are being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK36" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "groupName": "<string>", | |
| "personId": "<string>", | |
| "isStatusProcessedSuccessfully": "<string>", | |
| "isRuleFound": "<string>", | |
| "referenceDate": "<string>", | |
| "personDateOfBirth": "<string>", | |
| "cdcStartMonth": "<string>", | |
| "cdcEndMonth": "<string>", | |
| "nextDueDate": "<string>", | |
| "status": "<string>", | |
| "statusCalculationCode": "<string>", | |
| "doseSequenceStatusCalulatedFor": "<string>", | |
| "groupMinimumAgeInDays": "<string>", | |
| "groupMaximumAgeInDays": "<string>", | |
| "doseMinimumAgeInDays": "<string>", | |
| "doseMaximumAgeInDays": "<string>", | |
| "cvxToAdminister": "<string>", | |
| "vaccineToAdminister": "<string>", | |
| "totalDoses": "<string>", | |
| "statusCalculationMessage": "<string>", | |
| "nextDueDateCalculationMessage": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/immunizations/interactions": { | |
| "get": { | |
| "description": "Gets patient interactions for a vaccine with the given CVX and CPT codes.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/immunizations/interactions", | |
| "tags": [ | |
| "Immunizations" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/immunizations/interactions", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "cvxCode", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) The cvx code of the vaccine for which interaction are being retrieved" | |
| }, | |
| { | |
| "name": "cptCode", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) The cpt code of the vaccine for which interaction are being retrieved" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose interactions are being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK37" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "personId": "<string>", | |
| "isRequired": "<string>", | |
| "acknowledged": "<string>", | |
| "severityLevel": "<string>", | |
| "description": "<string>", | |
| "entityName": "<string>", | |
| "eventType": "<string>", | |
| "sourceId": "<string>", | |
| "cause": "<string>", | |
| "warningDetail": "<string>", | |
| "warningType": "<string>", | |
| "warning": "<string>", | |
| "causeText": "<string>", | |
| "overrideText": "<string>", | |
| "durAuditKey": "<string>", | |
| "isSuppressed": "<string>", | |
| "isRecordedElseWhere": "<string>", | |
| "practiceId": "<string>", | |
| "display": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/immunizations/orders": { | |
| "get": { | |
| "description": "Gets immunization orders for the specified person after performing additional OData operations.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/immunizations/orders", | |
| "tags": [ | |
| "Immunizations" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/immunizations/orders", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "$top", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$filter", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$orderby", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$skip", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$inlinecount", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$count", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose immunization order is being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK38" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "Items": [ | |
| { | |
| "id": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "encounterId": "<string>", | |
| "personId": "<string>", | |
| "userFriendlyOrderNumber": "<string>", | |
| "orderingProviderId": "<string>", | |
| "orderingProviderName": "<string>", | |
| "supervisorProviderId": "<string>", | |
| "status": "<string>", | |
| "vaccineDescription": "<string>", | |
| "createTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "modifyTimestampTimezone": "<string>", | |
| "isDeleted": "<string>", | |
| "hasDocuments": "<string>", | |
| "hasTrackingComments": "<string>", | |
| "immunizationsDescription": "<string>", | |
| "isVerbalOrder": "<string>", | |
| "encounterTimestamp": "<string>", | |
| "encounterTimestampTimezone": "<string>", | |
| "locationId": "<string>", | |
| "locationName": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "id": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "encounterId": "<string>", | |
| "personId": "<string>", | |
| "userFriendlyOrderNumber": "<string>", | |
| "orderingProviderId": "<string>", | |
| "orderingProviderName": "<string>", | |
| "supervisorProviderId": "<string>", | |
| "status": "<string>", | |
| "vaccineDescription": "<string>", | |
| "createTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "modifyTimestampTimezone": "<string>", | |
| "isDeleted": "<string>", | |
| "hasDocuments": "<string>", | |
| "hasTrackingComments": "<string>", | |
| "immunizationsDescription": "<string>", | |
| "isVerbalOrder": "<string>", | |
| "encounterTimestamp": "<string>", | |
| "encounterTimestampTimezone": "<string>", | |
| "locationId": "<string>", | |
| "locationName": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ], | |
| "NextPageLink": "<string>", | |
| "Count": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/immunizations/orders/{orderId}": { | |
| "get": { | |
| "description": "Gets immunization order details for the specified person and order.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/immunizations/orders/:orderId", | |
| "tags": [ | |
| "Immunizations" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/immunizations/orders/:orderId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose immunization order is being retrieved" | |
| }, | |
| { | |
| "name": "orderId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the immunization order being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK39" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "id": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "encounterId": "<string>", | |
| "personId": "<string>", | |
| "personName": "<string>", | |
| "userFriendlyOrderNumber": "<string>", | |
| "generatedBy": "<string>", | |
| "locationId": "<string>", | |
| "locationName": "<string>", | |
| "orderingProviderId": "<string>", | |
| "orderingProviderName": "<string>", | |
| "supervisorProviderId": "<string>", | |
| "status": "<string>", | |
| "vaccineDescription": "<string>", | |
| "createTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "modifyTimestampTimezone": "<string>", | |
| "registryId": "<string>", | |
| "interfaceMessage": "<string>", | |
| "hasDocuments": "<string>", | |
| "hasTrackingComments": "<string>", | |
| "immunizationsDescription": "<string>", | |
| "orderComment": "<string>", | |
| "isVerbalOrder": "<string>", | |
| "allergiesReviewed": [ | |
| "<string>", | |
| "<string>" | |
| ], | |
| "cancelReason": "<string>", | |
| "signOffDate": "<string>", | |
| "signOffDateTimezone": "<string>", | |
| "signOffUserId": "<string>", | |
| "signOffUserName": "<string>", | |
| "privacyLevel": "<string>", | |
| "encounterTimestamp": "<string>", | |
| "encounterTimestampTimezone": "<string>", | |
| "isDeleted": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/immunizations/orders/{orderId}/insurances": { | |
| "get": { | |
| "description": "Get a list of insurances that are associated with the specified person Id and order Id.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/immunizations/orders/:orderId/insurances", | |
| "tags": [ | |
| "Immunizations" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/immunizations/orders/:orderId/insurances", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person for whom the order insurances are being retrieved" | |
| }, | |
| { | |
| "name": "orderId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the immunization order for which insurances are being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK40" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "id": "<string>", | |
| "personId": "<string>", | |
| "personPayerId": "<string>", | |
| "payerId": "<string>", | |
| "insuredPersonId": "<string>", | |
| "cob": "<string>", | |
| "orderId": "<string>", | |
| "payerName": "<string>", | |
| "insuredPersonName": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/immunizations/orders/{orderId}/tracking-comments": { | |
| "get": { | |
| "description": "Gets a list of tracking comments for the given person id and order id.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/immunizations/orders/:orderId/tracking-comments", | |
| "tags": [ | |
| "Immunizations" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/immunizations/orders/:orderId/tracking-comments", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person who the order belongs to" | |
| }, | |
| { | |
| "name": "orderId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the order whose tracking comments are being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK41" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "id": "<string>", | |
| "orderId": "<string>", | |
| "personId": "<string>", | |
| "providerId": "<string>", | |
| "authorName": "<string>", | |
| "authorDisplayName": "<string>", | |
| "userName": "<string>", | |
| "isDelegate": "<string>", | |
| "createTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "comment": "<string>", | |
| "type": "<string>", | |
| "generatedBy": "<string>", | |
| "isAutoGenerated": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "post": { | |
| "description": "Adds a tracking comment for the given person id and order id", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/immunizations/orders/:orderId/tracking-comments", | |
| "tags": [ | |
| "Immunizations" | |
| ], | |
| "operationId": "Post{{baseUrl}}/persons/:personId/chart/immunizations/orders/:orderId/tracking-comments", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person who the order belongs to" | |
| }, | |
| { | |
| "name": "orderId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the order whose tracking comments are being retrieved" | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1immunizations~1orders~1%3AorderId~1tracking-comments-Request" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/immunizations/orders/{orderId}/vaccines": { | |
| "get": { | |
| "description": "Gets vaccines for the given person id and order id.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/immunizations/orders/:orderId/vaccines", | |
| "tags": [ | |
| "Immunizations" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/immunizations/orders/:orderId/vaccines", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person who the order belongs to" | |
| }, | |
| { | |
| "name": "orderId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the order whose vaccines are being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK42" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "id": "<string>", | |
| "personId": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "orderId": "<string>", | |
| "cvxCode": "<string>", | |
| "description": "<string>", | |
| "cptCode": "<string>", | |
| "sequenceNumber": "<string>", | |
| "status": "<string>", | |
| "lotNumber": "<string>", | |
| "administeredYear": "<string>", | |
| "administeredMonth": "<string>", | |
| "administeredDay": "<string>", | |
| "administeredDate": "<string>", | |
| "administeredTimestamp": "<string>", | |
| "administeredByUserId": "<string>", | |
| "administeredByName": "<string>", | |
| "isVfc": "<string>", | |
| "vfcCode": "<string>", | |
| "fundingSourceCode": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/immunizations/orders/{orderId}/vaccines/{vaccineId}": { | |
| "delete": { | |
| "description": "Deletes a patient's ordered vaccine record.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/immunizations/orders/:orderId/vaccines/:vaccineId", | |
| "tags": [ | |
| "Immunizations" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/immunizations/orders/:orderId/vaccines/:vaccineId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose vaccine record is being deleted" | |
| }, | |
| { | |
| "name": "orderId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the immunization order which contains the vaccine being deleted" | |
| }, | |
| { | |
| "name": "vaccineId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the ordered vaccine being deleted" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "get": { | |
| "description": "Gets vaccine details for the given person id, order id, and vaccine id.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/immunizations/orders/:orderId/vaccines/:vaccineId1", | |
| "tags": [ | |
| "Immunizations" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/immunizations/orders/:orderId/vaccines/:vaccineId1", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person who the order belongs to" | |
| }, | |
| { | |
| "name": "orderId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the order whose vaccines are being retrieved" | |
| }, | |
| { | |
| "name": "vaccineId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the vaccine for which we are retrieving the details" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK43" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "id": "<string>", | |
| "personId": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "orderId": "<string>", | |
| "orderStatus": "<string>", | |
| "cvxCode": "<string>", | |
| "description": "<string>", | |
| "recordSourceCode": "<string>", | |
| "recordSourceName": "<string>", | |
| "administerCptCode": "<string>", | |
| "isDeleted": "<string>", | |
| "cptCode": "<string>", | |
| "sequenceNumber": "<string>", | |
| "status": "<string>", | |
| "comment": "<string>", | |
| "brandName": "<string>", | |
| "siteCode": "<string>", | |
| "site": "<string>", | |
| "sideCode": "<string>", | |
| "side": "<string>", | |
| "routeCode": "<string>", | |
| "route": "<string>", | |
| "unitsCode": "<string>", | |
| "units": "<string>", | |
| "lotNumber": "<string>", | |
| "expirationDate": "<string>", | |
| "dose": "<string>", | |
| "mvxCode": "<string>", | |
| "manufacturerNumber": "<string>", | |
| "manufacturerName": "<string>", | |
| "notAdministeredReason": "<string>", | |
| "notAdministeredCode": "<string>", | |
| "purchaseType": "<string>", | |
| "strength": "<string>", | |
| "administeredYear": "<string>", | |
| "administeredMonth": "<string>", | |
| "administeredDay": "<string>", | |
| "administeredDate": "<string>", | |
| "administeredTimestamp": "<string>", | |
| "administeredByUserId": "<string>", | |
| "administeredByName": "<string>", | |
| "auditId": "<string>", | |
| "chargeId": "<string>", | |
| "adminChargeId": "<string>", | |
| "isException": "<string>", | |
| "isCounselled": "<string>", | |
| "counselledCode": "<string>", | |
| "counselledUnit": "<string>", | |
| "counselChargeId": "<string>", | |
| "consentFrom": "<string>", | |
| "consentGivenTo": "<string>", | |
| "ndcId": "<string>", | |
| "isError": "<string>", | |
| "snomedImmunity": "<string>", | |
| "isVfc": "<string>", | |
| "vfcCode": "<string>", | |
| "vfcDate": "<string>", | |
| "vfcDateTimezone": "<string>", | |
| "fundingSourceCode": "<string>", | |
| "simCode": "<string>", | |
| "signOffUserId": "<string>", | |
| "signOffName": "<string>", | |
| "signOffDate": "<string>", | |
| "signOffDateTimezone": "<string>", | |
| "signoffComment": "<string>", | |
| "displayName": "<string>", | |
| "hideOnChart": "<string>", | |
| "createdBy": "<string>", | |
| "createTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "modifiedByUserId": "<string>", | |
| "modifiedByName": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "modifyTimestampTimezone": "<string>", | |
| "overrideInvalidDose": "<string>", | |
| "billingUnits": "<string>", | |
| "vaccineInventoryId": "<string>", | |
| "isReported": "<string>", | |
| "wasNotGiven": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/immunizations/orders/{orderId}/vaccines/{vaccineId}/component-lot-numbers": { | |
| "get": { | |
| "description": "Get a list of component lot numbers for the specified ordered vaccine ID.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/immunizations/orders/:orderId/vaccines/:vaccineId/component-lot-numbers", | |
| "tags": [ | |
| "Immunizations" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/immunizations/orders/:orderId/vaccines/:vaccineId/component-lot-numbers", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose ordered vaccine component lot numbers are being retrieved" | |
| }, | |
| { | |
| "name": "orderId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the immunization order which contains the vaccine whose component lot numbers are being retrieved" | |
| }, | |
| { | |
| "name": "vaccineId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the ordered vaccine whose component lot numbers are being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK44" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "vaccineId": "<string>", | |
| "id": "<string>", | |
| "componentName": "<string>", | |
| "lotNumber": "<string>", | |
| "diluentLotNumber": "<string>", | |
| "orderId": "<string>", | |
| "personId": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/immunizations/orders/{orderId}/vaccines/{vaccineId}/suspected-diagnoses": { | |
| "get": { | |
| "description": "Get a list of diagnosis for the specified ordered vaccine ID.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/immunizations/orders/:orderId/vaccines/:vaccineId/suspected-diagnoses", | |
| "tags": [ | |
| "Immunizations" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/immunizations/orders/:orderId/vaccines/:vaccineId/suspected-diagnoses", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose diagnosis are being retrieved" | |
| }, | |
| { | |
| "name": "orderId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the immunization order which contains the vaccine whose associated diagnosis are being retrieved" | |
| }, | |
| { | |
| "name": "vaccineId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the ordered vaccine whose associated diagnosis are being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK45" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "personId": "<string>", | |
| "orderId": "<string>", | |
| "orderVaccineId": "<string>", | |
| "id": "<string>", | |
| "diagnosisCodeLibraryId": "<string>", | |
| "diagnosisCodeId": "<string>", | |
| "description": "<string>", | |
| "icd9CmCodeId": "<string>", | |
| "userDescription": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/immunizations/orders/{orderId}/vaccines/{vaccineId}/vis-histories": { | |
| "get": { | |
| "description": "Get a list of VIS histories that are documented as given to the patient for the specified ordered vaccine ID.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/immunizations/orders/:orderId/vaccines/:vaccineId/vis-histories", | |
| "tags": [ | |
| "Immunizations" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/immunizations/orders/:orderId/vaccines/:vaccineId/vis-histories", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person for who the vaccine VIS history information belongs to" | |
| }, | |
| { | |
| "name": "orderId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the immunization order which contains the vaccine for which the vaccine VIS history information was documented" | |
| }, | |
| { | |
| "name": "vaccineId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the ordered vaccine for which the vaccine VIS history information was recorded" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK46" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "vaccineVisId": "<string>", | |
| "orderVaccineId": "<string>", | |
| "personId": "<string>", | |
| "orderId": "<string>", | |
| "visGiveDate": "<string>", | |
| "visGiveDateTimeZone": "<string>", | |
| "visPublishDate": "<string>", | |
| "givenVisId": "<string>", | |
| "vaccineType": "<string>", | |
| "visDocumentType": "<string>", | |
| "createdBy": "<string>", | |
| "visDescription": "<string>", | |
| "languageId": "<string>", | |
| "givenBy": "<string>", | |
| "languageName": "<string>", | |
| "visHistoryPublishDate": "<string>", | |
| "givenVisVaccineType": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/immunizations/orders/{orderId}/vaccines/{vaccineId}/wasted-vaccines": { | |
| "get": { | |
| "description": "Gets a list of wasted vaccines for the specified person Id, order Id and vaccine Id.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/immunizations/orders/:orderId/vaccines/:vaccineId/wasted-vaccines", | |
| "tags": [ | |
| "Immunizations" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/immunizations/orders/:orderId/vaccines/:vaccineId/wasted-vaccines", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) Id of the person whose wasted vaccines are being retrieved" | |
| }, | |
| { | |
| "name": "orderId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) Id of the order associated with the wasted vaccines that are being retrieved" | |
| }, | |
| { | |
| "name": "vaccineId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) Id of the ordered vaccine whose wasted vaccines are being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK47" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "id": "<string>", | |
| "vaccineId": "<string>", | |
| "cvxCode": "<string>", | |
| "vaccineDescription": "<string>", | |
| "lotNumber": "<string>", | |
| "cptCode": "<string>", | |
| "mvxCode": "<string>", | |
| "manufacturerName": "<string>", | |
| "manufacturerNumber": "<string>", | |
| "strength": "<string>", | |
| "units": "<string>", | |
| "unitsCode": "<string>", | |
| "dose": "<string>", | |
| "route": "<string>", | |
| "routeCode": "<string>", | |
| "side": "<string>", | |
| "sideCode": "<string>", | |
| "site": "<string>", | |
| "siteCode": "<string>", | |
| "brandName": "<string>", | |
| "purchaseType": "<string>", | |
| "wastedReason": "<string>", | |
| "wastedDate": "<string>", | |
| "orderId": "<string>", | |
| "personId": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/immunizations/orders/{orderId}/vaccines/{vaccineId}/wasted-vaccines/{wastedVaccineId}": { | |
| "get": { | |
| "description": "Gets the wasted vaccine details for the specified person Id, order Id, vaccine Id and wasted vaccine Id.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/immunizations/orders/:orderId/vaccines/:vaccineId/wasted-vaccines/:wastedVaccineId", | |
| "tags": [ | |
| "Immunizations" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/immunizations/orders/:orderId/vaccines/:vaccineId/wasted-vaccines/:wastedVaccineId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) Id of the person whose wasted vaccine details are being retrieved" | |
| }, | |
| { | |
| "name": "orderId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) Id of the order associated with the wasted vaccine detials that are being retrieved" | |
| }, | |
| { | |
| "name": "vaccineId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) Id of the ordered vaccine whose wasted vaccine detials are being retrieved" | |
| }, | |
| { | |
| "name": "wastedVaccineId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) Id of the wasted vaccine whose detials are being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK47" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "id": "<string>", | |
| "vaccineId": "<string>", | |
| "cvxCode": "<string>", | |
| "vaccineDescription": "<string>", | |
| "lotNumber": "<string>", | |
| "cptCode": "<string>", | |
| "mvxCode": "<string>", | |
| "manufacturerName": "<string>", | |
| "manufacturerNumber": "<string>", | |
| "strength": "<string>", | |
| "units": "<string>", | |
| "unitsCode": "<string>", | |
| "dose": "<string>", | |
| "route": "<string>", | |
| "routeCode": "<string>", | |
| "side": "<string>", | |
| "sideCode": "<string>", | |
| "site": "<string>", | |
| "siteCode": "<string>", | |
| "brandName": "<string>", | |
| "purchaseType": "<string>", | |
| "wastedReason": "<string>", | |
| "wastedDate": "<string>", | |
| "orderId": "<string>", | |
| "personId": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/immunizations/series-completions": { | |
| "get": { | |
| "description": "Gets a patient's immunization series completion records.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/immunizations/series-completions", | |
| "tags": [ | |
| "Immunizations" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/immunizations/series-completions", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose immunization series completion records are being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK49" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "id": "<string>", | |
| "personId": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "seriesName": "<string>", | |
| "isComplete": "<string>", | |
| "comment": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "post": { | |
| "description": "Adds a patient's immunization series completion record", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/immunizations/series-completions", | |
| "tags": [ | |
| "Immunizations" | |
| ], | |
| "operationId": "Post{{baseUrl}}/persons/:personId/chart/immunizations/series-completions", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose immunization series completion record is being added" | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1immunizations~1series-completions-Request" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/immunizations/series-completions/{seriesId}": { | |
| "get": { | |
| "description": "Gets a patient's immunization series completion information for the provided person Id and series completion Id.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/immunizations/series-completions/:seriesId", | |
| "tags": [ | |
| "Immunizations" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/immunizations/series-completions/:seriesId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose immunization series completion information is being retrieved" | |
| }, | |
| { | |
| "name": "seriesId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the series completion record whose details are being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK49" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "id": "<string>", | |
| "personId": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "seriesName": "<string>", | |
| "isComplete": "<string>", | |
| "comment": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "put": { | |
| "description": "Updates a patient's immunization series completion record", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/immunizations/series-completions/:seriesId", | |
| "tags": [ | |
| "Immunizations" | |
| ], | |
| "operationId": "Put{{baseUrl}}/persons/:personId/chart/immunizations/series-completions/:seriesId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose immunization series completion record is being updated" | |
| }, | |
| { | |
| "name": "seriesId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the series being updated" | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1immunizations~1series-completions~1%3AseriesId-Request" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/devices": { | |
| "get": { | |
| "description": "Returns a list of implantable devices for the specified person id after applying additional OData query operations.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/devices", | |
| "tags": [ | |
| "Implantable Device Identifiers" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/devices", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "$top", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$filter", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$orderby", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$skip", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$inlinecount", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$count", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose devices are being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK51" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "Items": [ | |
| { | |
| "id": "<string>", | |
| "personId": "<string>", | |
| "deviceIdentifier": "<string>", | |
| "universalDeviceIdentifier": "<string>", | |
| "snoMedCtCode": "<string>", | |
| "snoMedCtDescription": "<string>", | |
| "lotOrBatchNumber": "<string>", | |
| "serialNumber": "<string>", | |
| "manufacturingDate": "<string>", | |
| "expirationDate": "<string>", | |
| "isDeleted": "<string>", | |
| "assigningAuthorityOid": "<string>", | |
| "assigningAuthority": "<string>", | |
| "gmdnProductName": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "id": "<string>", | |
| "personId": "<string>", | |
| "deviceIdentifier": "<string>", | |
| "universalDeviceIdentifier": "<string>", | |
| "snoMedCtCode": "<string>", | |
| "snoMedCtDescription": "<string>", | |
| "lotOrBatchNumber": "<string>", | |
| "serialNumber": "<string>", | |
| "manufacturingDate": "<string>", | |
| "expirationDate": "<string>", | |
| "isDeleted": "<string>", | |
| "assigningAuthorityOid": "<string>", | |
| "assigningAuthority": "<string>", | |
| "gmdnProductName": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ], | |
| "NextPageLink": "<string>", | |
| "Count": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/devices/{deviceId}": { | |
| "get": { | |
| "description": "Returns a single implantable device for the specified person id and device id.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/devices/:deviceId", | |
| "tags": [ | |
| "Implantable Device Identifiers" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/devices/:deviceId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose device information is being retrieved" | |
| }, | |
| { | |
| "name": "deviceId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The device id" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK52" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "id": "<string>", | |
| "personId": "<string>", | |
| "deviceIdentifier": "<string>", | |
| "universalDeviceIdentifier": "<string>", | |
| "snoMedCtCode": "<string>", | |
| "snoMedCtDescription": "<string>", | |
| "lotOrBatchNumber": "<string>", | |
| "serialNumber": "<string>", | |
| "manufacturingDate": "<string>", | |
| "expirationDate": "<string>", | |
| "isDeleted": "<string>", | |
| "assigningAuthorityOid": "<string>", | |
| "assigningAuthority": "<string>", | |
| "gmdnProductName": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/encounters/{encounterId}/lab/orders": { | |
| "post": { | |
| "description": "Adds a new lab order for the given person id and encounter id.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/lab/orders", | |
| "tags": [ | |
| "Laboratory" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/lab/orders", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient to add the new lab order for." | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the encounter to add the new lab order to." | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1encounters~1%3AencounterId~1lab~1ordersRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK53" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "id": "<string>", | |
| "testDescription": "<string>", | |
| "encounterId": "<string>", | |
| "personId": "<string>", | |
| "ufoNumber": "<string>", | |
| "generatedBy": "<string>", | |
| "orderType": "<string>", | |
| "testLocation": "<string>", | |
| "orderingProvider": "<string>", | |
| "encounterTimestamp": "<string>", | |
| "orderDate": "<string>", | |
| "orderDateTimezone": "<string>", | |
| "signOffDate": "<string>", | |
| "signOffPerson": "<string>", | |
| "testStatus": "<string>", | |
| "nextgenStatus": "<string>", | |
| "labId": "<string>", | |
| "signoffCommentsIndicator": "<string>", | |
| "documentsIndicator": "<string>", | |
| "orderControl": "<string>", | |
| "orderPriority": "<string>", | |
| "timeEntered": "<string>", | |
| "specimenActionCode": "<string>", | |
| "billingType": "<string>", | |
| "clinicalInformation": "<string>", | |
| "cancelReason": "<string>", | |
| "intrfMessage": "<string>", | |
| "practiceId": "<string>", | |
| "enterpriseId": "<string>", | |
| "isDeleted": "<string>", | |
| "providerDisplayName": "<string>", | |
| "locationName": "<string>", | |
| "addressLine1": "<string>", | |
| "addressLine2": "<string>", | |
| "city": "<string>", | |
| "state": "<string>", | |
| "zip": "<string>", | |
| "phone": "<string>", | |
| "fax": "<string>", | |
| "firstName": "<string>", | |
| "lastName": "<string>", | |
| "middleInitial": "<string>", | |
| "isFutureOrder": "<string>", | |
| "startDate": "<string>", | |
| "nextDueDate": "<string>", | |
| "expectedResultDate": "<string>", | |
| "generalComment": "<string>", | |
| "orderComment": "<string>", | |
| "patientComment": "<string>", | |
| "isOrderedElseWhere": "<string>", | |
| "isCompleted": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/lab/orders": { | |
| "get": { | |
| "description": "Gets a list of lab order summaries for the specified person id after applying additional OData query operations.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/lab/orders", | |
| "tags": [ | |
| "Laboratory" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/lab/orders", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "$top", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$filter", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$orderby", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$skip", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$inlinecount", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$count", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose lab orders are being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK54" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "Items": [ | |
| { | |
| "id": "<string>", | |
| "testDescription": "<string>", | |
| "testStatus": "<string>", | |
| "nextgenStatus": "<string>", | |
| "labId": "<string>", | |
| "encounterId": "<string>", | |
| "encounterTimestamp": "<string>", | |
| "personId": "<string>", | |
| "ufoNumber": "<string>", | |
| "generatedBy": "<string>", | |
| "orderType": "<string>", | |
| "testLocation": "<string>", | |
| "orderControl": "<string>", | |
| "orderPriority": "<string>", | |
| "orderingProvider": "<string>", | |
| "orderDate": "<string>", | |
| "orderDateTimezone": "<string>", | |
| "signOffDate": "<string>", | |
| "intrfMessage": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "isDeleted": "<string>", | |
| "signOffPerson": "<string>", | |
| "isFutureOrder": "<string>", | |
| "startDate": "<string>", | |
| "nextDueDate": "<string>", | |
| "expectedResultDate": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "id": "<string>", | |
| "testDescription": "<string>", | |
| "testStatus": "<string>", | |
| "nextgenStatus": "<string>", | |
| "labId": "<string>", | |
| "encounterId": "<string>", | |
| "encounterTimestamp": "<string>", | |
| "personId": "<string>", | |
| "ufoNumber": "<string>", | |
| "generatedBy": "<string>", | |
| "orderType": "<string>", | |
| "testLocation": "<string>", | |
| "orderControl": "<string>", | |
| "orderPriority": "<string>", | |
| "orderingProvider": "<string>", | |
| "orderDate": "<string>", | |
| "orderDateTimezone": "<string>", | |
| "signOffDate": "<string>", | |
| "intrfMessage": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "isDeleted": "<string>", | |
| "signOffPerson": "<string>", | |
| "isFutureOrder": "<string>", | |
| "startDate": "<string>", | |
| "nextDueDate": "<string>", | |
| "expectedResultDate": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ], | |
| "NextPageLink": "<string>", | |
| "Count": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/lab/orders/{orderId}": { | |
| "delete": { | |
| "description": "Delete the specified order id for the person id.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId", | |
| "tags": [ | |
| "Laboratory" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose order is to be deleted." | |
| }, | |
| { | |
| "name": "orderId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the order that is to be deleted." | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "get": { | |
| "description": "Gets the lab order details for the given person id and order id.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId1", | |
| "tags": [ | |
| "Laboratory" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId1", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose lab orders are being retrieved" | |
| }, | |
| { | |
| "name": "orderId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the lab order being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK53" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "id": "<string>", | |
| "testDescription": "<string>", | |
| "encounterId": "<string>", | |
| "personId": "<string>", | |
| "ufoNumber": "<string>", | |
| "generatedBy": "<string>", | |
| "orderType": "<string>", | |
| "testLocation": "<string>", | |
| "orderingProvider": "<string>", | |
| "encounterTimestamp": "<string>", | |
| "orderDate": "<string>", | |
| "orderDateTimezone": "<string>", | |
| "signOffDate": "<string>", | |
| "signOffPerson": "<string>", | |
| "testStatus": "<string>", | |
| "nextgenStatus": "<string>", | |
| "labId": "<string>", | |
| "signoffCommentsIndicator": "<string>", | |
| "documentsIndicator": "<string>", | |
| "orderControl": "<string>", | |
| "orderPriority": "<string>", | |
| "timeEntered": "<string>", | |
| "specimenActionCode": "<string>", | |
| "billingType": "<string>", | |
| "clinicalInformation": "<string>", | |
| "cancelReason": "<string>", | |
| "intrfMessage": "<string>", | |
| "practiceId": "<string>", | |
| "enterpriseId": "<string>", | |
| "isDeleted": "<string>", | |
| "providerDisplayName": "<string>", | |
| "locationName": "<string>", | |
| "addressLine1": "<string>", | |
| "addressLine2": "<string>", | |
| "city": "<string>", | |
| "state": "<string>", | |
| "zip": "<string>", | |
| "phone": "<string>", | |
| "fax": "<string>", | |
| "firstName": "<string>", | |
| "lastName": "<string>", | |
| "middleInitial": "<string>", | |
| "isFutureOrder": "<string>", | |
| "startDate": "<string>", | |
| "nextDueDate": "<string>", | |
| "expectedResultDate": "<string>", | |
| "generalComment": "<string>", | |
| "orderComment": "<string>", | |
| "patientComment": "<string>", | |
| "isOrderedElseWhere": "<string>", | |
| "isCompleted": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "put": { | |
| "description": "Update the specified lab order id for the person id.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId", | |
| "tags": [ | |
| "Laboratory" | |
| ], | |
| "operationId": "Put{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose order is to be updated." | |
| }, | |
| { | |
| "name": "orderId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the order that is to be updated." | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1lab~1orders~1%3AorderIdRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/lab/orders/{orderId}/insurances": { | |
| "get": { | |
| "description": "Get a list of insurances that are associated with the specified person Id and order Id after apply additional OData operations.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/insurances", | |
| "tags": [ | |
| "Laboratory" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/insurances", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "$top", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$filter", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$orderby", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$skip", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$inlinecount", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$count", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person for whom the order insurances are being retrieved." | |
| }, | |
| { | |
| "name": "orderId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the lab order for which the insurances are being retrieved." | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK56" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "Items": [ | |
| { | |
| "id": "<string>", | |
| "personPayerId": "<string>", | |
| "payerId": "<string>", | |
| "insuredPersonId": "<string>", | |
| "cob": "<string>", | |
| "orderNumber": "<string>", | |
| "personId": "<string>", | |
| "lastName": "<string>", | |
| "firstName": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "payerName": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "id": "<string>", | |
| "personPayerId": "<string>", | |
| "payerId": "<string>", | |
| "insuredPersonId": "<string>", | |
| "cob": "<string>", | |
| "orderNumber": "<string>", | |
| "personId": "<string>", | |
| "lastName": "<string>", | |
| "firstName": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "payerName": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ], | |
| "NextPageLink": "<string>", | |
| "Count": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/lab/orders/{orderId}/schedule": { | |
| "get": { | |
| "description": "Get the schedule details for the specified person id and order id.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/schedule", | |
| "tags": [ | |
| "Laboratory" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/schedule", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose order schedule is being retrieved." | |
| }, | |
| { | |
| "name": "orderId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the order whose schedule is being retrieved." | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK57" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "id": "<string>", | |
| "personId": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "orderId": "<string>", | |
| "orderType": "<string>", | |
| "isFutureOrder": "<string>", | |
| "scheduleType": "<string>", | |
| "startDate": "<string>", | |
| "endDate": "<string>", | |
| "interval": "<string>", | |
| "timespan": "<string>", | |
| "createdBy": "<string>", | |
| "createTimestamp": "<string>", | |
| "nextDueDate": "<string>", | |
| "modifiedBy": "<string>", | |
| "isAutoReleasable": "<string>", | |
| "maxOccurrence": "<string>", | |
| "stopDate": "<string>", | |
| "stopReason": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "post": { | |
| "description": "Set the schedule for the specified person id and order id.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/schedule", | |
| "tags": [ | |
| "Laboratory" | |
| ], | |
| "operationId": "Post{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/schedule", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose order is being scheduled." | |
| }, | |
| { | |
| "name": "orderId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the order that is being scheduled." | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1lab~1orders~1%3AorderId~1scheduleRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/lab/orders/{orderId}/send": { | |
| "post": { | |
| "description": "Adds a record to the interface queue with the provided order Id and lab interface agent information that is determined based on the order's lab Id. This route does not control when the order will be processed and sent out to the lab which is controlled by the interface.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/send", | |
| "tags": [ | |
| "Laboratory" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/send", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) Id of the person whose order is being sent to interface" | |
| }, | |
| { | |
| "name": "orderId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) Id of the lab order which is being sent to interface" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/lab/orders/{orderId}/tests": { | |
| "get": { | |
| "description": "Gets a list of ordered test summaries for the specified person id and order id after apply additional OData operations.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/tests", | |
| "tags": [ | |
| "Laboratory" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/tests", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "$top", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$filter", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$orderby", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$skip", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$inlinecount", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$count", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose ordered tests are being retrieved." | |
| }, | |
| { | |
| "name": "orderId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the lab order for which the ordered tests are being retrieved." | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK58" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "id": "<string>", | |
| "orderId": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "personId": "<string>", | |
| "testCodeId": "<string>", | |
| "testCodeText": "<string>", | |
| "testCodeSystem": "<string>", | |
| "testComment": "<string>", | |
| "collectionTime": "<string>", | |
| "collectionTimezone": "<string>", | |
| "expectedResultDate": "<string>", | |
| "scheduledTime": "<string>", | |
| "scheduledTimezone": "<string>", | |
| "loincCode": "<string>", | |
| "chargeId": "<string>", | |
| "orderingReason": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "post": { | |
| "description": "Add a lab test to the specified order id for the person id.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/tests", | |
| "tags": [ | |
| "Laboratory" | |
| ], | |
| "operationId": "Post{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/tests", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person where the new lab test will be added to the order." | |
| }, | |
| { | |
| "name": "orderId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the order where the new lab test will be added." | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "example": [ | |
| { | |
| "TestCodeId": "<string>", | |
| "IsNextGenCompendiumTest": "<string>", | |
| "ScheduleDateTime": "<string>", | |
| "VolumeQuantity": "<string>", | |
| "VolumeUnit": "<string>", | |
| "CollectionDate": "<string>", | |
| "SourceSite": "<string>", | |
| "SourceDescription": "<string>", | |
| "Additives": "<string>", | |
| "BodySite": "<string>", | |
| "SiteModifier": "<string>", | |
| "SpecimenRole": "<string>", | |
| "SpecimenStorage": "<string>", | |
| "CollectionMethod": "<string>", | |
| "Comment": "<string>", | |
| "OrderingReason": "<string>", | |
| "ExpectedResultDate": "<string>", | |
| "GeneratedBy": "<string>" | |
| }, | |
| { | |
| "TestCodeId": "<string>", | |
| "IsNextGenCompendiumTest": "<string>", | |
| "ScheduleDateTime": "<string>", | |
| "VolumeQuantity": "<string>", | |
| "VolumeUnit": "<string>", | |
| "CollectionDate": "<string>", | |
| "SourceSite": "<string>", | |
| "SourceDescription": "<string>", | |
| "Additives": "<string>", | |
| "BodySite": "<string>", | |
| "SiteModifier": "<string>", | |
| "SpecimenRole": "<string>", | |
| "SpecimenStorage": "<string>", | |
| "CollectionMethod": "<string>", | |
| "Comment": "<string>", | |
| "OrderingReason": "<string>", | |
| "ExpectedResultDate": "<string>", | |
| "GeneratedBy": "<string>" | |
| } | |
| ], | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1lab~1orders~1%3AorderId~1testsRequest" | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/lab/orders/{orderId}/tests/{testId}": { | |
| "delete": { | |
| "description": "Deletes the specified ordered test for the person and order.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/tests/:testId", | |
| "tags": [ | |
| "Laboratory" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/tests/:testId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose ordered test will be deleted." | |
| }, | |
| { | |
| "name": "orderId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the order whose ordered test will be deleted." | |
| }, | |
| { | |
| "name": "testId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the order test to be deleted." | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "get": { | |
| "description": "Gets the ordered test for the specified person id, order id and test id.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/tests/:testId1", | |
| "tags": [ | |
| "Laboratory" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/tests/:testId1", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient to retrieve the ordered test for." | |
| }, | |
| { | |
| "name": "orderId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the lab order which contains the test that were ordered." | |
| }, | |
| { | |
| "name": "testId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the ordered test being retrieved." | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK59" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "id": "<string>", | |
| "orderId": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "personId": "<string>", | |
| "testCodeId": "<string>", | |
| "testCodeText": "<string>", | |
| "testCodeSystem": "<string>", | |
| "collectionTime": "<string>", | |
| "volumeQuantity": "<string>", | |
| "volumeUnits": "<string>", | |
| "specSrcCode": "<string>", | |
| "specSrcDesc": "<string>", | |
| "specSrcAdditives": "<string>", | |
| "scheduledTime": "<string>", | |
| "createdBy": "<string>", | |
| "generatedBy": "<string>", | |
| "createTimestamp": "<string>", | |
| "modifiedBy": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "loincCode": "<string>", | |
| "snomedCode": "<string>", | |
| "specSrcBodySite": "<string>", | |
| "specSrcSiteModifier": "<string>", | |
| "specSrcRole": "<string>", | |
| "specSrcStorage": "<string>", | |
| "specSrcCollectionMethod": "<string>", | |
| "collectorId": "<string>", | |
| "testComment": "<string>", | |
| "expectedResultDate": "<string>", | |
| "collectionTimezone": "<string>", | |
| "scheduledTimezone": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "modifyTimestampTimezone": "<string>", | |
| "chargeId": "<string>", | |
| "orderingReason": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "put": { | |
| "description": "Updates the specified order test for the specified person and order.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/tests/:testId", | |
| "tags": [ | |
| "Laboratory" | |
| ], | |
| "operationId": "Put{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/tests/:testId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose ordered test is to be updated." | |
| }, | |
| { | |
| "name": "orderId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the order whose ordered test is to be updated." | |
| }, | |
| { | |
| "name": "testId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the ordered test that is to be updated." | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1lab~1orders~1%3AorderId~1tests~1%3AtestIdRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/lab/orders/{orderId}/tests/{testId}/order-entry-answers": { | |
| "get": { | |
| "description": "Gets a list of order entry answers for the specified person id, order id and test id after applying additional OData operations.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/tests/:testId/order-entry-answers", | |
| "tags": [ | |
| "Laboratory" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/tests/:testId/order-entry-answers", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "$top", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$filter", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$orderby", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$skip", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$inlinecount", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$count", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose order entry answers are being retrieved." | |
| }, | |
| { | |
| "name": "orderId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the order whose order entry answers are being retrieved." | |
| }, | |
| { | |
| "name": "testId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the ordered test whose order entry answers are being retrieved." | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK60" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "Items": [ | |
| { | |
| "id": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "personId": "<string>", | |
| "orderId": "<string>", | |
| "orderedTestId": "<string>", | |
| "answer": "<string>", | |
| "questionCode": "<string>", | |
| "createdBy": "<string>", | |
| "createTimestamp": "<string>", | |
| "modifiedBy": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "id": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "personId": "<string>", | |
| "orderId": "<string>", | |
| "orderedTestId": "<string>", | |
| "answer": "<string>", | |
| "questionCode": "<string>", | |
| "createdBy": "<string>", | |
| "createTimestamp": "<string>", | |
| "modifiedBy": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ], | |
| "NextPageLink": "<string>", | |
| "Count": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "post": { | |
| "description": "Adds an answer to an order entry question for the specified person id, order id and test id.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/tests/:testId/order-entry-answers", | |
| "tags": [ | |
| "Laboratory" | |
| ], | |
| "operationId": "Post{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/tests/:testId/order-entry-answers", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) This id of the person whose order entry answer is to be added." | |
| }, | |
| { | |
| "name": "orderId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the order whose order entry answer is to be added." | |
| }, | |
| { | |
| "name": "testId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the ordered test whose order entry answer is to be added." | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1lab~1orders~1%3AorderId~1tests~1%3AtestId~1order-entry-answers-Request" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/lab/orders/{orderId}/tests/{testId}/order-entry-answers/{answerId}": { | |
| "delete": { | |
| "description": "Delete the specified order entry answer for the specified person id, order id and ordered test id.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/tests/:testId/order-entry-answers/:answerId", | |
| "tags": [ | |
| "Laboratory" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/tests/:testId/order-entry-answers/:answerId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose order entry answer is being deleted." | |
| }, | |
| { | |
| "name": "orderId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the order whose order entry answer is being deleted." | |
| }, | |
| { | |
| "name": "testId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the ordered test id whose order entry answer is being deleted." | |
| }, | |
| { | |
| "name": "answerId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required)" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "put": { | |
| "description": "Updates the specifed order entry answer for the specified person id, order id, test id and answer id.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/tests/:testId/order-entry-answers/:answerId", | |
| "tags": [ | |
| "Laboratory" | |
| ], | |
| "operationId": "Put{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/tests/:testId/order-entry-answers/:answerId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose order entry answer is being updated." | |
| }, | |
| { | |
| "name": "orderId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the order whose order entry answer is being updated." | |
| }, | |
| { | |
| "name": "testId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the ordered test id whose order entry answer is being udpated." | |
| }, | |
| { | |
| "name": "answerId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the order entry answer to update." | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1lab~1orders~1%3AorderId~1tests~1%3AtestId~1order-entry-answers~1%3AanswerId-Request" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/lab/orders/{orderId}/tests/{testId}/suspected-diagnoses": { | |
| "get": { | |
| "description": "Get a list of suspected diagnosis for the specified ordered test id after applying addition OData operations.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/tests/:testId/suspected-diagnoses", | |
| "tags": [ | |
| "Laboratory" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/tests/:testId/suspected-diagnoses", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "$top", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$filter", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$orderby", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$skip", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$inlinecount", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$count", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose suspected diagnoses are being retrieved." | |
| }, | |
| { | |
| "name": "orderId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the lab order which contains the test whose suspected diagnosis are beign retrieved." | |
| }, | |
| { | |
| "name": "testId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the ordered test whose suspected diagnosis are being retrieved." | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK61" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "Items": [ | |
| { | |
| "id": "<string>", | |
| "orderNumber": "<string>", | |
| "personId": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "orderTestId": "<string>", | |
| "diagnosisCodeLibraryId": "<string>", | |
| "diagnosisCodeId": "<string>", | |
| "description": "<string>", | |
| "icd9cmCodeId": "<string>", | |
| "userDescription": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "id": "<string>", | |
| "orderNumber": "<string>", | |
| "personId": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "orderTestId": "<string>", | |
| "diagnosisCodeLibraryId": "<string>", | |
| "diagnosisCodeId": "<string>", | |
| "description": "<string>", | |
| "icd9cmCodeId": "<string>", | |
| "userDescription": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ], | |
| "NextPageLink": "<string>", | |
| "Count": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "post": { | |
| "description": "Adds a suspected diagnosis for the specified person id, order id and test id.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/tests/:testId/suspected-diagnoses", | |
| "tags": [ | |
| "Laboratory" | |
| ], | |
| "operationId": "Post{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/tests/:testId/suspected-diagnoses", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person for which the suspected diagnosis will be added." | |
| }, | |
| { | |
| "name": "orderId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the order for which the suspected diagnosis will be added." | |
| }, | |
| { | |
| "name": "testId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the ordered test for which the suspected diagnosis will be added." | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "example": [ | |
| { | |
| "DiagnosisCodeLibraryId": "<string>", | |
| "DiagnosisCodeId": "<string>" | |
| }, | |
| { | |
| "DiagnosisCodeLibraryId": "<string>", | |
| "DiagnosisCodeId": "<string>" | |
| } | |
| ], | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1lab~1orders~1%3AorderId~1tests~1%3AtestId~1suspected-diagnoses-Request" | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/lab/orders/{orderId}/tests/{testId}/suspected-diagnoses/{diagnosisId}": { | |
| "delete": { | |
| "description": "Delete the specified suspected diagnosis for the specified person id, order id and test id.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/tests/:testId/suspected-diagnoses/:diagnosisId", | |
| "tags": [ | |
| "Laboratory" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/tests/:testId/suspected-diagnoses/:diagnosisId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose suspected diagnosis is to be deleted." | |
| }, | |
| { | |
| "name": "orderId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the order whose suspected diagnosis is to be deleted." | |
| }, | |
| { | |
| "name": "testId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the ordered test whose suspected diagnosis is to be deleted." | |
| }, | |
| { | |
| "name": "diagnosisId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the suspected diagnosis to be deleted." | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/lab/orders/{orderId}/tracking-comments": { | |
| "get": { | |
| "description": "Gets a list of tracking comments for the given person id and order id.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/tracking-comments", | |
| "tags": [ | |
| "Laboratory" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/tracking-comments", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person who the order belongs to" | |
| }, | |
| { | |
| "name": "orderId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the order whose tracking comments are being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK41" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "id": "<string>", | |
| "orderId": "<string>", | |
| "personId": "<string>", | |
| "providerId": "<string>", | |
| "authorName": "<string>", | |
| "authorDisplayName": "<string>", | |
| "userName": "<string>", | |
| "isDelegate": "<string>", | |
| "createTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "comment": "<string>", | |
| "type": "<string>", | |
| "generatedBy": "<string>", | |
| "isAutoGenerated": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "post": { | |
| "description": "Adds a tracking comment for the given person id and lab order id.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/tracking-comments", | |
| "tags": [ | |
| "Laboratory" | |
| ], | |
| "operationId": "Post{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/tracking-comments", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person who the order belongs to." | |
| }, | |
| { | |
| "name": "orderId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the lab order which the tracking comment will be added for." | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1lab~1orders~1%3AorderId~1tracking-comments-Request" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/lab/panels": { | |
| "get": { | |
| "description": "Gets a list of observation panels for the specified person id after applying additional OData operations.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/lab/panels", | |
| "tags": [ | |
| "Laboratory" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/lab/panels", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "$top", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$filter", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$orderby", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$skip", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$inlinecount", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$count", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person for whom the observation panels are being retrieved." | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK63" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "Items": [ | |
| { | |
| "id": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "personId": "<string>", | |
| "orderId": "<string>", | |
| "collectionDateTime": "<string>", | |
| "collectionDateTimeTimezone": "<string>", | |
| "orderingProviderId": "<string>", | |
| "resultStatus": "<string>", | |
| "testDescription": "<string>", | |
| "isDeleted": "<string>", | |
| "createTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "locationId": "<string>", | |
| "obrComment": "<string>", | |
| "loincCode": "<string>", | |
| "isConfidential": "<string>", | |
| "orderTestId": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "id": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "personId": "<string>", | |
| "orderId": "<string>", | |
| "collectionDateTime": "<string>", | |
| "collectionDateTimeTimezone": "<string>", | |
| "orderingProviderId": "<string>", | |
| "resultStatus": "<string>", | |
| "testDescription": "<string>", | |
| "isDeleted": "<string>", | |
| "createTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "locationId": "<string>", | |
| "obrComment": "<string>", | |
| "loincCode": "<string>", | |
| "isConfidential": "<string>", | |
| "orderTestId": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ], | |
| "NextPageLink": "<string>", | |
| "Count": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "post": { | |
| "description": "Adds an observation panel the specified person.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/lab/panels", | |
| "tags": [ | |
| "Laboratory" | |
| ], | |
| "operationId": "Post{{baseUrl}}/persons/:personId/chart/lab/panels", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person to add the observation panel for." | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1lab~1panelsRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/lab/panels/{panelId}": { | |
| "delete": { | |
| "description": "Delete the specified observation panel for the specified person id.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/lab/panels/:panelId", | |
| "tags": [ | |
| "Laboratory" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/lab/panels/:panelId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose observation panel is to be deleted." | |
| }, | |
| { | |
| "name": "panelId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the observation panel to be deleted." | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "get": { | |
| "description": "Gets an observation panel for the specified person id and panel id.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/lab/panels/:panelId1", | |
| "tags": [ | |
| "Laboratory" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/lab/panels/:panelId1", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose observation panel is being retrieved." | |
| }, | |
| { | |
| "name": "panelId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the observation panel being retrieved." | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK64" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "id": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "personId": "<string>", | |
| "orderId": "<string>", | |
| "collectionDateTime": "<string>", | |
| "collectionDateTimeTimezone": "<string>", | |
| "orderingProviderId": "<string>", | |
| "resultStatus": "<string>", | |
| "testDescription": "<string>", | |
| "isDeleted": "<string>", | |
| "createTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "locationId": "<string>", | |
| "obrComment": "<string>", | |
| "loincCode": "<string>", | |
| "isConfidential": "<string>", | |
| "orderTestId": "<string>", | |
| "isMicrobiology": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "put": { | |
| "description": "Update the specified observation panel for the specified personId.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/lab/panels/:panelId", | |
| "tags": [ | |
| "Laboratory" | |
| ], | |
| "operationId": "Put{{baseUrl}}/persons/:personId/chart/lab/panels/:panelId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose observation panel is to be updated." | |
| }, | |
| { | |
| "name": "panelId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the panel to be updated." | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1lab~1panels~1%3ApanelIdRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/lab/panels/{panelId}/results": { | |
| "get": { | |
| "description": "Gets a list of observation results for the specified person id and observation panel id.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/lab/panels/:panelId/results", | |
| "tags": [ | |
| "Laboratory" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/lab/panels/:panelId/results", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose observation results are being retrieved." | |
| }, | |
| { | |
| "name": "panelId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the observation panel for whose observation results are being retrieved." | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK65" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "panelId": "<string>", | |
| "personId": "<string>", | |
| "orderId": "<string>", | |
| "observationSequenceNumber": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "observationId": "<string>", | |
| "resultCode": "<string>", | |
| "resultDescription": "<string>", | |
| "codeSystem": "<string>", | |
| "observationValue": "<string>", | |
| "abnormalityCode": "<string>", | |
| "abnormality": "<string>", | |
| "resultType": "<string>", | |
| "units": "<string>", | |
| "referenceRange": "<string>", | |
| "observationResultStatus": "<string>", | |
| "clinicalName": "<string>", | |
| "observationDateTime": "<string>", | |
| "observationDateTimeTimezone": "<string>", | |
| "loincCode": "<string>", | |
| "resultSequenceNumber": "<string>", | |
| "hasComment": "<string>", | |
| "isDeleted": "<string>", | |
| "isSignedOff": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "post": { | |
| "description": "Adds observation results for the specified person id and panel id.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/lab/panels/:panelId/results", | |
| "tags": [ | |
| "Laboratory" | |
| ], | |
| "operationId": "Post{{baseUrl}}/persons/:personId/chart/lab/panels/:panelId/results", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person to add observation results for." | |
| }, | |
| { | |
| "name": "panelId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the observation panel to add results to." | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "example": [ | |
| { | |
| "Type": "<string>", | |
| "ComponentKey": "<string>", | |
| "ComponentDescription": "<string>", | |
| "Value": "<string>", | |
| "Unit": "<string>", | |
| "Range": "<string>", | |
| "Comment": "<string>", | |
| "AbnormalFlag": "<string>", | |
| "CodeSystem": "<string>", | |
| "ObservationDate": "<string>", | |
| "LoincCode": "<string>" | |
| }, | |
| { | |
| "Type": "<string>", | |
| "ComponentKey": "<string>", | |
| "ComponentDescription": "<string>", | |
| "Value": "<string>", | |
| "Unit": "<string>", | |
| "Range": "<string>", | |
| "Comment": "<string>", | |
| "AbnormalFlag": "<string>", | |
| "CodeSystem": "<string>", | |
| "ObservationDate": "<string>", | |
| "LoincCode": "<string>" | |
| } | |
| ], | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1lab~1panels~1%3ApanelId~1resultsRequest" | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/lab/panels/{panelId}/results/{sequenceNumber}": { | |
| "delete": { | |
| "description": "Delete the specified observation result for the specifed person id and panel id.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/lab/panels/:panelId/results/:sequenceNumber", | |
| "tags": [ | |
| "Laboratory" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/lab/panels/:panelId/results/:sequenceNumber", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of person whose observation result is to be deleted." | |
| }, | |
| { | |
| "name": "panelId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the panel whose observation result is to be deleted." | |
| }, | |
| { | |
| "name": "sequenceNumber", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The observation result sequence number that is to be deleted." | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "put": { | |
| "description": "Update the specified observation result for the specifed person id, panel id and sequenceNumber.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/lab/panels/:panelId/results/:sequenceNumber", | |
| "tags": [ | |
| "Laboratory" | |
| ], | |
| "operationId": "Put{{baseUrl}}/persons/:personId/chart/lab/panels/:panelId/results/:sequenceNumber", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of person whose observation result is to be updated." | |
| }, | |
| { | |
| "name": "panelId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the panel whose observation result is to be updated." | |
| }, | |
| { | |
| "name": "sequenceNumber", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The observation result sequence number that is to be updated." | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1lab~1panels~1%3ApanelId~1results~1%3AsequenceNumberRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/lab/results": { | |
| "get": { | |
| "description": "Gets a list of observation results for the specified person id after applying additional OData operations.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/lab/results", | |
| "tags": [ | |
| "Laboratory" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/lab/results", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "$top", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$filter", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$orderby", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$skip", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$inlinecount", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$count", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose observation results are being retrieved." | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK66" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "Items": [ | |
| { | |
| "panelId": "<string>", | |
| "personId": "<string>", | |
| "orderId": "<string>", | |
| "observationSequenceNumber": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "observationId": "<string>", | |
| "resultCode": "<string>", | |
| "resultDescription": "<string>", | |
| "codeSystem": "<string>", | |
| "observationValue": "<string>", | |
| "abnormalityCode": "<string>", | |
| "abnormality": "<string>", | |
| "resultType": "<string>", | |
| "units": "<string>", | |
| "referenceRange": "<string>", | |
| "observationResultStatus": "<string>", | |
| "clinicalName": "<string>", | |
| "observationDateTime": "<string>", | |
| "observationDateTimeTimezone": "<string>", | |
| "loincCode": "<string>", | |
| "resultSequenceNumber": "<string>", | |
| "hasComment": "<string>", | |
| "isDeleted": "<string>", | |
| "isSignedOff": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "panelId": "<string>", | |
| "personId": "<string>", | |
| "orderId": "<string>", | |
| "observationSequenceNumber": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "observationId": "<string>", | |
| "resultCode": "<string>", | |
| "resultDescription": "<string>", | |
| "codeSystem": "<string>", | |
| "observationValue": "<string>", | |
| "abnormalityCode": "<string>", | |
| "abnormality": "<string>", | |
| "resultType": "<string>", | |
| "units": "<string>", | |
| "referenceRange": "<string>", | |
| "observationResultStatus": "<string>", | |
| "clinicalName": "<string>", | |
| "observationDateTime": "<string>", | |
| "observationDateTimeTimezone": "<string>", | |
| "loincCode": "<string>", | |
| "resultSequenceNumber": "<string>", | |
| "hasComment": "<string>", | |
| "isDeleted": "<string>", | |
| "isSignedOff": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ], | |
| "NextPageLink": "<string>", | |
| "Count": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/charts/medications": { | |
| "get": { | |
| "description": "GETs medications created or modified within a given interval. If an oData filter of createTimestamp or modifyTimestamp is not specified, medications which are created or modified within the last 7 days are retrieved.", | |
| "summary": "{{baseUrl}}/persons/charts/medications", | |
| "tags": [ | |
| "Medications" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/charts/medications", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "$top", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$filter", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$orderby", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$skip", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$inlinecount", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$count", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK67" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "Items": [ | |
| { | |
| "id": "<string>", | |
| "personId": "<string>", | |
| "providerId": "<string>", | |
| "fdbName": "<string>", | |
| "medicationName": "<string>", | |
| "genericName": "<string>", | |
| "brandName": "<string>", | |
| "isGenericSelected": "<string>", | |
| "dose": "<string>", | |
| "route": "<string>", | |
| "doseForm": "<string>", | |
| "originalStartDate": "<string>", | |
| "startDate": "<string>", | |
| "stopDate": "<string>", | |
| "sigDescription": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "encounterId": "<string>", | |
| "sourceProductId": "<string>", | |
| "lastAuditType": "<string>", | |
| "representativeNdcIndicator": "<string>", | |
| "privacyIndicator": "<string>", | |
| "isHidden": "<string>", | |
| "deaClassCode": "<string>", | |
| "medicationId": "<string>", | |
| "ndcId": "<string>", | |
| "createTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "rxNormCode": "<string>", | |
| "status": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "id": "<string>", | |
| "personId": "<string>", | |
| "providerId": "<string>", | |
| "fdbName": "<string>", | |
| "medicationName": "<string>", | |
| "genericName": "<string>", | |
| "brandName": "<string>", | |
| "isGenericSelected": "<string>", | |
| "dose": "<string>", | |
| "route": "<string>", | |
| "doseForm": "<string>", | |
| "originalStartDate": "<string>", | |
| "startDate": "<string>", | |
| "stopDate": "<string>", | |
| "sigDescription": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "encounterId": "<string>", | |
| "sourceProductId": "<string>", | |
| "lastAuditType": "<string>", | |
| "representativeNdcIndicator": "<string>", | |
| "privacyIndicator": "<string>", | |
| "isHidden": "<string>", | |
| "deaClassCode": "<string>", | |
| "medicationId": "<string>", | |
| "ndcId": "<string>", | |
| "createTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "rxNormCode": "<string>", | |
| "status": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ], | |
| "NextPageLink": "<string>", | |
| "Count": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/medication-history": { | |
| "get": { | |
| "description": "Gets a list of medication history records for the specified person id.", | |
| "summary": "{{baseUrl}}/persons/:personId/medication-history", | |
| "tags": [ | |
| "Medications" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/medication-history", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose medication history is being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK68" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "medicationHistoryId": "<string>", | |
| "personId": "<string>", | |
| "pbmId": "<string>", | |
| "source": "<string>", | |
| "drugDescription": "<string>", | |
| "ndcId": "<string>", | |
| "quantity": "<string>", | |
| "daysSupply": "<string>", | |
| "directions": "<string>", | |
| "refills": "<string>", | |
| "isSubstitutionAllowed": "<string>", | |
| "lastFillDate": "<string>", | |
| "writtenDate": "<string>", | |
| "note": "<string>", | |
| "priorAuthorizationStatus": "<string>", | |
| "pharmacyName": "<string>", | |
| "pharmacyAddressLine1": "<string>", | |
| "pharmacyCity": "<string>", | |
| "pharmacyState": "<string>", | |
| "pharmacyZip": "<string>", | |
| "pharmacyPhoneNumber": "<string>", | |
| "prescriberName": "<string>", | |
| "prescriberAddressLine1": "<string>", | |
| "prescriberCity": "<string>", | |
| "prescriberState": "<string>", | |
| "prescriberZip": "<string>", | |
| "prescriberPhoneNumber": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/medication-history/create-consent": { | |
| "post": { | |
| "description": "Creates medication history consent for a given person id", | |
| "summary": "{{baseUrl}}/persons/:personId/medication-history/create-consent", | |
| "tags": [ | |
| "Medications" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/medication-history/create-consent", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person for which medication history consent is being created" | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1medication-history~1create-consent-Request" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/medication-history/create-request": { | |
| "post": { | |
| "description": "Creates an medication history request for the given person id", | |
| "summary": "{{baseUrl}}/persons/:personId/medication-history/create-request", | |
| "tags": [ | |
| "Medications" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/medication-history/create-request", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person for which medication history is being requested" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/encounters/{encounterId}/medications": { | |
| "get": { | |
| "description": "Gets a list of patient medication for the specified person id and encounter id after applying additional OData query operations.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/medications", | |
| "tags": [ | |
| "Medications" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/medications", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "$top", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$filter", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$orderby", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$skip", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$inlinecount", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$count", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose medications are being retrieved" | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the encounter for which the medications are retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK67" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "Items": [ | |
| { | |
| "id": "<string>", | |
| "personId": "<string>", | |
| "providerId": "<string>", | |
| "fdbName": "<string>", | |
| "medicationName": "<string>", | |
| "genericName": "<string>", | |
| "brandName": "<string>", | |
| "isGenericSelected": "<string>", | |
| "dose": "<string>", | |
| "route": "<string>", | |
| "doseForm": "<string>", | |
| "originalStartDate": "<string>", | |
| "startDate": "<string>", | |
| "stopDate": "<string>", | |
| "sigDescription": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "encounterId": "<string>", | |
| "sourceProductId": "<string>", | |
| "lastAuditType": "<string>", | |
| "representativeNdcIndicator": "<string>", | |
| "privacyIndicator": "<string>", | |
| "isHidden": "<string>", | |
| "deaClassCode": "<string>", | |
| "medicationId": "<string>", | |
| "ndcId": "<string>", | |
| "createTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "rxNormCode": "<string>", | |
| "status": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "id": "<string>", | |
| "personId": "<string>", | |
| "providerId": "<string>", | |
| "fdbName": "<string>", | |
| "medicationName": "<string>", | |
| "genericName": "<string>", | |
| "brandName": "<string>", | |
| "isGenericSelected": "<string>", | |
| "dose": "<string>", | |
| "route": "<string>", | |
| "doseForm": "<string>", | |
| "originalStartDate": "<string>", | |
| "startDate": "<string>", | |
| "stopDate": "<string>", | |
| "sigDescription": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "encounterId": "<string>", | |
| "sourceProductId": "<string>", | |
| "lastAuditType": "<string>", | |
| "representativeNdcIndicator": "<string>", | |
| "privacyIndicator": "<string>", | |
| "isHidden": "<string>", | |
| "deaClassCode": "<string>", | |
| "medicationId": "<string>", | |
| "ndcId": "<string>", | |
| "createTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "rxNormCode": "<string>", | |
| "status": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ], | |
| "NextPageLink": "<string>", | |
| "Count": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "post": { | |
| "description": "Adds a new medication for the given person id and encounter id", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/medications", | |
| "tags": [ | |
| "Medications" | |
| ], | |
| "operationId": "Post{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/medications", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person for which the medication is being added" | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the encounter in which the medication is being added" | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1encounters~1%3AencounterId~1medicationsRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/encounters/{encounterId}/medications/{medicationId}": { | |
| "delete": { | |
| "description": "deletes a medication for a given person id, encounter id and medication id", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/medications/:medicationId", | |
| "tags": [ | |
| "Medications" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/medications/:medicationId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person for which the medication is being deleted" | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the encounter in which the medication is being deleted" | |
| }, | |
| { | |
| "name": "medicationId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient medication that is being deleted" | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1encounters~1%3AencounterId~1medications~1%3AmedicationIdRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "get": { | |
| "description": "Gets the patient medication details for the given person id, encounter id and patient medication id.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/medications/:medicationId", | |
| "tags": [ | |
| "Medications" | |
| ], | |
| "operationId": "Get{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/medications/:medicationId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient of whose medication is being retrieved" | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the encounter for which the medication is being retrieved" | |
| }, | |
| { | |
| "name": "medicationId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient medication being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK70" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "id": "<string>", | |
| "fdbName": "<string>", | |
| "medicationName": "<string>", | |
| "genericName": "<string>", | |
| "brandName": "<string>", | |
| "dose": "<string>", | |
| "doseForm": "<string>", | |
| "ndcId": "<string>", | |
| "gcn": "<string>", | |
| "route": "<string>", | |
| "hiclSequenceNumber": "<string>", | |
| "gcnSequenceNumber": "<string>", | |
| "deaClassCode": "<string>", | |
| "medicationId": "<string>", | |
| "isAvailable": "<string>", | |
| "createdBy": "<string>", | |
| "createTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "modifiedBy": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "modifyTimestampTimezone": "<string>", | |
| "personId": "<string>", | |
| "encounterId": "<string>", | |
| "encounterProviderId": "<string>", | |
| "encounterTimestamp": "<string>", | |
| "encounterTimestampTimezone": "<string>", | |
| "providerId": "<string>", | |
| "locationId": "<string>", | |
| "practiceId": "<string>", | |
| "practiceName": "<string>", | |
| "enterpriseId": "<string>", | |
| "enterpriseName": "<string>", | |
| "startDate": "<string>", | |
| "originalStartDate": "<string>", | |
| "stopDate": "<string>", | |
| "sigCodes": "<string>", | |
| "rxQuantity": "<string>", | |
| "rxRefills": "<string>", | |
| "isGenericAllowed": "<string>", | |
| "isSample": "<string>", | |
| "dispenseAsWritten": "<string>", | |
| "orgRefills": "<string>", | |
| "lastRefillDate": "<string>", | |
| "sigDescription": "<string>", | |
| "isPrescribedElsewhere": "<string>", | |
| "rxUnits": "<string>", | |
| "rxComment": "<string>", | |
| "rxSpecialInstruction": "<string>", | |
| "printSpanishIndicator": "<string>", | |
| "isGenericSelected": "<string>", | |
| "diagnosisCode": "<string>", | |
| "secondaryDiagnosisCode": "<string>", | |
| "tertiaryDiagnosisCode": "<string>", | |
| "representativeNdcIndicator": "<string>", | |
| "prnReason": "<string>", | |
| "formularyId": "<string>", | |
| "formulaOverrideCode": "<string>", | |
| "formulaOverrideText": "<string>", | |
| "originalRxNdc": "<string>", | |
| "formulaStatus": "<string>", | |
| "auditMask": "<string>", | |
| "auditId": "<string>", | |
| "sendAuditId": "<string>", | |
| "lastAuditType": "<string>", | |
| "lotNumber": "<string>", | |
| "expirationDate": "<string>", | |
| "isPrn": "<string>", | |
| "renewParentId": "<string>", | |
| "rxUnitCode": "<string>", | |
| "oldId": "<string>", | |
| "rxRenewNote": "<string>", | |
| "FdbDosageId": "<string>", | |
| "refillLimit": "<string>", | |
| "refillLimitDate": "<string>", | |
| "prescribedElsewhereLocation": "<string>", | |
| "priorAuthorizationIndicator": "<string>", | |
| "priorAuthorizationId": "<string>", | |
| "priorAuthorizationDate": "<string>", | |
| "privacyIndicator": "<string>", | |
| "refillsRemaining": "<string>", | |
| "customDosageId": "<string>", | |
| "isAutoCalculated": "<string>", | |
| "pbmId": "<string>", | |
| "formularyDetailData": "<string>", | |
| "formularySummaryData": "<string>", | |
| "sourceProductId": "<string>", | |
| "supervisingProviderId": "<string>", | |
| "ineffectiveMedicationIndicator": "<string>", | |
| "pedOrderId": "<string>", | |
| "eCouponNote": "<string>", | |
| "eCouponUrl": "<string>", | |
| "auditTimestamp": "<string>", | |
| "isErxDisabledByState": "<string>", | |
| "isFaxDisabledByState": "<string>", | |
| "isHidden": "<string>", | |
| "isSupply": "<string>", | |
| "rxNormCode": "<string>", | |
| "status": "<string>", | |
| "rxFillIndicator": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "put": { | |
| "description": "Updates a patient medication record for the given person id , encounter id and medication id Note: AcknowledgedProblems in prescription request object will be ignored because DUR check is not done while updating a medication. This field should not be set.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/medications/:medicationId1", | |
| "tags": [ | |
| "Medications" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/medications/:medicationId1", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person for which the medication is being updated" | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the encounter in which the medication is being updated" | |
| }, | |
| { | |
| "name": "medicationId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The unique id of the patient medication being updated" | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1encounters~1%3AencounterId~1medications~1%3AmedicationIdRequest1" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/encounters/{encounterId}/medications/{medicationId}/renew": { | |
| "post": { | |
| "description": "Renews a medication for the given person id, encounter id and medication id", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/medications/:medicationId/renew", | |
| "tags": [ | |
| "Medications" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/medications/:medicationId/renew", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person for which the medication is being added" | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the encounter in which the medication is being added" | |
| }, | |
| { | |
| "name": "medicationId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient medication to be renewed" | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1encounters~1%3AencounterId~1medications~1%3AmedicationId~1renewRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/medications": { | |
| "get": { | |
| "description": "Gets a list of patient medications for the specified person id after applying additional OData query operations.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/medications", | |
| "tags": [ | |
| "Medications" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/medications", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "$top", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$filter", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$orderby", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$skip", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$inlinecount", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$count", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose medications are being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK67" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "Items": [ | |
| { | |
| "id": "<string>", | |
| "personId": "<string>", | |
| "providerId": "<string>", | |
| "fdbName": "<string>", | |
| "medicationName": "<string>", | |
| "genericName": "<string>", | |
| "brandName": "<string>", | |
| "isGenericSelected": "<string>", | |
| "dose": "<string>", | |
| "route": "<string>", | |
| "doseForm": "<string>", | |
| "originalStartDate": "<string>", | |
| "startDate": "<string>", | |
| "stopDate": "<string>", | |
| "sigDescription": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "encounterId": "<string>", | |
| "sourceProductId": "<string>", | |
| "lastAuditType": "<string>", | |
| "representativeNdcIndicator": "<string>", | |
| "privacyIndicator": "<string>", | |
| "isHidden": "<string>", | |
| "deaClassCode": "<string>", | |
| "medicationId": "<string>", | |
| "ndcId": "<string>", | |
| "createTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "rxNormCode": "<string>", | |
| "status": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "id": "<string>", | |
| "personId": "<string>", | |
| "providerId": "<string>", | |
| "fdbName": "<string>", | |
| "medicationName": "<string>", | |
| "genericName": "<string>", | |
| "brandName": "<string>", | |
| "isGenericSelected": "<string>", | |
| "dose": "<string>", | |
| "route": "<string>", | |
| "doseForm": "<string>", | |
| "originalStartDate": "<string>", | |
| "startDate": "<string>", | |
| "stopDate": "<string>", | |
| "sigDescription": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "encounterId": "<string>", | |
| "sourceProductId": "<string>", | |
| "lastAuditType": "<string>", | |
| "representativeNdcIndicator": "<string>", | |
| "privacyIndicator": "<string>", | |
| "isHidden": "<string>", | |
| "deaClassCode": "<string>", | |
| "medicationId": "<string>", | |
| "ndcId": "<string>", | |
| "createTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "rxNormCode": "<string>", | |
| "status": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ], | |
| "NextPageLink": "<string>", | |
| "Count": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/medications/{medicationId}": { | |
| "get": { | |
| "description": "Gets the patient medication details for the given person id and patient medication id.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/medications/:medicationId", | |
| "tags": [ | |
| "Medications" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/medications/:medicationId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose medication is being retrieved" | |
| }, | |
| { | |
| "name": "medicationId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient medication being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK70" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "id": "<string>", | |
| "fdbName": "<string>", | |
| "medicationName": "<string>", | |
| "genericName": "<string>", | |
| "brandName": "<string>", | |
| "dose": "<string>", | |
| "doseForm": "<string>", | |
| "ndcId": "<string>", | |
| "gcn": "<string>", | |
| "route": "<string>", | |
| "hiclSequenceNumber": "<string>", | |
| "gcnSequenceNumber": "<string>", | |
| "deaClassCode": "<string>", | |
| "medicationId": "<string>", | |
| "isAvailable": "<string>", | |
| "createdBy": "<string>", | |
| "createTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "modifiedBy": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "modifyTimestampTimezone": "<string>", | |
| "personId": "<string>", | |
| "encounterId": "<string>", | |
| "encounterProviderId": "<string>", | |
| "encounterTimestamp": "<string>", | |
| "encounterTimestampTimezone": "<string>", | |
| "providerId": "<string>", | |
| "locationId": "<string>", | |
| "practiceId": "<string>", | |
| "practiceName": "<string>", | |
| "enterpriseId": "<string>", | |
| "enterpriseName": "<string>", | |
| "startDate": "<string>", | |
| "originalStartDate": "<string>", | |
| "stopDate": "<string>", | |
| "sigCodes": "<string>", | |
| "rxQuantity": "<string>", | |
| "rxRefills": "<string>", | |
| "isGenericAllowed": "<string>", | |
| "isSample": "<string>", | |
| "dispenseAsWritten": "<string>", | |
| "orgRefills": "<string>", | |
| "lastRefillDate": "<string>", | |
| "sigDescription": "<string>", | |
| "isPrescribedElsewhere": "<string>", | |
| "rxUnits": "<string>", | |
| "rxComment": "<string>", | |
| "rxSpecialInstruction": "<string>", | |
| "printSpanishIndicator": "<string>", | |
| "isGenericSelected": "<string>", | |
| "diagnosisCode": "<string>", | |
| "secondaryDiagnosisCode": "<string>", | |
| "tertiaryDiagnosisCode": "<string>", | |
| "representativeNdcIndicator": "<string>", | |
| "prnReason": "<string>", | |
| "formularyId": "<string>", | |
| "formulaOverrideCode": "<string>", | |
| "formulaOverrideText": "<string>", | |
| "originalRxNdc": "<string>", | |
| "formulaStatus": "<string>", | |
| "auditMask": "<string>", | |
| "auditId": "<string>", | |
| "sendAuditId": "<string>", | |
| "lastAuditType": "<string>", | |
| "lotNumber": "<string>", | |
| "expirationDate": "<string>", | |
| "isPrn": "<string>", | |
| "renewParentId": "<string>", | |
| "rxUnitCode": "<string>", | |
| "oldId": "<string>", | |
| "rxRenewNote": "<string>", | |
| "FdbDosageId": "<string>", | |
| "refillLimit": "<string>", | |
| "refillLimitDate": "<string>", | |
| "prescribedElsewhereLocation": "<string>", | |
| "priorAuthorizationIndicator": "<string>", | |
| "priorAuthorizationId": "<string>", | |
| "priorAuthorizationDate": "<string>", | |
| "privacyIndicator": "<string>", | |
| "refillsRemaining": "<string>", | |
| "customDosageId": "<string>", | |
| "isAutoCalculated": "<string>", | |
| "pbmId": "<string>", | |
| "formularyDetailData": "<string>", | |
| "formularySummaryData": "<string>", | |
| "sourceProductId": "<string>", | |
| "supervisingProviderId": "<string>", | |
| "ineffectiveMedicationIndicator": "<string>", | |
| "pedOrderId": "<string>", | |
| "eCouponNote": "<string>", | |
| "eCouponUrl": "<string>", | |
| "auditTimestamp": "<string>", | |
| "isErxDisabledByState": "<string>", | |
| "isFaxDisabledByState": "<string>", | |
| "isHidden": "<string>", | |
| "isSupply": "<string>", | |
| "rxNormCode": "<string>", | |
| "status": "<string>", | |
| "rxFillIndicator": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/medications/{medicationId}/cancel": { | |
| "post": { | |
| "description": "Cancels a medication for the given person id and medication id", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/medications/:medicationId/cancel", | |
| "tags": [ | |
| "Medications" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/medications/:medicationId/cancel", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person for which the medication is being cancelled" | |
| }, | |
| { | |
| "name": "medicationId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient medication that is being cancelled" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/medications/{medicationId}/notes": { | |
| "get": { | |
| "description": "Returns a list of prescription notes for the specified person id and medication id after applying additional OData query operations.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/medications/:medicationId/notes", | |
| "tags": [ | |
| "Medications" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/medications/:medicationId/notes", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "$top", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$filter", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$orderby", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$skip", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$inlinecount", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$count", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose prescription notes is being retrieved." | |
| }, | |
| { | |
| "name": "medicationId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient medication whose prescription notes is being retrieved." | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK73" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "Items": [ | |
| { | |
| "id": "<string>", | |
| "noteType": "<string>", | |
| "note": "<string>", | |
| "personId": "<string>", | |
| "medicationId": "<string>", | |
| "createdBy": "<string>", | |
| "modifiedBy": "<string>", | |
| "createTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "modifyTimestampTimezone": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "id": "<string>", | |
| "noteType": "<string>", | |
| "note": "<string>", | |
| "personId": "<string>", | |
| "medicationId": "<string>", | |
| "createdBy": "<string>", | |
| "modifiedBy": "<string>", | |
| "createTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "modifyTimestampTimezone": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ], | |
| "NextPageLink": "<string>", | |
| "Count": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "post": { | |
| "description": "Adds a prescription note for the given person id and medication id.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/medications/:medicationId/notes", | |
| "tags": [ | |
| "Medications" | |
| ], | |
| "operationId": "Post{{baseUrl}}/persons/:personId/chart/medications/:medicationId/notes", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person for which a prescription note is being added." | |
| }, | |
| { | |
| "name": "medicationId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient medication for which a prescription note is being added." | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1medications~1%3AmedicationId~1notesRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/medications/{medicationId}/notes/{noteId}": { | |
| "delete": { | |
| "description": "Delete the specified prescription note for the person id and medication id.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/medications/:medicationId/notes/:noteId", | |
| "tags": [ | |
| "Medications" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/medications/:medicationId/notes/:noteId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose prescription note is to be deleted." | |
| }, | |
| { | |
| "name": "medicationId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the medication whose prescription note is to be deleted." | |
| }, | |
| { | |
| "name": "noteId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the prescription note to be deleted." | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "get": { | |
| "description": "Gets the prescription note for the given person id, patient medication id and note id.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/medications/:medicationId/notes/:noteId1", | |
| "tags": [ | |
| "Medications" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/medications/:medicationId/notes/:noteId1", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose prescription note is being retrieved" | |
| }, | |
| { | |
| "name": "medicationId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient medication whose prescription note is being retrieved" | |
| }, | |
| { | |
| "name": "noteId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the prescription note being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK74" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "id": "<string>", | |
| "noteType": "<string>", | |
| "note": "<string>", | |
| "personId": "<string>", | |
| "medicationId": "<string>", | |
| "createdBy": "<string>", | |
| "modifiedBy": "<string>", | |
| "createTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "modifyTimestampTimezone": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "put": { | |
| "description": "Update the specified prescription note for the person id and medication id.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/medications/:medicationId/notes/:noteId", | |
| "tags": [ | |
| "Medications" | |
| ], | |
| "operationId": "Put{{baseUrl}}/persons/:personId/chart/medications/:medicationId/notes/:noteId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose prescription note is to be updated." | |
| }, | |
| { | |
| "name": "medicationId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the medication whose prescription note is to be updated." | |
| }, | |
| { | |
| "name": "noteId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the prescription note to be updated." | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1medications~1%3AmedicationId~1notes~1%3AnoteIdRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/medications/{medicationId}/send-erx": { | |
| "post": { | |
| "description": "Submits an electronic prescription for the given person id, medication id, and additional details", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/medications/:medicationId/send-erx", | |
| "tags": [ | |
| "Medications" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/medications/:medicationId/send-erx", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient for which the medication is being electronically prescribed" | |
| }, | |
| { | |
| "name": "medicationId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient medication that is being electronically prescribed" | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1medications~1%3AmedicationId~1send-erx-Request" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/medications/{medicationId}/stop": { | |
| "post": { | |
| "description": "Stops a medication for the given person id and medication id", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/medications/:medicationId/stop", | |
| "tags": [ | |
| "Medications" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/medications/:medicationId/stop", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person for which the medication is being stopped" | |
| }, | |
| { | |
| "name": "medicationId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient medication that is being stopped" | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1medications~1%3AmedicationId~1stopRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/medications/{medid}/dur-check": { | |
| "get": { | |
| "description": "Performs a drug utilization review and returns any problems for the given person id and medication id.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/medications/:medid/dur-check", | |
| "tags": [ | |
| "Medications" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/medications/:medid/dur-check", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "isRepresentativeNdc", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "A true or false value that represents whether the medication was prescribed elsewhere and the strength, route, and form were unknown at the time the medication was added" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person for which a drug utilization review is being performed" | |
| }, | |
| { | |
| "name": "medid", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the medication for which a drug utilization review is being performed" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/medications/{medid}/monograph-data": { | |
| "get": { | |
| "description": "Get the monograph data for a medication.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/medications/:medid/monograph-data", | |
| "tags": [ | |
| "Medications" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/medications/:medid/monograph-data", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person for monograph data" | |
| }, | |
| { | |
| "name": "medid", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the medication for monograph data." | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK75" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "drugName": "<string>", | |
| "medicationName": "<string>", | |
| "gcnSequenceNumber": "<string>", | |
| "monographCode": "<string>", | |
| "monograph": [ | |
| "<string>", | |
| "<string>" | |
| ], | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/medications/{medid}/patient-education": { | |
| "get": { | |
| "description": "Get the external resources URL and type for patient education.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/medications/:medid/patient-education", | |
| "tags": [ | |
| "Medications" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/medications/:medid/patient-education", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "resourceType", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) Patient education Resource Type - resourceType - 1 (ExternalPatientEducation) or 2 - (ClinicalDecisionSupport) or 3 - (ExternalProviderReferences)" | |
| }, | |
| { | |
| "name": "encounterDate", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "Encounter Date on which patient education data is being retreived" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person for whom patient education url is being retreived" | |
| }, | |
| { | |
| "name": "medid", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the medication for patient education" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK76" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "resourceType": "<string>", | |
| "baseUrl": "<string>", | |
| "resourceUrl": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/medications/pdmp-report": { | |
| "get": { | |
| "description": "Get PDMP report for a person.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/medications/pdmp-report", | |
| "tags": [ | |
| "Medications" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/medications/pdmp-report", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose medications are being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK67" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "Items": [ | |
| { | |
| "id": "<string>", | |
| "personId": "<string>", | |
| "providerId": "<string>", | |
| "fdbName": "<string>", | |
| "medicationName": "<string>", | |
| "genericName": "<string>", | |
| "brandName": "<string>", | |
| "isGenericSelected": "<string>", | |
| "dose": "<string>", | |
| "route": "<string>", | |
| "doseForm": "<string>", | |
| "originalStartDate": "<string>", | |
| "startDate": "<string>", | |
| "stopDate": "<string>", | |
| "sigDescription": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "encounterId": "<string>", | |
| "sourceProductId": "<string>", | |
| "lastAuditType": "<string>", | |
| "representativeNdcIndicator": "<string>", | |
| "privacyIndicator": "<string>", | |
| "isHidden": "<string>", | |
| "deaClassCode": "<string>", | |
| "medicationId": "<string>", | |
| "ndcId": "<string>", | |
| "createTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "rxNormCode": "<string>", | |
| "status": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "id": "<string>", | |
| "personId": "<string>", | |
| "providerId": "<string>", | |
| "fdbName": "<string>", | |
| "medicationName": "<string>", | |
| "genericName": "<string>", | |
| "brandName": "<string>", | |
| "isGenericSelected": "<string>", | |
| "dose": "<string>", | |
| "route": "<string>", | |
| "doseForm": "<string>", | |
| "originalStartDate": "<string>", | |
| "startDate": "<string>", | |
| "stopDate": "<string>", | |
| "sigDescription": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "encounterId": "<string>", | |
| "sourceProductId": "<string>", | |
| "lastAuditType": "<string>", | |
| "representativeNdcIndicator": "<string>", | |
| "privacyIndicator": "<string>", | |
| "isHidden": "<string>", | |
| "deaClassCode": "<string>", | |
| "medicationId": "<string>", | |
| "ndcId": "<string>", | |
| "createTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "rxNormCode": "<string>", | |
| "status": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ], | |
| "NextPageLink": "<string>", | |
| "Count": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons": { | |
| "get": { | |
| "description": "Gets a list of persons/patients. If OData $filter criteria for createTimestamp and/or /modifyTimestamp are not specified, the default behavior of this route is to return results for persons/patients that have been created or modified in the last 7 days.", | |
| "summary": "{{baseUrl}}/persons", | |
| "tags": [ | |
| "Patient Demographics" | |
| ], | |
| "operationId": "{{baseUrl}}/persons", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "patientsOnly", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$top", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$filter", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$orderby", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$skip", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$inlinecount", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$count", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK78" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "Count": "<string>", | |
| "Items": [ | |
| { | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ], | |
| "checkInDateTime": "<string>", | |
| "checkInTimezone": "<string>", | |
| "checkOutDateTime": "<string>", | |
| "checkOutTimezone": "<string>", | |
| "encounterNumber": "<string>", | |
| "enterpriseId": "<string>", | |
| "id": "<string>", | |
| "isLocked": "<string>", | |
| "isSensitive": "<string>", | |
| "locationId": "<string>", | |
| "locationName": "<string>", | |
| "personId": "<string>", | |
| "practiceId": "<string>", | |
| "printOnStatements": "<string>", | |
| "referringProviderId": "<string>", | |
| "referringProviderName": "<string>", | |
| "renderingProviderId": "<string>", | |
| "renderingProviderName": "<string>", | |
| "status": "<string>", | |
| "suppressOutreach": "<string>", | |
| "suppressPortal": "<string>", | |
| "timestamp": "<string>", | |
| "timestampTimezone": "<string>" | |
| }, | |
| { | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ], | |
| "checkInDateTime": "<string>", | |
| "checkInTimezone": "<string>", | |
| "checkOutDateTime": "<string>", | |
| "checkOutTimezone": "<string>", | |
| "encounterNumber": "<string>", | |
| "enterpriseId": "<string>", | |
| "id": "<string>", | |
| "isLocked": "<string>", | |
| "isSensitive": "<string>", | |
| "locationId": "<string>", | |
| "locationName": "<string>", | |
| "personId": "<string>", | |
| "practiceId": "<string>", | |
| "printOnStatements": "<string>", | |
| "referringProviderId": "<string>", | |
| "referringProviderName": "<string>", | |
| "renderingProviderId": "<string>", | |
| "renderingProviderName": "<string>", | |
| "status": "<string>", | |
| "suppressOutreach": "<string>", | |
| "suppressPortal": "<string>", | |
| "timestamp": "<string>", | |
| "timestampTimezone": "<string>" | |
| } | |
| ], | |
| "NextPageLink": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "post": { | |
| "description": "Adds a new person", | |
| "summary": "{{baseUrl}}/persons", | |
| "tags": [ | |
| "Patient Demographics" | |
| ], | |
| "operationId": "Post{{baseUrl}}/persons", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1personsRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| }, | |
| "409": { | |
| "description": "Conflict", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}": { | |
| "get": { | |
| "description": "Gets the demographics for the specified person id.", | |
| "summary": "{{baseUrl}}/persons/:personId", | |
| "tags": [ | |
| "Patient Demographics" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose demographics are being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK79" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "id": "<string>", | |
| "firstName": "<string>", | |
| "lastName": "<string>", | |
| "middleName": "<string>", | |
| "prefix": "<string>", | |
| "prefixId": "<string>", | |
| "suffix": "<string>", | |
| "suffixId": "<string>", | |
| "addressLine1": "<string>", | |
| "addressLine2": "<string>", | |
| "city": "<string>", | |
| "state": "<string>", | |
| "zip": "<string>", | |
| "countryId": "<string>", | |
| "country": "<string>", | |
| "countyId": "<string>", | |
| "county": "<string>", | |
| "secondaryAddressLine1": "<string>", | |
| "secondaryAddressLine2": "<string>", | |
| "secondaryCity": "<string>", | |
| "secondaryState": "<string>", | |
| "secondaryZip": "<string>", | |
| "secondaryCountryId": "<string>", | |
| "secondaryCountry": "<string>", | |
| "secondaryCountyId": "<string>", | |
| "secondaryCounty": "<string>", | |
| "homePhone": "<string>", | |
| "homePhoneComment": "<string>", | |
| "secondaryHomePhone": "<string>", | |
| "secondaryHomePhoneComment": "<string>", | |
| "dayPhone": "<string>", | |
| "dayPhoneExtension": "<string>", | |
| "dayPhoneComment": "<string>", | |
| "alternatePhone": "<string>", | |
| "alternatePhoneDescription": "<string>", | |
| "alternatePhoneExtension": "<string>", | |
| "alternatePhoneComment": "<string>", | |
| "internationalHomePhone": "<string>", | |
| "internationalWorkPhone": "<string>", | |
| "internationalZip": "<string>", | |
| "cellPhone": "<string>", | |
| "cellPhoneComment": "<string>", | |
| "email": "<string>", | |
| "emailAddressComment": "<string>", | |
| "contactSequence": "<string>", | |
| "sex": "<string>", | |
| "dateOfBirth": "<string>", | |
| "age": "<string>", | |
| "socialSecurityNumber": "<string>", | |
| "contactPreferenceId": "<string>", | |
| "contactPreferenceDescription": "<string>", | |
| "primaryCareProviderId": "<string>", | |
| "primaryCareProviderFullName": "<string>", | |
| "primaryCareProviderFirstName": "<string>", | |
| "primaryCareProviderLastName": "<string>", | |
| "primaryCareProviderMiddleInitial": "<string>", | |
| "maritalStatus": "<string>", | |
| "studentStatus": "<string>", | |
| "isExpired": "<string>", | |
| "isSmoker": "<string>", | |
| "isVeteran": "<string>", | |
| "notificationPreferenceSelected": "<string>", | |
| "preferredLanguageId": "<string>", | |
| "preferredLanguage": "<string>", | |
| "religionId": "<string>", | |
| "churchId": "<string>", | |
| "udsHomelessStatusId": "<string>", | |
| "udsMigrantWorkerStatusId": "<string>", | |
| "udsLanguageBarrierId": "<string>", | |
| "udsPrimaryMedicalCoverageId": "<string>", | |
| "udsPublicHousingPrimaryCareId": "<string>", | |
| "udsSchoolBasedHealthCenterId": "<string>", | |
| "udsTribalAffiliationId": "<string>", | |
| "udsBloodQuantumId": "<string>", | |
| "udsVeteranStatus": "<string>", | |
| "isSelfPayer": "<string>", | |
| "udsHasConsentToTreat": "<string>", | |
| "udsConsentToTreatDate": "<string>", | |
| "udsIhsEligibilityStatusId": "<string>", | |
| "udsTribalClassId": "<string>", | |
| "udsDecendancyId": "<string>", | |
| "communityCodeId": "<string>", | |
| "currentGender": "<string>", | |
| "previousFirstName": "<string>", | |
| "sexualOrientation": "<string>", | |
| "preferredPronoun": "<string>", | |
| "patientStatusId": "<string>", | |
| "patientStatusChangeReasonId": "<string>", | |
| "userDefinedDemographic1Id": "<string>", | |
| "userDefinedDemographic2Id": "<string>", | |
| "userDefinedDemographic3Id": "<string>", | |
| "userDefinedDemographic4Id": "<string>", | |
| "userDefinedDemographic5Id": "<string>", | |
| "userDefinedDemographic6Id": "<string>", | |
| "userDefinedDemographic7Id": "<string>", | |
| "userDefinedDemographic8Id": "<string>", | |
| "userDefinedDemographic9Id": "<string>", | |
| "userDefinedDemographic10Id": "<string>", | |
| "userDefinedDemographic11Id": "<string>", | |
| "userDefinedDemographic12Id": "<string>", | |
| "userDefinedDemographic13Id": "<string>", | |
| "userDefinedDemographic14Id": "<string>", | |
| "isCurrentGenderProtected": "<string>", | |
| "isGenderIdentityProtected": "<string>", | |
| "isPreferredPronounProtected": "<string>", | |
| "isSexualOrientationProtected": "<string>", | |
| "otherIdNumber": "<string>", | |
| "priorLastName": "<string>", | |
| "externalId": "<string>", | |
| "primaryDentalProviderId": "<string>", | |
| "primaryDentalProviderName": "<string>", | |
| "nickname": "<string>", | |
| "showContactInfoOnAlert": "<string>", | |
| "mothersMaidenName": "<string>", | |
| "hasEmail": "<string>", | |
| "hasPhoneNumber": "<string>", | |
| "usesPortal": "<string>", | |
| "usesSms": "<string>", | |
| "hasVoice": "<string>", | |
| "isOptOut": "<string>", | |
| "isHomePhoneNotApplicable": "<string>", | |
| "isCellPhoneNotApplicable": "<string>", | |
| "isAlternatePhoneNotApplicable": "<string>", | |
| "isDayPhoneNotApplicable": "<string>", | |
| "isSecondaryHomePhoneNotApplicable": "<string>", | |
| "isInternationalPhoneNotApplicable": "<string>", | |
| "isEmailNotApplicable": "<string>", | |
| "expiredDate": "<string>", | |
| "expiredTime": "<string>", | |
| "expiredTimeTz": "<string>", | |
| "birthMothersLastName": "<string>", | |
| "birthMothersFirstName": "<string>", | |
| "birthMothersMiddleName": "<string>", | |
| "exemptFromPersonMerge": "<string>", | |
| "addressTypeId": "<string>", | |
| "secondaryAddressTypeId": "<string>", | |
| "isEnterpriseChart": "<string>", | |
| "otherReasonSexualOrientation": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "description": "Updates properties on existing person demographics given in the request.", | |
| "summary": "{{baseUrl}}/persons/:personId", | |
| "tags": [ | |
| "Patient Demographics" | |
| ], | |
| "operationId": "Patch{{baseUrl}}/persons/:personId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose demographics are being updated." | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonIdRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| }, | |
| "409": { | |
| "description": "Conflict", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "put": { | |
| "description": "Updates a person's demographic information", | |
| "summary": "{{baseUrl}}/persons/:personId1", | |
| "tags": [ | |
| "Patient Demographics" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId1", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id for the person being updated" | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonIdRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/address-histories": { | |
| "get": { | |
| "description": "Gets the address histories for the specified personId.", | |
| "summary": "{{baseUrl}}/persons/:personId/address-histories", | |
| "tags": [ | |
| "Patient Demographics" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/address-histories", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose demographics are being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK79" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "id": "<string>", | |
| "firstName": "<string>", | |
| "lastName": "<string>", | |
| "middleName": "<string>", | |
| "prefix": "<string>", | |
| "prefixId": "<string>", | |
| "suffix": "<string>", | |
| "suffixId": "<string>", | |
| "addressLine1": "<string>", | |
| "addressLine2": "<string>", | |
| "city": "<string>", | |
| "state": "<string>", | |
| "zip": "<string>", | |
| "countryId": "<string>", | |
| "country": "<string>", | |
| "countyId": "<string>", | |
| "county": "<string>", | |
| "secondaryAddressLine1": "<string>", | |
| "secondaryAddressLine2": "<string>", | |
| "secondaryCity": "<string>", | |
| "secondaryState": "<string>", | |
| "secondaryZip": "<string>", | |
| "secondaryCountryId": "<string>", | |
| "secondaryCountry": "<string>", | |
| "secondaryCountyId": "<string>", | |
| "secondaryCounty": "<string>", | |
| "homePhone": "<string>", | |
| "homePhoneComment": "<string>", | |
| "secondaryHomePhone": "<string>", | |
| "secondaryHomePhoneComment": "<string>", | |
| "dayPhone": "<string>", | |
| "dayPhoneExtension": "<string>", | |
| "dayPhoneComment": "<string>", | |
| "alternatePhone": "<string>", | |
| "alternatePhoneDescription": "<string>", | |
| "alternatePhoneExtension": "<string>", | |
| "alternatePhoneComment": "<string>", | |
| "internationalHomePhone": "<string>", | |
| "internationalWorkPhone": "<string>", | |
| "internationalZip": "<string>", | |
| "cellPhone": "<string>", | |
| "cellPhoneComment": "<string>", | |
| "email": "<string>", | |
| "emailAddressComment": "<string>", | |
| "contactSequence": "<string>", | |
| "sex": "<string>", | |
| "dateOfBirth": "<string>", | |
| "age": "<string>", | |
| "socialSecurityNumber": "<string>", | |
| "contactPreferenceId": "<string>", | |
| "contactPreferenceDescription": "<string>", | |
| "primaryCareProviderId": "<string>", | |
| "primaryCareProviderFullName": "<string>", | |
| "primaryCareProviderFirstName": "<string>", | |
| "primaryCareProviderLastName": "<string>", | |
| "primaryCareProviderMiddleInitial": "<string>", | |
| "maritalStatus": "<string>", | |
| "studentStatus": "<string>", | |
| "isExpired": "<string>", | |
| "isSmoker": "<string>", | |
| "isVeteran": "<string>", | |
| "notificationPreferenceSelected": "<string>", | |
| "preferredLanguageId": "<string>", | |
| "preferredLanguage": "<string>", | |
| "religionId": "<string>", | |
| "churchId": "<string>", | |
| "udsHomelessStatusId": "<string>", | |
| "udsMigrantWorkerStatusId": "<string>", | |
| "udsLanguageBarrierId": "<string>", | |
| "udsPrimaryMedicalCoverageId": "<string>", | |
| "udsPublicHousingPrimaryCareId": "<string>", | |
| "udsSchoolBasedHealthCenterId": "<string>", | |
| "udsTribalAffiliationId": "<string>", | |
| "udsBloodQuantumId": "<string>", | |
| "udsVeteranStatus": "<string>", | |
| "isSelfPayer": "<string>", | |
| "udsHasConsentToTreat": "<string>", | |
| "udsConsentToTreatDate": "<string>", | |
| "udsIhsEligibilityStatusId": "<string>", | |
| "udsTribalClassId": "<string>", | |
| "udsDecendancyId": "<string>", | |
| "communityCodeId": "<string>", | |
| "currentGender": "<string>", | |
| "previousFirstName": "<string>", | |
| "sexualOrientation": "<string>", | |
| "preferredPronoun": "<string>", | |
| "patientStatusId": "<string>", | |
| "patientStatusChangeReasonId": "<string>", | |
| "userDefinedDemographic1Id": "<string>", | |
| "userDefinedDemographic2Id": "<string>", | |
| "userDefinedDemographic3Id": "<string>", | |
| "userDefinedDemographic4Id": "<string>", | |
| "userDefinedDemographic5Id": "<string>", | |
| "userDefinedDemographic6Id": "<string>", | |
| "userDefinedDemographic7Id": "<string>", | |
| "userDefinedDemographic8Id": "<string>", | |
| "userDefinedDemographic9Id": "<string>", | |
| "userDefinedDemographic10Id": "<string>", | |
| "userDefinedDemographic11Id": "<string>", | |
| "userDefinedDemographic12Id": "<string>", | |
| "userDefinedDemographic13Id": "<string>", | |
| "userDefinedDemographic14Id": "<string>", | |
| "isCurrentGenderProtected": "<string>", | |
| "isGenderIdentityProtected": "<string>", | |
| "isPreferredPronounProtected": "<string>", | |
| "isSexualOrientationProtected": "<string>", | |
| "otherIdNumber": "<string>", | |
| "priorLastName": "<string>", | |
| "externalId": "<string>", | |
| "primaryDentalProviderId": "<string>", | |
| "primaryDentalProviderName": "<string>", | |
| "nickname": "<string>", | |
| "showContactInfoOnAlert": "<string>", | |
| "mothersMaidenName": "<string>", | |
| "hasEmail": "<string>", | |
| "hasPhoneNumber": "<string>", | |
| "usesPortal": "<string>", | |
| "usesSms": "<string>", | |
| "hasVoice": "<string>", | |
| "isOptOut": "<string>", | |
| "isHomePhoneNotApplicable": "<string>", | |
| "isCellPhoneNotApplicable": "<string>", | |
| "isAlternatePhoneNotApplicable": "<string>", | |
| "isDayPhoneNotApplicable": "<string>", | |
| "isSecondaryHomePhoneNotApplicable": "<string>", | |
| "isInternationalPhoneNotApplicable": "<string>", | |
| "isEmailNotApplicable": "<string>", | |
| "expiredDate": "<string>", | |
| "expiredTime": "<string>", | |
| "expiredTimeTz": "<string>", | |
| "birthMothersLastName": "<string>", | |
| "birthMothersFirstName": "<string>", | |
| "birthMothersMiddleName": "<string>", | |
| "exemptFromPersonMerge": "<string>", | |
| "addressTypeId": "<string>", | |
| "secondaryAddressTypeId": "<string>", | |
| "isEnterpriseChart": "<string>", | |
| "otherReasonSexualOrientation": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/ethnicities": { | |
| "get": { | |
| "description": "Gets the ethnicities for the specified person id.", | |
| "summary": "{{baseUrl}}/persons/:personId/ethnicities", | |
| "tags": [ | |
| "Patient Demographics" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/ethnicities", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose ethnicities are being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK81" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "personId": "<string>", | |
| "id": "<string>", | |
| "description": "<string>", | |
| "order": "<string>", | |
| "categoryId": "<string>", | |
| "categoryName": "<string>", | |
| "cdcEthnicityCode": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/gender-identities": { | |
| "get": { | |
| "description": "Gets the gender identities for the specified person id.", | |
| "summary": "{{baseUrl}}/persons/:personId/gender-identities", | |
| "tags": [ | |
| "Patient Demographics" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/gender-identities", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose ethnicities are being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK81" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "personId": "<string>", | |
| "id": "<string>", | |
| "description": "<string>", | |
| "order": "<string>", | |
| "categoryId": "<string>", | |
| "categoryName": "<string>", | |
| "cdcEthnicityCode": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/races": { | |
| "get": { | |
| "description": "Gets the races for the specified person id.", | |
| "summary": "{{baseUrl}}/persons/:personId/races", | |
| "tags": [ | |
| "Patient Demographics" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/races", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose races are being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK83" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "personId": "<string>", | |
| "id": "<string>", | |
| "description": "<string>", | |
| "order": "<string>", | |
| "categoryId": "<string>", | |
| "categoryName": "<string>", | |
| "cdcRaceCode": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/lookup": { | |
| "get": { | |
| "description": "Gets a list of persons/patients based on various search criteria. Since these results are returned from a /persons/ endpoint, the \"id\" of each result (whose value is a guid) is a personId and can be used as the value of personId in all other routes that require a personId.\r\n\r\nUsing the /persons/lookup route:\r\n\r\n-At least one query parameter must be provided as lookup criteria.\r\n-Use of multiple criteria is allowed, and will results will include person records matching all criteria.\r\n-The two \"quickSearch\" parameters are exceptions to the above; see the quickSearchId & quickSearchInput parameter descriptions for details.", | |
| "summary": "{{baseUrl}}/persons/lookup", | |
| "tags": [ | |
| "Patient Demographics" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/lookup", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "firstName", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "lastName", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "middleName", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "priorLastName", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "addressLine1", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "city", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "zip", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "sex", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "currentGender", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "dateOfBirth", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "externalId", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "externalSystemId", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "excludeExpired", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "isNextMdEnabled", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "searchPatientsOnly", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "quickSearchId", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "quickSearchInput", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$expand", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK84" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "id": "<string>", | |
| "firstName": "<string>", | |
| "lastName": "<string>", | |
| "middleName": "<string>", | |
| "nickname": "<string>", | |
| "addressLine1": "<string>", | |
| "addressLine2": "<string>", | |
| "city": "<string>", | |
| "state": "<string>", | |
| "zip": "<string>", | |
| "country": "<string>", | |
| "homePhone": "<string>", | |
| "dateOfBirth": "<string>", | |
| "sex": "<string>", | |
| "currentGender": "<string>", | |
| "socialSecurityNumber": "<string>", | |
| "personNumber": "<string>", | |
| "medicalRecordNumber": "<string>", | |
| "otherIdNumber": "<string>", | |
| "isEnterpriseChart": "<string>", | |
| "isPatient": "<string>", | |
| "canAddToInclusionList": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/encounters": { | |
| "get": { | |
| "description": "While this route does not directly return USCDI data, knowledge of an encounterId is sometimes necessary to utilize other routes to obtain USCDI data.\r\n\r\nThis route returns a list of encounters (each identified by \"id\", which in all other routes will be an {encounterId} whose value is a guid) for the specified person id after applying additional OData query operations.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters", | |
| "tags": [ | |
| "Patient Demographics" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/encounters", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "$top", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$filter", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$orderby", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$skip", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$inlinecount", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$count", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose encounters are being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK78" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "Count": "<string>", | |
| "Items": [ | |
| { | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ], | |
| "checkInDateTime": "<string>", | |
| "checkInTimezone": "<string>", | |
| "checkOutDateTime": "<string>", | |
| "checkOutTimezone": "<string>", | |
| "encounterNumber": "<string>", | |
| "enterpriseId": "<string>", | |
| "id": "<string>", | |
| "isLocked": "<string>", | |
| "isSensitive": "<string>", | |
| "locationId": "<string>", | |
| "locationName": "<string>", | |
| "personId": "<string>", | |
| "practiceId": "<string>", | |
| "printOnStatements": "<string>", | |
| "referringProviderId": "<string>", | |
| "referringProviderName": "<string>", | |
| "renderingProviderId": "<string>", | |
| "renderingProviderName": "<string>", | |
| "status": "<string>", | |
| "suppressOutreach": "<string>", | |
| "suppressPortal": "<string>", | |
| "timestamp": "<string>", | |
| "timestampTimezone": "<string>" | |
| }, | |
| { | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ], | |
| "checkInDateTime": "<string>", | |
| "checkInTimezone": "<string>", | |
| "checkOutDateTime": "<string>", | |
| "checkOutTimezone": "<string>", | |
| "encounterNumber": "<string>", | |
| "enterpriseId": "<string>", | |
| "id": "<string>", | |
| "isLocked": "<string>", | |
| "isSensitive": "<string>", | |
| "locationId": "<string>", | |
| "locationName": "<string>", | |
| "personId": "<string>", | |
| "practiceId": "<string>", | |
| "printOnStatements": "<string>", | |
| "referringProviderId": "<string>", | |
| "referringProviderName": "<string>", | |
| "renderingProviderId": "<string>", | |
| "renderingProviderName": "<string>", | |
| "status": "<string>", | |
| "suppressOutreach": "<string>", | |
| "suppressPortal": "<string>", | |
| "timestamp": "<string>", | |
| "timestampTimezone": "<string>" | |
| } | |
| ], | |
| "NextPageLink": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/problems": { | |
| "get": { | |
| "description": "Gets a list of patient problems after performing additional OData query operations.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/problems", | |
| "tags": [ | |
| "Problems" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/problems", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "$top", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$filter", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$orderby", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$skip", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$inlinecount", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$count", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person for which the problems are being displayed" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK86" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "id": "<string>", | |
| "personId": "<string>", | |
| "description": "<string>", | |
| "fullySpecifiedName": "<string>", | |
| "isChronic": "<string>", | |
| "hasSecondaryCondition": "<string>", | |
| "problemStatusId": "<string>", | |
| "problemStatus": "<string>", | |
| "recentNoteId": "<string>", | |
| "lastAddressedDate": "<string>", | |
| "onsetDate": "<string>", | |
| "resolvedDate": "<string>", | |
| "resolvedReason": "<string>", | |
| "conceptId": "<string>", | |
| "isComorbid": "<string>", | |
| "isDeleted": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "post": { | |
| "description": "Adds a new problem for the given person id", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/problems", | |
| "tags": [ | |
| "Problems" | |
| ], | |
| "operationId": "Post{{baseUrl}}/persons/:personId/chart/problems", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person for which the problem is being added" | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1problemsRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/problems/{problemId}": { | |
| "delete": { | |
| "description": "Deletes a patient problem", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/problems/:problemId", | |
| "tags": [ | |
| "Problems" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/problems/:problemId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person for which the problem is being removed" | |
| }, | |
| { | |
| "name": "problemId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the problem being removed" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "get": { | |
| "description": "Gets the details of a patient problem.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/problems/:problemId1", | |
| "tags": [ | |
| "Problems" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/problems/:problemId1", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose problem is being retrieved" | |
| }, | |
| { | |
| "name": "problemId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the problem" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK87" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "id": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "personId": "<string>", | |
| "description": "<string>", | |
| "fullySpecifiedName": "<string>", | |
| "conceptId": "<string>", | |
| "sideId": "<string>", | |
| "site": "<string>", | |
| "onsetDate": "<string>", | |
| "lastAddressedDate": "<string>", | |
| "resolvedDate": "<string>", | |
| "resolvedReason": "<string>", | |
| "resolvedBy": "<string>", | |
| "problemStatusId": "<string>", | |
| "problemStatus": "<string>", | |
| "recentNoteId": "<string>", | |
| "clinicalStatusId": "<string>", | |
| "isChronic": "<string>", | |
| "hasSecondaryCondition": "<string>", | |
| "isDeleted": "<string>", | |
| "locationId": "<string>", | |
| "providerId": "<string>", | |
| "isRecordedElsewhere": "<string>", | |
| "recordedElsewhereSource": "<string>", | |
| "responsibleProviderId": "<string>", | |
| "isComorbid": "<string>", | |
| "createdBy": "<string>", | |
| "createTimestamp": "<string>", | |
| "modifiedBy": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "modifyTimestampTimezone": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "put": { | |
| "description": "Updates a patient problem", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/problems/:problemId", | |
| "tags": [ | |
| "Problems" | |
| ], | |
| "operationId": "Put{{baseUrl}}/persons/:personId/chart/problems/:problemId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person for which the problem is being modified" | |
| }, | |
| { | |
| "name": "problemId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the problem being modified" | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1problems~1%3AproblemIdRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/problems/{problemId}/interactions": { | |
| "get": { | |
| "description": "Gets patient interactions for an existing problems after adding the problem so that user will be aware of the contraindications while updating them.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/problems/:problemId/interactions", | |
| "tags": [ | |
| "Problems" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/problems/:problemId/interactions", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose interactions are being retrieved" | |
| }, | |
| { | |
| "name": "problemId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the problem for which interactions are being retrieved." | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "array", | |
| "default": "", | |
| "items": { | |
| "$ref": "#/definitions/OK37" | |
| } | |
| }, | |
| "examples": { | |
| "application/json": [ | |
| { | |
| "personId": "<string>", | |
| "isRequired": "<string>", | |
| "acknowledged": "<string>", | |
| "severityLevel": "<string>", | |
| "description": "<string>", | |
| "entityName": "<string>", | |
| "eventType": "<string>", | |
| "sourceId": "<string>", | |
| "cause": "<string>", | |
| "warningDetail": "<string>", | |
| "warningType": "<string>", | |
| "warning": "<string>", | |
| "causeText": "<string>", | |
| "overrideText": "<string>", | |
| "durAuditKey": "<string>", | |
| "isSuppressed": "<string>", | |
| "isRecordedElseWhere": "<string>", | |
| "practiceId": "<string>", | |
| "display": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "personId": "<string>", | |
| "isRequired": "<string>", | |
| "acknowledged": "<string>", | |
| "severityLevel": "<string>", | |
| "description": "<string>", | |
| "entityName": "<string>", | |
| "eventType": "<string>", | |
| "sourceId": "<string>", | |
| "cause": "<string>", | |
| "warningDetail": "<string>", | |
| "warningType": "<string>", | |
| "warning": "<string>", | |
| "causeText": "<string>", | |
| "overrideText": "<string>", | |
| "durAuditKey": "<string>", | |
| "isSuppressed": "<string>", | |
| "isRecordedElseWhere": "<string>", | |
| "practiceId": "<string>", | |
| "display": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/problems/{problemId}/notes": { | |
| "get": { | |
| "description": "Gets a list of notes attached to a patient problem after performing additional OData query operations.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/problems/:problemId/notes", | |
| "tags": [ | |
| "Problems" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/problems/:problemId/notes", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "$top", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$filter", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$orderby", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$skip", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$inlinecount", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$count", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person for which the problem notes are being retrieved" | |
| }, | |
| { | |
| "name": "problemId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the problem for which the notes are being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK89" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "Items": [ | |
| { | |
| "id": "<string>", | |
| "problemId": "<string>", | |
| "personId": "<string>", | |
| "note": "<string>", | |
| "createdBy": "<string>", | |
| "createTimestamp": "<string>", | |
| "modifiedBy": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "isDeleted": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "modifyTimestampTimezone": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "id": "<string>", | |
| "problemId": "<string>", | |
| "personId": "<string>", | |
| "note": "<string>", | |
| "createdBy": "<string>", | |
| "createTimestamp": "<string>", | |
| "modifiedBy": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "isDeleted": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "modifyTimestampTimezone": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ], | |
| "NextPageLink": "<string>", | |
| "Count": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "post": { | |
| "description": "Adds a note to a patient problem", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/problems/:problemId/notes", | |
| "tags": [ | |
| "Problems" | |
| ], | |
| "operationId": "Post{{baseUrl}}/persons/:personId/chart/problems/:problemId/notes", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person for which we are adding the problem note" | |
| }, | |
| { | |
| "name": "problemId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the problem that the note is being added to" | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1problems~1%3AproblemId~1notesRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/problems/{problemId}/notes/{noteId}": { | |
| "delete": { | |
| "description": "Deletes a problem note", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/problems/:problemId/notes/:noteId", | |
| "tags": [ | |
| "Problems" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/problems/:problemId/notes/:noteId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person for which the note is being deleted" | |
| }, | |
| { | |
| "name": "problemId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the problem that the note is associated with" | |
| }, | |
| { | |
| "name": "noteId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the note" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "get": { | |
| "description": "Gets a problem note.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/problems/:problemId/notes/:noteId1", | |
| "tags": [ | |
| "Problems" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/problems/:problemId/notes/:noteId1", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person for which the note is being retrieved" | |
| }, | |
| { | |
| "name": "problemId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the problem that the note is associated with" | |
| }, | |
| { | |
| "name": "noteId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the note" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK90" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "id": "<string>", | |
| "problemId": "<string>", | |
| "personId": "<string>", | |
| "note": "<string>", | |
| "createdBy": "<string>", | |
| "createTimestamp": "<string>", | |
| "modifiedBy": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "isDeleted": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "modifyTimestampTimezone": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "put": { | |
| "description": "Updates a problem note", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/problems/:problemId/notes/:noteId", | |
| "tags": [ | |
| "Problems" | |
| ], | |
| "operationId": "Put{{baseUrl}}/persons/:personId/chart/problems/:problemId/notes/:noteId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person for which the note is being updated" | |
| }, | |
| { | |
| "name": "problemId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the problem that the note is associated with" | |
| }, | |
| { | |
| "name": "noteId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the note" | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1problems~1%3AproblemId~1notes~1%3AnoteIdRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/problems/interactions": { | |
| "get": { | |
| "description": "This route is meant to be used in conjunction with the POST for Patient Problem. The results of this route will be required by the POST for verification that interactions were viewed.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/problems/interactions", | |
| "tags": [ | |
| "Problems" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/problems/interactions", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "$top", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$filter", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$orderby", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$skip", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$inlinecount", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$count", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the person whose interactions are being retrieved." | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "array", | |
| "default": "", | |
| "items": { | |
| "$ref": "#/definitions/OK37" | |
| } | |
| }, | |
| "examples": { | |
| "application/json": [ | |
| { | |
| "personId": "<string>", | |
| "isRequired": "<string>", | |
| "acknowledged": "<string>", | |
| "severityLevel": "<string>", | |
| "description": "<string>", | |
| "entityName": "<string>", | |
| "eventType": "<string>", | |
| "sourceId": "<string>", | |
| "cause": "<string>", | |
| "warningDetail": "<string>", | |
| "warningType": "<string>", | |
| "warning": "<string>", | |
| "causeText": "<string>", | |
| "overrideText": "<string>", | |
| "durAuditKey": "<string>", | |
| "isSuppressed": "<string>", | |
| "isRecordedElseWhere": "<string>", | |
| "practiceId": "<string>", | |
| "display": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "personId": "<string>", | |
| "isRequired": "<string>", | |
| "acknowledged": "<string>", | |
| "severityLevel": "<string>", | |
| "description": "<string>", | |
| "entityName": "<string>", | |
| "eventType": "<string>", | |
| "sourceId": "<string>", | |
| "cause": "<string>", | |
| "warningDetail": "<string>", | |
| "warningType": "<string>", | |
| "warning": "<string>", | |
| "causeText": "<string>", | |
| "overrideText": "<string>", | |
| "durAuditKey": "<string>", | |
| "isSuppressed": "<string>", | |
| "isRecordedElseWhere": "<string>", | |
| "practiceId": "<string>", | |
| "display": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/procedures": { | |
| "get": { | |
| "description": "Gets a patient's procedures summary.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/procedures", | |
| "tags": [ | |
| "Procedures" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/procedures", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "$top", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$filter", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$orderby", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$skip", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$inlinecount", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$count", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose procedures summary is being fetched" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK92" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "Items": [ | |
| { | |
| "personId": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "id": "<string>", | |
| "encounterId": "<string>", | |
| "encounterTimestamp": "<string>", | |
| "serviceItemId": "<string>", | |
| "serviceItemDescription": "<string>", | |
| "cpt4Code": "<string>", | |
| "serviceDate": "<string>", | |
| "isDeleted": "<string>", | |
| "isCompleted": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "personId": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "id": "<string>", | |
| "encounterId": "<string>", | |
| "encounterTimestamp": "<string>", | |
| "serviceItemId": "<string>", | |
| "serviceItemDescription": "<string>", | |
| "cpt4Code": "<string>", | |
| "serviceDate": "<string>", | |
| "isDeleted": "<string>", | |
| "isCompleted": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ], | |
| "NextPageLink": "<string>", | |
| "Count": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/encounters/{encounterId}/procedures/{procedureId}": { | |
| "get": { | |
| "description": "Gets a specific patient procedure.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/procedures/:procedureId", | |
| "tags": [ | |
| "Procedures" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/procedures/:procedureId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient" | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of patient's encounter" | |
| }, | |
| { | |
| "name": "procedureId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of patient's procedure" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK93" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "id": "<string>", | |
| "encounterId": "<string>", | |
| "personId": "<string>", | |
| "serviceItemLibraryId": "<string>", | |
| "serviceItemGroupName": "<string>", | |
| "serviceItemGroupSequenceNumber": "<string>", | |
| "serviceItemId": "<string>", | |
| "serviceItemDescription": "<string>", | |
| "cpt4Code": "<string>", | |
| "serviceDate": "<string>", | |
| "providerId": "<string>", | |
| "referringProviderId": "<string>", | |
| "referringProviderName": "<string>", | |
| "assistingProviderId": "<string>", | |
| "dateResolved": "<string>", | |
| "modifierId1": "<string>", | |
| "modifierId2": "<string>", | |
| "modifierId3": "<string>", | |
| "modifierId4": "<string>", | |
| "diagnosisCodeId1": "<string>", | |
| "diagnosisCodeLibraryId1": "<string>", | |
| "diagnosisCodeId2": "<string>", | |
| "diagnosisCodeLibraryId2": "<string>", | |
| "diagnosisCodeId3": "<string>", | |
| "diagnosisCodeLibraryId3": "<string>", | |
| "diagnosisCodeId4": "<string>", | |
| "diagnosisCodeLibraryId4": "<string>", | |
| "placeOfService": "<string>", | |
| "hasAcceptedAssignment": "<string>", | |
| "units": "<string>", | |
| "locationId": "<string>", | |
| "payerId": "<string>", | |
| "amount": "<string>", | |
| "isBillingSuppressed": "<string>", | |
| "tooth": "<string>", | |
| "surface": "<string>", | |
| "quadrant": "<string>", | |
| "note": "<string>", | |
| "startTime": "<string>", | |
| "stopTime": "<string>", | |
| "totalTime": "<string>", | |
| "baseUnit": "<string>", | |
| "alternateCode": "<string>", | |
| "isAnesthesiaBilling": "<string>", | |
| "diagnosisCodeId5": "<string>", | |
| "diagnosisCodeLibraryId5": "<string>", | |
| "diagnosisCodeId6": "<string>", | |
| "diagnosisCodeLibraryId6": "<string>", | |
| "diagnosisCodeId7": "<string>", | |
| "diagnosisCodeLibraryId7": "<string>", | |
| "diagnosisCodeId8": "<string>", | |
| "diagnosisCodeLibraryId8": "<string>", | |
| "sourceProductId": "<string>", | |
| "isRxOnFile": "<string>", | |
| "nationalDrugCode": "<string>", | |
| "isBehavioralBilling": "<string>", | |
| "diagnosisCodeId9": "<string>", | |
| "diagnosisCodeLibraryId9": "<string>", | |
| "diagnosisCodeId10": "<string>", | |
| "diagnosisCodeLibraryId10": "<string>", | |
| "diagnosisCodeId11": "<string>", | |
| "diagnosisCodeLibraryId11": "<string>", | |
| "diagnosisCodeId12": "<string>", | |
| "diagnosisCodeLibraryId12": "<string>", | |
| "snomedConceptId": "<string>", | |
| "snomedConceptId2": "<string>", | |
| "snomedConceptId3": "<string>", | |
| "snomedConceptId4": "<string>", | |
| "isDental": "<string>", | |
| "isSupernumerary": "<string>", | |
| "surfaceDescriptor": "<string>", | |
| "isDefective": "<string>", | |
| "notApplicableDate": "<string>", | |
| "approvalDate": "<string>", | |
| "medicalDirectorId": "<string>", | |
| "asaCrosswalkLibraryId": "<string>", | |
| "surgicalProcedureCodeId": "<string>", | |
| "surgicalProcedureDescription": "<string>", | |
| "basisOfMeasure": "<string>", | |
| "nationalDrugUnits": "<string>", | |
| "teeth": "<string>", | |
| "isDeleted": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "createdBy": "<string>", | |
| "createTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "modifiedBy": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "modifyTimestampTimezone": "<string>", | |
| "isCompleted": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "put": { | |
| "description": "Updates a patient procedure", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/procedures/:procedureId", | |
| "tags": [ | |
| "Procedures" | |
| ], | |
| "operationId": "Put{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/procedures/:procedureId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient" | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of patient's encounter" | |
| }, | |
| { | |
| "name": "procedureId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of patient's procedure" | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1encounters~1%3AencounterId~1procedures~1%3AprocedureIdRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "description": "Deletes a patient procedure", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/procedures/:procedureId1", | |
| "tags": [ | |
| "Procedures" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/procedures/:procedureId1", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient" | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of patient's encounter" | |
| }, | |
| { | |
| "name": "procedureId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of patient's procedure" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/encounters/{encounterId}/procedures": { | |
| "post": { | |
| "description": "Add a procedure to patient's encounter", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/procedures", | |
| "tags": [ | |
| "Procedures" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/procedures", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient" | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient's encounter" | |
| }, | |
| { | |
| "name": "Content-Type", | |
| "in": "header", | |
| "required": false, | |
| "enum": [ | |
| "application/json" | |
| ], | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1encounters~1%3AencounterId~1proceduresRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "type": "object", | |
| "default": "" | |
| }, | |
| "examples": { | |
| "application/json": {} | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/health-concerns/tobacco-smoking-usage-status": { | |
| "get": { | |
| "description": "Gets a patient's tobacco uses status for health concern.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/health-concerns/tobacco-smoking-usage-status", | |
| "tags": [ | |
| "Smoking Status" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/health-concerns/tobacco-smoking-usage-status", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "$top", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$filter", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$orderby", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$skip", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$inlinecount", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$count", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose health concerns tobacco uses status are being retrieved." | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK94" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "Items": [ | |
| { | |
| "personId": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "encounterDate": "<string>", | |
| "tobaccoType": "<string>", | |
| "tobaccoStatus": "<string>", | |
| "smokingStatus": "<string>", | |
| "usagePerDay": "<string>", | |
| "packYears": "<string>", | |
| "dateQuit": "<string>", | |
| "tobaccoHealthConcern": "<string>", | |
| "tobaccoCategory": "<string>", | |
| "smokingHealthConcern": "<string>", | |
| "smokingCategory": "<string>", | |
| "id": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "personId": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "encounterDate": "<string>", | |
| "tobaccoType": "<string>", | |
| "tobaccoStatus": "<string>", | |
| "smokingStatus": "<string>", | |
| "usagePerDay": "<string>", | |
| "packYears": "<string>", | |
| "dateQuit": "<string>", | |
| "tobaccoHealthConcern": "<string>", | |
| "tobaccoCategory": "<string>", | |
| "smokingHealthConcern": "<string>", | |
| "smokingCategory": "<string>", | |
| "id": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ], | |
| "NextPageLink": "<string>", | |
| "Count": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/social-history": { | |
| "get": { | |
| "description": "Gets a list of social history for the given person id after applying additional OData query operations.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/social-history", | |
| "tags": [ | |
| "Smoking Status" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/social-history", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "$top", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$filter", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$orderby", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$skip", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$inlinecount", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$count", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose social history is being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK95" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "Items": [ | |
| { | |
| "createTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "createdBy": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "modifyTimestampTimezone": "<string>", | |
| "modifiedBy": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "personId": "<string>", | |
| "encounterId": "<string>", | |
| "homeLanguage": "<string>", | |
| "birthCountry": "<string>", | |
| "handDominance": "<string>", | |
| "educationLevel": "<string>", | |
| "educationDegree": "<string>", | |
| "educationDegreeCountry": "<string>", | |
| "occupationalHazard1": "<string>", | |
| "occupationalHazard2": "<string>", | |
| "hasMilitaryExperience": "<string>", | |
| "militaryType": "<string>", | |
| "militaryBranch": "<string>", | |
| "militaryYearsServed": "<string>", | |
| "militaryDischargeType": "<string>", | |
| "militaryStationedOverseas": "<string>", | |
| "militaryStationedOverseasLocation": "<string>", | |
| "militaryNoiseExposure": "<string>", | |
| "militaryBiohazardExposure": "<string>", | |
| "previousWidowed": "<string>", | |
| "previousWidowedTimes": "<string>", | |
| "previousDivorce": "<string>", | |
| "previousDivorceTimes": "<string>", | |
| "hasChildren": "<string>", | |
| "sonsCount": "<string>", | |
| "daughtersCount": "<string>", | |
| "supportNetworkComments": "<string>", | |
| "supportNetwork": "<string>", | |
| "primaryResidenceComments": "<string>", | |
| "tobaccoUsage": "<string>", | |
| "tobaccoType": "<string>", | |
| "tobaccoUnitsPerDay": "<string>", | |
| "tobaccoUnit": "<string>", | |
| "tobaccoYearsSmoked": "<string>", | |
| "tobaccoPackYears": "<string>", | |
| "tobaccoCurrentOrPast": "<string>", | |
| "tobaccoPreviousCessationAttempt": "<string>", | |
| "tobaccoYearQuit": "<string>", | |
| "tobaccoLongestFreePeriod": "<string>", | |
| "tobaccoRelapseReason": "<string>", | |
| "passiveSmokeExposure": "<string>", | |
| "tobaccoCessationMethods": "<string>", | |
| "alcoholUsage": "<string>", | |
| "caffeineUsage": "<string>", | |
| "caffeineType": "<string>", | |
| "caffeineType2": "<string>", | |
| "caffeinePerDay": "<string>", | |
| "activityLevel": "<string>", | |
| "healthClubMember": "<string>", | |
| "exerciseFrequency": "<string>", | |
| "exerciseHoursWeek": "<string>", | |
| "exerciseType": "<string>", | |
| "exercisetype2": "<string>", | |
| "exercisetype3": "<string>", | |
| "hobby1": "<string>", | |
| "hobby2": "<string>", | |
| "hobby3": "<string>", | |
| "dietHistory1": "<string>", | |
| "dietHistory2": "<string>", | |
| "dietHistory3": "<string>", | |
| "dietHistory4": "<string>", | |
| "dietHistory5": "<string>", | |
| "petAnimals": "<string>", | |
| "petBirds": "<string>", | |
| "petDogs": "<string>", | |
| "petRodents": "<string>", | |
| "petReptiles": "<string>", | |
| "petOther": "<string>", | |
| "pets": "<string>", | |
| "cleansAnimals": "<string>", | |
| "changesInSleepPatterns": "<string>", | |
| "religiousAffiliation": "<string>", | |
| "practiceReligion": "<string>", | |
| "spiritualBeliefs": "<string>", | |
| "importanceOfReligionSpirituality": "<string>", | |
| "smokeDetectorsInHome": "<string>", | |
| "carbonMonoxideDetectorsInHome": "<string>", | |
| "radonInHome": "<string>", | |
| "homeHeating": "<string>", | |
| "seatBeltUsage": "<string>", | |
| "fireArmsAtHome": "<string>", | |
| "agreesToTransfusion": "<string>", | |
| "travelOutOfState": "<string>", | |
| "travelOutOfStateLocation": "<string>", | |
| "travelOutOfCountry": "<string>", | |
| "travelOutOfCounrtyLocation": "<string>", | |
| "travelOutOfCountryRegion": "<string>", | |
| "travelExposure": "<string>", | |
| "travelExposureDetail": "<string>", | |
| "advanceDirectivesReviewDate": "<string>", | |
| "advanceDirectivesNone": "<string>", | |
| "advanceDirectivesRefused": "<string>", | |
| "advanceDirectivesDnr": "<string>", | |
| "advanceDirectivesLivingWill": "<string>", | |
| "advanceDirectivesDoNotPlaceOnLifeSupport": "<string>", | |
| "advanceDirectivesDurablePowerOfAttorney": "<string>", | |
| "advanceDirectivesHcProxy": "<string>", | |
| "advanceDirectivesHcProxyName": "<string>", | |
| "advanceDirectivesIncremented": "<string>", | |
| "advanceDirectivesDiscussionsCount": "<string>", | |
| "comments": "<string>", | |
| "alcoholYearQuit": "<string>", | |
| "alcoholType": "<string>", | |
| "alcoholFrequency": "<string>", | |
| "alcoholLastDrink": "<string>", | |
| "alcoholAmount": "<string>", | |
| "smokingStatus": "<string>", | |
| "smokingStatusCode": "<string>", | |
| "maritalStatus": "<string>", | |
| "religion": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "createTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "createdBy": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "modifyTimestampTimezone": "<string>", | |
| "modifiedBy": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "personId": "<string>", | |
| "encounterId": "<string>", | |
| "homeLanguage": "<string>", | |
| "birthCountry": "<string>", | |
| "handDominance": "<string>", | |
| "educationLevel": "<string>", | |
| "educationDegree": "<string>", | |
| "educationDegreeCountry": "<string>", | |
| "occupationalHazard1": "<string>", | |
| "occupationalHazard2": "<string>", | |
| "hasMilitaryExperience": "<string>", | |
| "militaryType": "<string>", | |
| "militaryBranch": "<string>", | |
| "militaryYearsServed": "<string>", | |
| "militaryDischargeType": "<string>", | |
| "militaryStationedOverseas": "<string>", | |
| "militaryStationedOverseasLocation": "<string>", | |
| "militaryNoiseExposure": "<string>", | |
| "militaryBiohazardExposure": "<string>", | |
| "previousWidowed": "<string>", | |
| "previousWidowedTimes": "<string>", | |
| "previousDivorce": "<string>", | |
| "previousDivorceTimes": "<string>", | |
| "hasChildren": "<string>", | |
| "sonsCount": "<string>", | |
| "daughtersCount": "<string>", | |
| "supportNetworkComments": "<string>", | |
| "supportNetwork": "<string>", | |
| "primaryResidenceComments": "<string>", | |
| "tobaccoUsage": "<string>", | |
| "tobaccoType": "<string>", | |
| "tobaccoUnitsPerDay": "<string>", | |
| "tobaccoUnit": "<string>", | |
| "tobaccoYearsSmoked": "<string>", | |
| "tobaccoPackYears": "<string>", | |
| "tobaccoCurrentOrPast": "<string>", | |
| "tobaccoPreviousCessationAttempt": "<string>", | |
| "tobaccoYearQuit": "<string>", | |
| "tobaccoLongestFreePeriod": "<string>", | |
| "tobaccoRelapseReason": "<string>", | |
| "passiveSmokeExposure": "<string>", | |
| "tobaccoCessationMethods": "<string>", | |
| "alcoholUsage": "<string>", | |
| "caffeineUsage": "<string>", | |
| "caffeineType": "<string>", | |
| "caffeineType2": "<string>", | |
| "caffeinePerDay": "<string>", | |
| "activityLevel": "<string>", | |
| "healthClubMember": "<string>", | |
| "exerciseFrequency": "<string>", | |
| "exerciseHoursWeek": "<string>", | |
| "exerciseType": "<string>", | |
| "exercisetype2": "<string>", | |
| "exercisetype3": "<string>", | |
| "hobby1": "<string>", | |
| "hobby2": "<string>", | |
| "hobby3": "<string>", | |
| "dietHistory1": "<string>", | |
| "dietHistory2": "<string>", | |
| "dietHistory3": "<string>", | |
| "dietHistory4": "<string>", | |
| "dietHistory5": "<string>", | |
| "petAnimals": "<string>", | |
| "petBirds": "<string>", | |
| "petDogs": "<string>", | |
| "petRodents": "<string>", | |
| "petReptiles": "<string>", | |
| "petOther": "<string>", | |
| "pets": "<string>", | |
| "cleansAnimals": "<string>", | |
| "changesInSleepPatterns": "<string>", | |
| "religiousAffiliation": "<string>", | |
| "practiceReligion": "<string>", | |
| "spiritualBeliefs": "<string>", | |
| "importanceOfReligionSpirituality": "<string>", | |
| "smokeDetectorsInHome": "<string>", | |
| "carbonMonoxideDetectorsInHome": "<string>", | |
| "radonInHome": "<string>", | |
| "homeHeating": "<string>", | |
| "seatBeltUsage": "<string>", | |
| "fireArmsAtHome": "<string>", | |
| "agreesToTransfusion": "<string>", | |
| "travelOutOfState": "<string>", | |
| "travelOutOfStateLocation": "<string>", | |
| "travelOutOfCountry": "<string>", | |
| "travelOutOfCounrtyLocation": "<string>", | |
| "travelOutOfCountryRegion": "<string>", | |
| "travelExposure": "<string>", | |
| "travelExposureDetail": "<string>", | |
| "advanceDirectivesReviewDate": "<string>", | |
| "advanceDirectivesNone": "<string>", | |
| "advanceDirectivesRefused": "<string>", | |
| "advanceDirectivesDnr": "<string>", | |
| "advanceDirectivesLivingWill": "<string>", | |
| "advanceDirectivesDoNotPlaceOnLifeSupport": "<string>", | |
| "advanceDirectivesDurablePowerOfAttorney": "<string>", | |
| "advanceDirectivesHcProxy": "<string>", | |
| "advanceDirectivesHcProxyName": "<string>", | |
| "advanceDirectivesIncremented": "<string>", | |
| "advanceDirectivesDiscussionsCount": "<string>", | |
| "comments": "<string>", | |
| "alcoholYearQuit": "<string>", | |
| "alcoholType": "<string>", | |
| "alcoholFrequency": "<string>", | |
| "alcoholLastDrink": "<string>", | |
| "alcoholAmount": "<string>", | |
| "smokingStatus": "<string>", | |
| "smokingStatusCode": "<string>", | |
| "maritalStatus": "<string>", | |
| "religion": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ], | |
| "NextPageLink": "<string>", | |
| "Count": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/tobacco-usage": { | |
| "get": { | |
| "description": "Gets a list of tobacco usage for the given person id after applying additional OData query operations.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/tobacco-usage", | |
| "tags": [ | |
| "Smoking Status" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/tobacco-usage", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "$top", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$filter", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$orderby", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$skip", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$inlinecount", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$count", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose tobacco usage is being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK96" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "Items": [ | |
| { | |
| "encounterId": "<string>", | |
| "personId": "<string>", | |
| "sequenceNumber": "<string>", | |
| "createTimestamp": "<string>", | |
| "maximumTobaccoFreeDuration": "<string>", | |
| "packYears": "<string>", | |
| "passiveExposure": "<string>", | |
| "relapseReason": "<string>", | |
| "tobaccoType": "<string>", | |
| "socialHistoryTobaccoType": "<string>", | |
| "tobaccoUseStatus": "<string>", | |
| "totalPackYears": "<string>", | |
| "triedToQuit": "<string>", | |
| "unitsPerDay": "<string>", | |
| "yearQuit": "<string>", | |
| "yearsUsed": "<string>", | |
| "ageStarted": "<string>", | |
| "ageStopped": "<string>", | |
| "dateStarted": "<string>", | |
| "dateStopped": "<string>", | |
| "smokingStatus": "<string>", | |
| "tobaccoStatus": "<string>", | |
| "usagePerDay": "<string>", | |
| "socialHistoryCreateTimestamp": "<string>", | |
| "tobaccoUserProfileCode": "<string>", | |
| "tobaccoUserProfile": "<string>", | |
| "useDailyCigarette": "<string>", | |
| "ageStartedCigarette": "<string>", | |
| "ageStoppedCigarette": "<string>", | |
| "usagePerDayCigarette": "<string>", | |
| "useDailyCigarillo": "<string>", | |
| "ageStartedCigarillo": "<string>", | |
| "ageStoppedCigarillo": "<string>", | |
| "usagePerDayCigarillo": "<string>", | |
| "useDailyCigar": "<string>", | |
| "ageStartedCigar": "<string>", | |
| "ageStoppedCigar": "<string>", | |
| "usagePerDayCigar": "<string>", | |
| "useDailyPipe": "<string>", | |
| "ageStartedPipe": "<string>", | |
| "ageStoppedPipe": "<string>", | |
| "usagePerDayPipe": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "encounterId": "<string>", | |
| "personId": "<string>", | |
| "sequenceNumber": "<string>", | |
| "createTimestamp": "<string>", | |
| "maximumTobaccoFreeDuration": "<string>", | |
| "packYears": "<string>", | |
| "passiveExposure": "<string>", | |
| "relapseReason": "<string>", | |
| "tobaccoType": "<string>", | |
| "socialHistoryTobaccoType": "<string>", | |
| "tobaccoUseStatus": "<string>", | |
| "totalPackYears": "<string>", | |
| "triedToQuit": "<string>", | |
| "unitsPerDay": "<string>", | |
| "yearQuit": "<string>", | |
| "yearsUsed": "<string>", | |
| "ageStarted": "<string>", | |
| "ageStopped": "<string>", | |
| "dateStarted": "<string>", | |
| "dateStopped": "<string>", | |
| "smokingStatus": "<string>", | |
| "tobaccoStatus": "<string>", | |
| "usagePerDay": "<string>", | |
| "socialHistoryCreateTimestamp": "<string>", | |
| "tobaccoUserProfileCode": "<string>", | |
| "tobaccoUserProfile": "<string>", | |
| "useDailyCigarette": "<string>", | |
| "ageStartedCigarette": "<string>", | |
| "ageStoppedCigarette": "<string>", | |
| "usagePerDayCigarette": "<string>", | |
| "useDailyCigarillo": "<string>", | |
| "ageStartedCigarillo": "<string>", | |
| "ageStoppedCigarillo": "<string>", | |
| "usagePerDayCigarillo": "<string>", | |
| "useDailyCigar": "<string>", | |
| "ageStartedCigar": "<string>", | |
| "ageStoppedCigar": "<string>", | |
| "usagePerDayCigar": "<string>", | |
| "useDailyPipe": "<string>", | |
| "ageStartedPipe": "<string>", | |
| "ageStoppedPipe": "<string>", | |
| "usagePerDayPipe": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ], | |
| "NextPageLink": "<string>", | |
| "Count": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/vitals": { | |
| "get": { | |
| "description": "Gets a list of vital sign summaries for the given person id after applying additional OData query operations.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/vitals", | |
| "tags": [ | |
| "Vital Signs" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/vitals", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "$top", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$filter", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$orderby", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$skip", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$inlinecount", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "$count", | |
| "in": "query", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| }, | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose vital signs are being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK97" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "Items": [ | |
| { | |
| "id": "<string>", | |
| "personId": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "encounterId": "<string>", | |
| "vitalSignsDate": "<string>", | |
| "vitalSignsTime": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "id": "<string>", | |
| "personId": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "encounterId": "<string>", | |
| "vitalSignsDate": "<string>", | |
| "vitalSignsTime": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ], | |
| "NextPageLink": "<string>", | |
| "Count": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/encounters/{encounterId}/vitals/{vitalsId}": { | |
| "get": { | |
| "description": "Gets the vital sign details for the given person id, encounter id, and vital signs id.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/vitals/:vitalsId", | |
| "tags": [ | |
| "Vital Signs" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/vitals/:vitalsId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose vital signs are being retrieved" | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the encounter in which the vital signs were taken" | |
| }, | |
| { | |
| "name": "vitalsId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the vital signs that are being retrieved" | |
| }, | |
| { | |
| "name": "Accept", | |
| "in": "header", | |
| "required": true, | |
| "type": "string", | |
| "description": "" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK98" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "id": "<string>", | |
| "personId": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "encounterId": "<string>", | |
| "bmi": "<string>", | |
| "bloodPressure": "<string>", | |
| "bloodPressureSystolic": "<string>", | |
| "bloodPressureDiastolic": "<string>", | |
| "bloodPressureMethod": "<string>", | |
| "bloodPressureSide": "<string>", | |
| "bloodPressureBodySite": "<string>", | |
| "bloodPressureSite": "<string>", | |
| "bloodPressureBodyPosition": "<string>", | |
| "isBloodPressureCuffSizePediatric": "<string>", | |
| "isBloodPressureCuffSizeAdult": "<string>", | |
| "isBloodPressureCuffSizeLarge": "<string>", | |
| "isBloodPressureCuffSizeThigh": "<string>", | |
| "isBloodPressureCaptured": "<string>", | |
| "measuredBy": "<string>", | |
| "vitalSignsDate": "<string>", | |
| "vitalSignsTime": "<string>", | |
| "fractionOfInspiredOxygen": "<string>", | |
| "pulsePattern": "<string>", | |
| "pulseRate": "<string>", | |
| "pulseOximeterOxygenSaturationRest": "<string>", | |
| "pulseOximeterOxygenSaturationRestSite": "<string>", | |
| "isGrowthChartCaptured": "<string>", | |
| "isHealthAssessmentQuestionnaireCaptured": "<string>", | |
| "isExclusionCaptured": "<string>", | |
| "bmiPercent": "<string>", | |
| "bodySurfaceArea": "<string>", | |
| "isHipCircumferenceCaptured": "<string>", | |
| "isHeadCircumferenceCaptured": "<string>", | |
| "isHeightCaptured": "<string>", | |
| "isNeckCircumferenceCaptured": "<string>", | |
| "isTemperatureCaptured": "<string>", | |
| "isWaistCircumferenceCaptured": "<string>", | |
| "isWeightCaptured": "<string>", | |
| "hasPatientRefused": "<string>", | |
| "isUnobtainable": "<string>", | |
| "comments": "<string>", | |
| "headCircumferenceCentimeters": "<string>", | |
| "headCircumferenceInches": "<string>", | |
| "headCircumferencePercent": "<string>", | |
| "heightCentimeters": "<string>", | |
| "heightDate": "<string>", | |
| "heightFeet": "<string>", | |
| "heightInches": "<string>", | |
| "heightMeters": "<string>", | |
| "heightMethod": "<string>", | |
| "heightPercent": "<string>", | |
| "hipCircumferenceCentimeters": "<string>", | |
| "hipCircumferenceInches": "<string>", | |
| "heightBodyPosition": "<string>", | |
| "neckCircumferenceCentimeters": "<string>", | |
| "neckCircumferenceInches": "<string>", | |
| "pulseOximeterOxygenSaturationSource": "<string>", | |
| "painScoreLoinc": "<string>", | |
| "painScoreDisplay": "<string>", | |
| "peakFlow": "<string>", | |
| "peakFlowMethod": "<string>", | |
| "peakFlowTiming": "<string>", | |
| "respirationRate": "<string>", | |
| "pulseOximeterOxygenSaturationMeasured": "<string>", | |
| "temperatureDegreesCelcius": "<string>", | |
| "temperatureDegreesFahrenheit": "<string>", | |
| "temperatureSite": "<string>", | |
| "fractionOfInspiredOxygenLitresPerMinute": "<string>", | |
| "currentAge": "<string>", | |
| "fractionOfInspiredOxygenRoomAir": "<string>", | |
| "pulseOximeterOxygenSaturationRestLitresPerMinute": "<string>", | |
| "painMethod": "<string>", | |
| "pulseOximeterOxygenSaturationAmbulatory": "<string>", | |
| "reasonRefused": "<string>", | |
| "unobtainableReason": "<string>", | |
| "patientRefusedVitals": "<string>", | |
| "unobtainableVitals": "<string>", | |
| "waistCircumferenceCentimeters": "<string>", | |
| "waistCircumferenceInches": "<string>", | |
| "waistHipRatio": "<string>", | |
| "weightContext": "<string>", | |
| "weightKilograms": "<string>", | |
| "weightPounds": "<string>", | |
| "weightPercent": "<string>", | |
| "bloodPressureCuffSize": "<string>", | |
| "areOrthostaticVitalSignsCaptured": "<string>", | |
| "menopausalStage": "<string>", | |
| "lmp": "<string>", | |
| "gestationalWeeks": "<string>", | |
| "gestationalDays": "<string>", | |
| "heightCentimetersGraph": "<string>", | |
| "heightInchesGraph": "<string>", | |
| "weightKilogramsGraph": "<string>", | |
| "weightPoundsGraph": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| }, | |
| "put": { | |
| "description": "Updates Vital Signs for the given person id, encounter id and vital signs Id.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/vitals/:vitalsId", | |
| "tags": [ | |
| "Vital Signs" | |
| ], | |
| "operationId": "Put{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/vitals/:vitalsId", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose vital signs are being retrieved" | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the encounter in which the vital signs were taken" | |
| }, | |
| { | |
| "name": "vitalsId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the vital signs that are being retrieved" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1encounters~1%3AencounterId~1vitals~1%3AvitalsIdRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK98" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "id": "<string>", | |
| "personId": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "encounterId": "<string>", | |
| "bmi": "<string>", | |
| "bloodPressure": "<string>", | |
| "bloodPressureSystolic": "<string>", | |
| "bloodPressureDiastolic": "<string>", | |
| "bloodPressureMethod": "<string>", | |
| "bloodPressureSide": "<string>", | |
| "bloodPressureBodySite": "<string>", | |
| "bloodPressureSite": "<string>", | |
| "bloodPressureBodyPosition": "<string>", | |
| "isBloodPressureCuffSizePediatric": "<string>", | |
| "isBloodPressureCuffSizeAdult": "<string>", | |
| "isBloodPressureCuffSizeLarge": "<string>", | |
| "isBloodPressureCuffSizeThigh": "<string>", | |
| "isBloodPressureCaptured": "<string>", | |
| "measuredBy": "<string>", | |
| "vitalSignsDate": "<string>", | |
| "vitalSignsTime": "<string>", | |
| "fractionOfInspiredOxygen": "<string>", | |
| "pulsePattern": "<string>", | |
| "pulseRate": "<string>", | |
| "pulseOximeterOxygenSaturationRest": "<string>", | |
| "pulseOximeterOxygenSaturationRestSite": "<string>", | |
| "isGrowthChartCaptured": "<string>", | |
| "isHealthAssessmentQuestionnaireCaptured": "<string>", | |
| "isExclusionCaptured": "<string>", | |
| "bmiPercent": "<string>", | |
| "bodySurfaceArea": "<string>", | |
| "isHipCircumferenceCaptured": "<string>", | |
| "isHeadCircumferenceCaptured": "<string>", | |
| "isHeightCaptured": "<string>", | |
| "isNeckCircumferenceCaptured": "<string>", | |
| "isTemperatureCaptured": "<string>", | |
| "isWaistCircumferenceCaptured": "<string>", | |
| "isWeightCaptured": "<string>", | |
| "hasPatientRefused": "<string>", | |
| "isUnobtainable": "<string>", | |
| "comments": "<string>", | |
| "headCircumferenceCentimeters": "<string>", | |
| "headCircumferenceInches": "<string>", | |
| "headCircumferencePercent": "<string>", | |
| "heightCentimeters": "<string>", | |
| "heightDate": "<string>", | |
| "heightFeet": "<string>", | |
| "heightInches": "<string>", | |
| "heightMeters": "<string>", | |
| "heightMethod": "<string>", | |
| "heightPercent": "<string>", | |
| "hipCircumferenceCentimeters": "<string>", | |
| "hipCircumferenceInches": "<string>", | |
| "heightBodyPosition": "<string>", | |
| "neckCircumferenceCentimeters": "<string>", | |
| "neckCircumferenceInches": "<string>", | |
| "pulseOximeterOxygenSaturationSource": "<string>", | |
| "painScoreLoinc": "<string>", | |
| "painScoreDisplay": "<string>", | |
| "peakFlow": "<string>", | |
| "peakFlowMethod": "<string>", | |
| "peakFlowTiming": "<string>", | |
| "respirationRate": "<string>", | |
| "pulseOximeterOxygenSaturationMeasured": "<string>", | |
| "temperatureDegreesCelcius": "<string>", | |
| "temperatureDegreesFahrenheit": "<string>", | |
| "temperatureSite": "<string>", | |
| "fractionOfInspiredOxygenLitresPerMinute": "<string>", | |
| "currentAge": "<string>", | |
| "fractionOfInspiredOxygenRoomAir": "<string>", | |
| "pulseOximeterOxygenSaturationRestLitresPerMinute": "<string>", | |
| "painMethod": "<string>", | |
| "pulseOximeterOxygenSaturationAmbulatory": "<string>", | |
| "reasonRefused": "<string>", | |
| "unobtainableReason": "<string>", | |
| "patientRefusedVitals": "<string>", | |
| "unobtainableVitals": "<string>", | |
| "waistCircumferenceCentimeters": "<string>", | |
| "waistCircumferenceInches": "<string>", | |
| "waistHipRatio": "<string>", | |
| "weightContext": "<string>", | |
| "weightKilograms": "<string>", | |
| "weightPounds": "<string>", | |
| "weightPercent": "<string>", | |
| "bloodPressureCuffSize": "<string>", | |
| "areOrthostaticVitalSignsCaptured": "<string>", | |
| "menopausalStage": "<string>", | |
| "lmp": "<string>", | |
| "gestationalWeeks": "<string>", | |
| "gestationalDays": "<string>", | |
| "heightCentimetersGraph": "<string>", | |
| "heightInchesGraph": "<string>", | |
| "weightKilogramsGraph": "<string>", | |
| "weightPoundsGraph": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| }, | |
| "/persons/{personId}/chart/encounters/{encounterId}/vitals": { | |
| "post": { | |
| "description": "Updates Vital Signs for the given person id, encounter id and vital signs Id.", | |
| "summary": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/vitals", | |
| "tags": [ | |
| "Vital Signs" | |
| ], | |
| "operationId": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/vitals", | |
| "deprecated": false, | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "personId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the patient whose vital signs are being retrieved" | |
| }, | |
| { | |
| "name": "encounterId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string", | |
| "description": "(Required) (Required) The id of the encounter in which the vital signs were taken" | |
| }, | |
| { | |
| "name": "Body", | |
| "in": "body", | |
| "required": true, | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/%7B%7BbaseUrl%7D%7D~1persons~1%3ApersonId~1chart~1encounters~1%3AencounterId~1vitalsRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "schema": { | |
| "$ref": "#/definitions/OK98" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "id": "<string>", | |
| "personId": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "encounterId": "<string>", | |
| "bmi": "<string>", | |
| "bloodPressure": "<string>", | |
| "bloodPressureSystolic": "<string>", | |
| "bloodPressureDiastolic": "<string>", | |
| "bloodPressureMethod": "<string>", | |
| "bloodPressureSide": "<string>", | |
| "bloodPressureBodySite": "<string>", | |
| "bloodPressureSite": "<string>", | |
| "bloodPressureBodyPosition": "<string>", | |
| "isBloodPressureCuffSizePediatric": "<string>", | |
| "isBloodPressureCuffSizeAdult": "<string>", | |
| "isBloodPressureCuffSizeLarge": "<string>", | |
| "isBloodPressureCuffSizeThigh": "<string>", | |
| "isBloodPressureCaptured": "<string>", | |
| "measuredBy": "<string>", | |
| "vitalSignsDate": "<string>", | |
| "vitalSignsTime": "<string>", | |
| "fractionOfInspiredOxygen": "<string>", | |
| "pulsePattern": "<string>", | |
| "pulseRate": "<string>", | |
| "pulseOximeterOxygenSaturationRest": "<string>", | |
| "pulseOximeterOxygenSaturationRestSite": "<string>", | |
| "isGrowthChartCaptured": "<string>", | |
| "isHealthAssessmentQuestionnaireCaptured": "<string>", | |
| "isExclusionCaptured": "<string>", | |
| "bmiPercent": "<string>", | |
| "bodySurfaceArea": "<string>", | |
| "isHipCircumferenceCaptured": "<string>", | |
| "isHeadCircumferenceCaptured": "<string>", | |
| "isHeightCaptured": "<string>", | |
| "isNeckCircumferenceCaptured": "<string>", | |
| "isTemperatureCaptured": "<string>", | |
| "isWaistCircumferenceCaptured": "<string>", | |
| "isWeightCaptured": "<string>", | |
| "hasPatientRefused": "<string>", | |
| "isUnobtainable": "<string>", | |
| "comments": "<string>", | |
| "headCircumferenceCentimeters": "<string>", | |
| "headCircumferenceInches": "<string>", | |
| "headCircumferencePercent": "<string>", | |
| "heightCentimeters": "<string>", | |
| "heightDate": "<string>", | |
| "heightFeet": "<string>", | |
| "heightInches": "<string>", | |
| "heightMeters": "<string>", | |
| "heightMethod": "<string>", | |
| "heightPercent": "<string>", | |
| "hipCircumferenceCentimeters": "<string>", | |
| "hipCircumferenceInches": "<string>", | |
| "heightBodyPosition": "<string>", | |
| "neckCircumferenceCentimeters": "<string>", | |
| "neckCircumferenceInches": "<string>", | |
| "pulseOximeterOxygenSaturationSource": "<string>", | |
| "painScoreLoinc": "<string>", | |
| "painScoreDisplay": "<string>", | |
| "peakFlow": "<string>", | |
| "peakFlowMethod": "<string>", | |
| "peakFlowTiming": "<string>", | |
| "respirationRate": "<string>", | |
| "pulseOximeterOxygenSaturationMeasured": "<string>", | |
| "temperatureDegreesCelcius": "<string>", | |
| "temperatureDegreesFahrenheit": "<string>", | |
| "temperatureSite": "<string>", | |
| "fractionOfInspiredOxygenLitresPerMinute": "<string>", | |
| "currentAge": "<string>", | |
| "fractionOfInspiredOxygenRoomAir": "<string>", | |
| "pulseOximeterOxygenSaturationRestLitresPerMinute": "<string>", | |
| "painMethod": "<string>", | |
| "pulseOximeterOxygenSaturationAmbulatory": "<string>", | |
| "reasonRefused": "<string>", | |
| "unobtainableReason": "<string>", | |
| "patientRefusedVitals": "<string>", | |
| "unobtainableVitals": "<string>", | |
| "waistCircumferenceCentimeters": "<string>", | |
| "waistCircumferenceInches": "<string>", | |
| "waistHipRatio": "<string>", | |
| "weightContext": "<string>", | |
| "weightKilograms": "<string>", | |
| "weightPounds": "<string>", | |
| "weightPercent": "<string>", | |
| "bloodPressureCuffSize": "<string>", | |
| "areOrthostaticVitalSignsCaptured": "<string>", | |
| "menopausalStage": "<string>", | |
| "lmp": "<string>", | |
| "gestationalWeeks": "<string>", | |
| "gestationalDays": "<string>", | |
| "heightCentimetersGraph": "<string>", | |
| "heightInchesGraph": "<string>", | |
| "weightKilogramsGraph": "<string>", | |
| "weightPoundsGraph": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/BadRequest1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "schema": { | |
| "$ref": "#/definitions/Forbidden1" | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "message": "<string>" | |
| } | |
| }, | |
| "headers": {} | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "headers": {} | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "definitions": { | |
| "OK": { | |
| "title": "OK", | |
| "example": { | |
| "Items": [ | |
| { | |
| "id": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "personId": "<string>", | |
| "encounterId": "<string>", | |
| "encounterTimestamp": "<string>", | |
| "encounterTimestampTimezone": "<string>", | |
| "allergyId": "<string>", | |
| "allergyTypeId": "<string>", | |
| "description": "<string>", | |
| "allergyType": "<string>", | |
| "locationId": "<string>", | |
| "providerId": "<string>", | |
| "onsetDate": "<string>", | |
| "resolvedDate": "<string>", | |
| "comment": "<string>", | |
| "reactionDescription": "<string>", | |
| "criticalityCode": "<string>", | |
| "isLocked": "<string>", | |
| "isReadOnly": "<string>", | |
| "rxNormCode": "<string>", | |
| "rxNormDescription": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "id": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "personId": "<string>", | |
| "encounterId": "<string>", | |
| "encounterTimestamp": "<string>", | |
| "encounterTimestampTimezone": "<string>", | |
| "allergyId": "<string>", | |
| "allergyTypeId": "<string>", | |
| "description": "<string>", | |
| "allergyType": "<string>", | |
| "locationId": "<string>", | |
| "providerId": "<string>", | |
| "onsetDate": "<string>", | |
| "resolvedDate": "<string>", | |
| "comment": "<string>", | |
| "reactionDescription": "<string>", | |
| "criticalityCode": "<string>", | |
| "isLocked": "<string>", | |
| "isReadOnly": "<string>", | |
| "rxNormCode": "<string>", | |
| "rxNormDescription": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ], | |
| "NextPageLink": "<string>", | |
| "Count": "<string>" | |
| }, | |
| "type": "object", | |
| "properties": { | |
| "Items": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Item" | |
| } | |
| }, | |
| "NextPageLink": { | |
| "type": "string" | |
| }, | |
| "Count": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "Items", | |
| "NextPageLink", | |
| "Count" | |
| ] | |
| }, | |
| "Item": { | |
| "title": "Item", | |
| "example": { | |
| "id": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "personId": "<string>", | |
| "encounterId": "<string>", | |
| "encounterTimestamp": "<string>", | |
| "encounterTimestampTimezone": "<string>", | |
| "allergyId": "<string>", | |
| "allergyTypeId": "<string>", | |
| "description": "<string>", | |
| "allergyType": "<string>", | |
| "locationId": "<string>", | |
| "providerId": "<string>", | |
| "onsetDate": "<string>", | |
| "resolvedDate": "<string>", | |
| "comment": "<string>", | |
| "reactionDescription": "<string>", | |
| "criticalityCode": "<string>", | |
| "isLocked": "<string>", | |
| "isReadOnly": "<string>", | |
| "rxNormCode": "<string>", | |
| "rxNormDescription": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "enterpriseId": { | |
| "type": "string" | |
| }, | |
| "practiceId": { | |
| "type": "string" | |
| }, | |
| "personId": { | |
| "type": "string" | |
| }, | |
| "encounterId": { | |
| "type": "string" | |
| }, | |
| "encounterTimestamp": { | |
| "type": "string" | |
| }, | |
| "encounterTimestampTimezone": { | |
| "type": "string" | |
| }, | |
| "allergyId": { | |
| "type": "string" | |
| }, | |
| "allergyTypeId": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "allergyType": { | |
| "type": "string" | |
| }, | |
| "locationId": { | |
| "type": "string" | |
| }, | |
| "providerId": { | |
| "type": "string" | |
| }, | |
| "onsetDate": { | |
| "type": "string" | |
| }, | |
| "resolvedDate": { | |
| "type": "string" | |
| }, | |
| "comment": { | |
| "type": "string" | |
| }, | |
| "reactionDescription": { | |
| "type": "string" | |
| }, | |
| "criticalityCode": { | |
| "type": "string" | |
| }, | |
| "isLocked": { | |
| "type": "string" | |
| }, | |
| "isReadOnly": { | |
| "type": "string" | |
| }, | |
| "rxNormCode": { | |
| "type": "string" | |
| }, | |
| "rxNormDescription": { | |
| "type": "string" | |
| }, | |
| "_links": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| } | |
| }, | |
| "required": [ | |
| "id", | |
| "enterpriseId", | |
| "practiceId", | |
| "personId", | |
| "encounterId", | |
| "encounterTimestamp", | |
| "encounterTimestampTimezone", | |
| "allergyId", | |
| "allergyTypeId", | |
| "description", | |
| "allergyType", | |
| "locationId", | |
| "providerId", | |
| "onsetDate", | |
| "resolvedDate", | |
| "comment", | |
| "reactionDescription", | |
| "criticalityCode", | |
| "isLocked", | |
| "isReadOnly", | |
| "rxNormCode", | |
| "rxNormDescription", | |
| "_links" | |
| ] | |
| }, | |
| "Link": { | |
| "title": "Link", | |
| "example": { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| "type": "object", | |
| "properties": { | |
| "href": { | |
| "type": "string" | |
| }, | |
| "method": { | |
| "type": "string" | |
| }, | |
| "rel": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "vendorExtensions": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "href", | |
| "method", | |
| "rel", | |
| "description", | |
| "vendorExtensions" | |
| ] | |
| }, | |
| "BadRequest1": { | |
| "title": "BadRequest1", | |
| "example": { | |
| "message": "<string>" | |
| }, | |
| "type": "object", | |
| "properties": { | |
| "message": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "message" | |
| ] | |
| }, | |
| "Forbidden1": { | |
| "title": "Forbidden1", | |
| "example": { | |
| "message": "<string>" | |
| }, | |
| "type": "object", | |
| "properties": { | |
| "message": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "message" | |
| ] | |
| }, | |
| "OK1": { | |
| "title": "OK1", | |
| "example": { | |
| "id": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "personId": "<string>", | |
| "encounterId": "<string>", | |
| "encounterTimestamp": "<string>", | |
| "encounterTimestampTimezone": "<string>", | |
| "allergyId": "<string>", | |
| "allergyType": "<string>", | |
| "allergyTypeId": "<string>", | |
| "locationId": "<string>", | |
| "locationName": "<string>", | |
| "providerId": "<string>", | |
| "providerName": "<string>", | |
| "onsetDate": "<string>", | |
| "resolvedDate": "<string>", | |
| "comment": "<string>", | |
| "reactionDescription": "<string>", | |
| "sourceProductId": "<string>", | |
| "auditId": "<string>", | |
| "causativeAgent": "<string>", | |
| "whoReviewed": "<string>", | |
| "whenReviewed": "<string>", | |
| "isLocked": "<string>", | |
| "severityCode": "<string>", | |
| "isIntolerant": "<string>", | |
| "description": "<string>", | |
| "criticalityCode": "<string>", | |
| "createdBy": "<string>", | |
| "createTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "modifiedBy": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "modifyTimestampTimezone": "<string>", | |
| "isReadOnly": "<string>", | |
| "rxNormCode": "<string>", | |
| "rxNormDescription": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "enterpriseId": { | |
| "type": "string" | |
| }, | |
| "practiceId": { | |
| "type": "string" | |
| }, | |
| "personId": { | |
| "type": "string" | |
| }, | |
| "encounterId": { | |
| "type": "string" | |
| }, | |
| "encounterTimestamp": { | |
| "type": "string" | |
| }, | |
| "encounterTimestampTimezone": { | |
| "type": "string" | |
| }, | |
| "allergyId": { | |
| "type": "string" | |
| }, | |
| "allergyType": { | |
| "type": "string" | |
| }, | |
| "allergyTypeId": { | |
| "type": "string" | |
| }, | |
| "locationId": { | |
| "type": "string" | |
| }, | |
| "locationName": { | |
| "type": "string" | |
| }, | |
| "providerId": { | |
| "type": "string" | |
| }, | |
| "providerName": { | |
| "type": "string" | |
| }, | |
| "onsetDate": { | |
| "type": "string" | |
| }, | |
| "resolvedDate": { | |
| "type": "string" | |
| }, | |
| "comment": { | |
| "type": "string" | |
| }, | |
| "reactionDescription": { | |
| "type": "string" | |
| }, | |
| "sourceProductId": { | |
| "type": "string" | |
| }, | |
| "auditId": { | |
| "type": "string" | |
| }, | |
| "causativeAgent": { | |
| "type": "string" | |
| }, | |
| "whoReviewed": { | |
| "type": "string" | |
| }, | |
| "whenReviewed": { | |
| "type": "string" | |
| }, | |
| "isLocked": { | |
| "type": "string" | |
| }, | |
| "severityCode": { | |
| "type": "string" | |
| }, | |
| "isIntolerant": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "criticalityCode": { | |
| "type": "string" | |
| }, | |
| "createdBy": { | |
| "type": "string" | |
| }, | |
| "createTimestamp": { | |
| "type": "string" | |
| }, | |
| "createTimestampTimezone": { | |
| "type": "string" | |
| }, | |
| "modifiedBy": { | |
| "type": "string" | |
| }, | |
| "modifyTimestamp": { | |
| "type": "string" | |
| }, | |
| "modifyTimestampTimezone": { | |
| "type": "string" | |
| }, | |
| "isReadOnly": { | |
| "type": "string" | |
| }, | |
| "rxNormCode": { | |
| "type": "string" | |
| }, | |
| "rxNormDescription": { | |
| "type": "string" | |
| }, | |
| "_links": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| } | |
| }, | |
| "required": [ | |
| "id", | |
| "enterpriseId", | |
| "practiceId", | |
| "personId", | |
| "encounterId", | |
| "encounterTimestamp", | |
| "encounterTimestampTimezone", | |
| "allergyId", | |
| "allergyType", | |
| "allergyTypeId", | |
| "locationId", | |
| "locationName", | |
| "providerId", | |
| "providerName", | |
| "onsetDate", | |
| "resolvedDate", | |
| "comment", | |
| "reactionDescription", | |
| "sourceProductId", | |
| "auditId", | |
| "causativeAgent", | |
| "whoReviewed", | |
| "whenReviewed", | |
| "isLocked", | |
| "severityCode", | |
| "isIntolerant", | |
| "description", | |
| "criticalityCode", | |
| "createdBy", | |
| "createTimestamp", | |
| "createTimestampTimezone", | |
| "modifiedBy", | |
| "modifyTimestamp", | |
| "modifyTimestampTimezone", | |
| "isReadOnly", | |
| "rxNormCode", | |
| "rxNormDescription", | |
| "_links" | |
| ] | |
| }, | |
| "OK4": { | |
| "title": "OK4", | |
| "example": { | |
| "id": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "personId": "<string>", | |
| "encounterId": "<string>", | |
| "encounterTimestamp": "<string>", | |
| "encounterTimestampTimezone": "<string>", | |
| "allergyId": "<string>", | |
| "allergyTypeId": "<string>", | |
| "description": "<string>", | |
| "allergyType": "<string>", | |
| "locationId": "<string>", | |
| "providerId": "<string>", | |
| "onsetDate": "<string>", | |
| "resolvedDate": "<string>", | |
| "comment": "<string>", | |
| "reactionDescription": "<string>", | |
| "criticalityCode": "<string>", | |
| "isLocked": "<string>", | |
| "isReadOnly": "<string>", | |
| "rxNormCode": "<string>", | |
| "rxNormDescription": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "enterpriseId": { | |
| "type": "string" | |
| }, | |
| "practiceId": { | |
| "type": "string" | |
| }, | |
| "personId": { | |
| "type": "string" | |
| }, | |
| "encounterId": { | |
| "type": "string" | |
| }, | |
| "encounterTimestamp": { | |
| "type": "string" | |
| }, | |
| "encounterTimestampTimezone": { | |
| "type": "string" | |
| }, | |
| "allergyId": { | |
| "type": "string" | |
| }, | |
| "allergyTypeId": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "allergyType": { | |
| "type": "string" | |
| }, | |
| "locationId": { | |
| "type": "string" | |
| }, | |
| "providerId": { | |
| "type": "string" | |
| }, | |
| "onsetDate": { | |
| "type": "string" | |
| }, | |
| "resolvedDate": { | |
| "type": "string" | |
| }, | |
| "comment": { | |
| "type": "string" | |
| }, | |
| "reactionDescription": { | |
| "type": "string" | |
| }, | |
| "criticalityCode": { | |
| "type": "string" | |
| }, | |
| "isLocked": { | |
| "type": "string" | |
| }, | |
| "isReadOnly": { | |
| "type": "string" | |
| }, | |
| "rxNormCode": { | |
| "type": "string" | |
| }, | |
| "rxNormDescription": { | |
| "type": "string" | |
| }, | |
| "_links": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| } | |
| }, | |
| "required": [ | |
| "id", | |
| "enterpriseId", | |
| "practiceId", | |
| "personId", | |
| "encounterId", | |
| "encounterTimestamp", | |
| "encounterTimestampTimezone", | |
| "allergyId", | |
| "allergyTypeId", | |
| "description", | |
| "allergyType", | |
| "locationId", | |
| "providerId", | |
| "onsetDate", | |
| "resolvedDate", | |
| "comment", | |
| "reactionDescription", | |
| "criticalityCode", | |
| "isLocked", | |
| "isReadOnly", | |
| "rxNormCode", | |
| "rxNormDescription", | |
| "_links" | |
| ] | |
| }, | |
| "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/allergiesRequest": { | |
| "title": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/allergiesRequest", | |
| "example": { | |
| "allergyId": "<string>", | |
| "allergyTypeId": "<string>", | |
| "onsetDate": "<string>", | |
| "resolvedDate": "<string>", | |
| "comment": "<string>", | |
| "providerId": "<string>", | |
| "locationId": "<string>", | |
| "isIntolerant": "<string>", | |
| "isRecordedElsewhere": "<string>", | |
| "recordedElsewhereSource": "<string>", | |
| "allowDuplicateAllergies": "<string>", | |
| "noKnownAllergies": "<string>", | |
| "criticalityCode": "<string>" | |
| }, | |
| "type": "object", | |
| "properties": { | |
| "allergyId": { | |
| "type": "string" | |
| }, | |
| "allergyTypeId": { | |
| "type": "string" | |
| }, | |
| "onsetDate": { | |
| "type": "string" | |
| }, | |
| "resolvedDate": { | |
| "type": "string" | |
| }, | |
| "comment": { | |
| "type": "string" | |
| }, | |
| "providerId": { | |
| "type": "string" | |
| }, | |
| "locationId": { | |
| "type": "string" | |
| }, | |
| "isIntolerant": { | |
| "type": "string" | |
| }, | |
| "isRecordedElsewhere": { | |
| "type": "string" | |
| }, | |
| "recordedElsewhereSource": { | |
| "type": "string" | |
| }, | |
| "allowDuplicateAllergies": { | |
| "type": "string" | |
| }, | |
| "noKnownAllergies": { | |
| "type": "string" | |
| }, | |
| "criticalityCode": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "allergyId", | |
| "allergyTypeId", | |
| "onsetDate", | |
| "resolvedDate", | |
| "comment", | |
| "providerId", | |
| "locationId", | |
| "isIntolerant", | |
| "isRecordedElsewhere", | |
| "recordedElsewhereSource", | |
| "allowDuplicateAllergies", | |
| "noKnownAllergies", | |
| "criticalityCode" | |
| ] | |
| }, | |
| "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/allergies/:allergyIdRequest": { | |
| "title": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/allergies/:allergyIdRequest", | |
| "example": { | |
| "allergyId": "<string>", | |
| "allergyTypeId": "<string>", | |
| "onsetDate": "<string>", | |
| "resolvedDate": "<string>", | |
| "comment": "<string>", | |
| "providerId": "<string>", | |
| "locationId": "<string>", | |
| "isIntolerant": "<string>", | |
| "isRecordedElsewhere": "<string>", | |
| "recordedElsewhereSource": "<string>", | |
| "allowDuplicateAllergies": "<string>", | |
| "criticalityCode": "<string>" | |
| }, | |
| "type": "object", | |
| "properties": { | |
| "allergyId": { | |
| "type": "string" | |
| }, | |
| "allergyTypeId": { | |
| "type": "string" | |
| }, | |
| "onsetDate": { | |
| "type": "string" | |
| }, | |
| "resolvedDate": { | |
| "type": "string" | |
| }, | |
| "comment": { | |
| "type": "string" | |
| }, | |
| "providerId": { | |
| "type": "string" | |
| }, | |
| "locationId": { | |
| "type": "string" | |
| }, | |
| "isIntolerant": { | |
| "type": "string" | |
| }, | |
| "isRecordedElsewhere": { | |
| "type": "string" | |
| }, | |
| "recordedElsewhereSource": { | |
| "type": "string" | |
| }, | |
| "allowDuplicateAllergies": { | |
| "type": "string" | |
| }, | |
| "criticalityCode": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "allergyId", | |
| "allergyTypeId", | |
| "onsetDate", | |
| "resolvedDate", | |
| "comment", | |
| "providerId", | |
| "locationId", | |
| "isIntolerant", | |
| "isRecordedElsewhere", | |
| "recordedElsewhereSource", | |
| "allowDuplicateAllergies", | |
| "criticalityCode" | |
| ] | |
| }, | |
| "OK6": { | |
| "title": "OK6", | |
| "example": { | |
| "id": "<string>", | |
| "patientAllergyId": "<string>", | |
| "reactionDescription": "<string>", | |
| "snomedCode": "<string>", | |
| "severityCode": "<string>", | |
| "severityDescription": "<string>", | |
| "rank": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "patientAllergyId": { | |
| "type": "string" | |
| }, | |
| "reactionDescription": { | |
| "type": "string" | |
| }, | |
| "snomedCode": { | |
| "type": "string" | |
| }, | |
| "severityCode": { | |
| "type": "string" | |
| }, | |
| "severityDescription": { | |
| "type": "string" | |
| }, | |
| "rank": { | |
| "type": "string" | |
| }, | |
| "_links": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| } | |
| }, | |
| "required": [ | |
| "id", | |
| "patientAllergyId", | |
| "reactionDescription", | |
| "snomedCode", | |
| "severityCode", | |
| "severityDescription", | |
| "rank", | |
| "_links" | |
| ] | |
| }, | |
| "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/allergies/:allergyId/reactionsRequest": { | |
| "title": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/allergies/:allergyId/reactionsRequest", | |
| "example": { | |
| "reactionDescription": "<string>", | |
| "severityCode": "<string>", | |
| "rank": "<string>" | |
| }, | |
| "type": "object", | |
| "properties": { | |
| "reactionDescription": { | |
| "type": "string" | |
| }, | |
| "severityCode": { | |
| "type": "string" | |
| }, | |
| "rank": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "reactionDescription", | |
| "severityCode", | |
| "rank" | |
| ] | |
| }, | |
| "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/allergies/:allergyId/reactions/:reactionIdRequest": { | |
| "title": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/allergies/:allergyId/reactions/:reactionIdRequest", | |
| "example": { | |
| "severityCode": "<string>", | |
| "rank": "<string>" | |
| }, | |
| "type": "object", | |
| "properties": { | |
| "severityCode": { | |
| "type": "string" | |
| }, | |
| "rank": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "severityCode", | |
| "rank" | |
| ] | |
| }, | |
| "OK7": { | |
| "title": "OK7", | |
| "example": { | |
| "Items": [ | |
| { | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "encounterId": "<string>", | |
| "personId": "<string>", | |
| "snomedConceptId": "<string>", | |
| "dateOnset": "<string>", | |
| "dateResolved": "<string>", | |
| "allergyType": "<string>", | |
| "encounterTimestamp": "<string>", | |
| "allergyComment": "<string>", | |
| "id": "<string>", | |
| "category": "<string>", | |
| "healthConcern": "<string>", | |
| "description": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "encounterId": "<string>", | |
| "personId": "<string>", | |
| "snomedConceptId": "<string>", | |
| "dateOnset": "<string>", | |
| "dateResolved": "<string>", | |
| "allergyType": "<string>", | |
| "encounterTimestamp": "<string>", | |
| "allergyComment": "<string>", | |
| "id": "<string>", | |
| "category": "<string>", | |
| "healthConcern": "<string>", | |
| "description": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ], | |
| "NextPageLink": "<string>", | |
| "Count": "<string>" | |
| }, | |
| "type": "object", | |
| "properties": { | |
| "Items": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Item2" | |
| } | |
| }, | |
| "NextPageLink": { | |
| "type": "string" | |
| }, | |
| "Count": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "Items", | |
| "NextPageLink", | |
| "Count" | |
| ] | |
| }, | |
| "Item2": { | |
| "title": "Item2", | |
| "example": { | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "encounterId": "<string>", | |
| "personId": "<string>", | |
| "snomedConceptId": "<string>", | |
| "dateOnset": "<string>", | |
| "dateResolved": "<string>", | |
| "allergyType": "<string>", | |
| "encounterTimestamp": "<string>", | |
| "allergyComment": "<string>", | |
| "id": "<string>", | |
| "category": "<string>", | |
| "healthConcern": "<string>", | |
| "description": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| "type": "object", | |
| "properties": { | |
| "enterpriseId": { | |
| "type": "string" | |
| }, | |
| "practiceId": { | |
| "type": "string" | |
| }, | |
| "encounterId": { | |
| "type": "string" | |
| }, | |
| "personId": { | |
| "type": "string" | |
| }, | |
| "snomedConceptId": { | |
| "type": "string" | |
| }, | |
| "dateOnset": { | |
| "type": "string" | |
| }, | |
| "dateResolved": { | |
| "type": "string" | |
| }, | |
| "allergyType": { | |
| "type": "string" | |
| }, | |
| "encounterTimestamp": { | |
| "type": "string" | |
| }, | |
| "allergyComment": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "category": { | |
| "type": "string" | |
| }, | |
| "healthConcern": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "_links": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| } | |
| }, | |
| "required": [ | |
| "enterpriseId", | |
| "practiceId", | |
| "encounterId", | |
| "personId", | |
| "snomedConceptId", | |
| "dateOnset", | |
| "dateResolved", | |
| "allergyType", | |
| "encounterTimestamp", | |
| "allergyComment", | |
| "id", | |
| "category", | |
| "healthConcern", | |
| "description", | |
| "_links" | |
| ] | |
| }, | |
| "OK8": { | |
| "title": "OK8", | |
| "example": { | |
| "Items": [ | |
| { | |
| "id": "<string>", | |
| "personId": "<string>", | |
| "encounterId": "<string>", | |
| "encounterDate": "<string>", | |
| "practiceId": "<string>", | |
| "enterpriseId": "<string>", | |
| "aip": "<string>", | |
| "aipPriority": "<string>", | |
| "description": "<string>", | |
| "diagnosisCode": "<string>", | |
| "diagnosisId": "<string>", | |
| "encounterDiagnosisPriority": "<string>", | |
| "icd9cmCodeId": "<string>", | |
| "reportDisplay": "<string>", | |
| "axis": "<string>", | |
| "chiefComplaint": "<string>", | |
| "detailType": "<string>", | |
| "detailTypePriority": "<string>", | |
| "differentialDiagnosis": "<string>", | |
| "episode": "<string>", | |
| "side": "<string>", | |
| "site": "<string>", | |
| "hasHistoryRecord": "<string>", | |
| "specifiers": "<string>", | |
| "isSupplemental": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "id": "<string>", | |
| "personId": "<string>", | |
| "encounterId": "<string>", | |
| "encounterDate": "<string>", | |
| "practiceId": "<string>", | |
| "enterpriseId": "<string>", | |
| "aip": "<string>", | |
| "aipPriority": "<string>", | |
| "description": "<string>", | |
| "diagnosisCode": "<string>", | |
| "diagnosisId": "<string>", | |
| "encounterDiagnosisPriority": "<string>", | |
| "icd9cmCodeId": "<string>", | |
| "reportDisplay": "<string>", | |
| "axis": "<string>", | |
| "chiefComplaint": "<string>", | |
| "detailType": "<string>", | |
| "detailTypePriority": "<string>", | |
| "differentialDiagnosis": "<string>", | |
| "episode": "<string>", | |
| "side": "<string>", | |
| "site": "<string>", | |
| "hasHistoryRecord": "<string>", | |
| "specifiers": "<string>", | |
| "isSupplemental": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ], | |
| "NextPageLink": "<string>", | |
| "Count": "<string>" | |
| }, | |
| "type": "object", | |
| "properties": { | |
| "Items": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Item3" | |
| } | |
| }, | |
| "NextPageLink": { | |
| "type": "string" | |
| }, | |
| "Count": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "Items", | |
| "NextPageLink", | |
| "Count" | |
| ] | |
| }, | |
| "Item3": { | |
| "title": "Item3", | |
| "example": { | |
| "id": "<string>", | |
| "personId": "<string>", | |
| "encounterId": "<string>", | |
| "encounterDate": "<string>", | |
| "practiceId": "<string>", | |
| "enterpriseId": "<string>", | |
| "aip": "<string>", | |
| "aipPriority": "<string>", | |
| "description": "<string>", | |
| "diagnosisCode": "<string>", | |
| "diagnosisId": "<string>", | |
| "encounterDiagnosisPriority": "<string>", | |
| "icd9cmCodeId": "<string>", | |
| "reportDisplay": "<string>", | |
| "axis": "<string>", | |
| "chiefComplaint": "<string>", | |
| "detailType": "<string>", | |
| "detailTypePriority": "<string>", | |
| "differentialDiagnosis": "<string>", | |
| "episode": "<string>", | |
| "side": "<string>", | |
| "site": "<string>", | |
| "hasHistoryRecord": "<string>", | |
| "specifiers": "<string>", | |
| "isSupplemental": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "personId": { | |
| "type": "string" | |
| }, | |
| "encounterId": { | |
| "type": "string" | |
| }, | |
| "encounterDate": { | |
| "type": "string" | |
| }, | |
| "practiceId": { | |
| "type": "string" | |
| }, | |
| "enterpriseId": { | |
| "type": "string" | |
| }, | |
| "aip": { | |
| "type": "string" | |
| }, | |
| "aipPriority": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "diagnosisCode": { | |
| "type": "string" | |
| }, | |
| "diagnosisId": { | |
| "type": "string" | |
| }, | |
| "encounterDiagnosisPriority": { | |
| "type": "string" | |
| }, | |
| "icd9cmCodeId": { | |
| "type": "string" | |
| }, | |
| "reportDisplay": { | |
| "type": "string" | |
| }, | |
| "axis": { | |
| "type": "string" | |
| }, | |
| "chiefComplaint": { | |
| "type": "string" | |
| }, | |
| "detailType": { | |
| "type": "string" | |
| }, | |
| "detailTypePriority": { | |
| "type": "string" | |
| }, | |
| "differentialDiagnosis": { | |
| "type": "string" | |
| }, | |
| "episode": { | |
| "type": "string" | |
| }, | |
| "side": { | |
| "type": "string" | |
| }, | |
| "site": { | |
| "type": "string" | |
| }, | |
| "hasHistoryRecord": { | |
| "type": "string" | |
| }, | |
| "specifiers": { | |
| "type": "string" | |
| }, | |
| "isSupplemental": { | |
| "type": "string" | |
| }, | |
| "_links": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| } | |
| }, | |
| "required": [ | |
| "id", | |
| "personId", | |
| "encounterId", | |
| "encounterDate", | |
| "practiceId", | |
| "enterpriseId", | |
| "aip", | |
| "aipPriority", | |
| "description", | |
| "diagnosisCode", | |
| "diagnosisId", | |
| "encounterDiagnosisPriority", | |
| "icd9cmCodeId", | |
| "reportDisplay", | |
| "axis", | |
| "chiefComplaint", | |
| "detailType", | |
| "detailTypePriority", | |
| "differentialDiagnosis", | |
| "episode", | |
| "side", | |
| "site", | |
| "hasHistoryRecord", | |
| "specifiers", | |
| "isSupplemental", | |
| "_links" | |
| ] | |
| }, | |
| "OK10": { | |
| "title": "OK10", | |
| "example": { | |
| "Items": [ | |
| { | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "personId": "<string>", | |
| "id": "<string>", | |
| "completedDate": "<string>", | |
| "instrument": "<string>", | |
| "score": "<string>", | |
| "severity": "<string>", | |
| "encounterDate": "<string>", | |
| "createTimestamp": "<string>", | |
| "healthConcern": "<string>", | |
| "category": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "personId": "<string>", | |
| "id": "<string>", | |
| "completedDate": "<string>", | |
| "instrument": "<string>", | |
| "score": "<string>", | |
| "severity": "<string>", | |
| "encounterDate": "<string>", | |
| "createTimestamp": "<string>", | |
| "healthConcern": "<string>", | |
| "category": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ], | |
| "NextPageLink": "<string>", | |
| "Count": "<string>" | |
| }, | |
| "type": "object", | |
| "properties": { | |
| "Items": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Item5" | |
| } | |
| }, | |
| "NextPageLink": { | |
| "type": "string" | |
| }, | |
| "Count": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "Items", | |
| "NextPageLink", | |
| "Count" | |
| ] | |
| }, | |
| "Item5": { | |
| "title": "Item5", | |
| "example": { | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "personId": "<string>", | |
| "id": "<string>", | |
| "completedDate": "<string>", | |
| "instrument": "<string>", | |
| "score": "<string>", | |
| "severity": "<string>", | |
| "encounterDate": "<string>", | |
| "createTimestamp": "<string>", | |
| "healthConcern": "<string>", | |
| "category": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| "type": "object", | |
| "properties": { | |
| "enterpriseId": { | |
| "type": "string" | |
| }, | |
| "practiceId": { | |
| "type": "string" | |
| }, | |
| "personId": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "completedDate": { | |
| "type": "string" | |
| }, | |
| "instrument": { | |
| "type": "string" | |
| }, | |
| "score": { | |
| "type": "string" | |
| }, | |
| "severity": { | |
| "type": "string" | |
| }, | |
| "encounterDate": { | |
| "type": "string" | |
| }, | |
| "createTimestamp": { | |
| "type": "string" | |
| }, | |
| "healthConcern": { | |
| "type": "string" | |
| }, | |
| "category": { | |
| "type": "string" | |
| }, | |
| "_links": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| } | |
| }, | |
| "required": [ | |
| "enterpriseId", | |
| "practiceId", | |
| "personId", | |
| "id", | |
| "completedDate", | |
| "instrument", | |
| "score", | |
| "severity", | |
| "encounterDate", | |
| "createTimestamp", | |
| "healthConcern", | |
| "category", | |
| "_links" | |
| ] | |
| }, | |
| "OK11": { | |
| "title": "OK11", | |
| "example": { | |
| "Items": [ | |
| { | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "personId": "<string>", | |
| "id": "<string>", | |
| "providerId": "<string>", | |
| "encounterId": "<string>", | |
| "firstName": "<string>", | |
| "lastName": "<string>", | |
| "email": "<string>", | |
| "activeDate": "<string>", | |
| "inactiveDate": "<string>", | |
| "address": "<string>", | |
| "city": "<string>", | |
| "state": "<string>", | |
| "zip": "<string>", | |
| "homePhone": "<string>", | |
| "cellPhone": "<string>", | |
| "fax": "<string>", | |
| "agencyName": "<string>", | |
| "agencyType": "<string>", | |
| "patientRelationship": "<string>", | |
| "supportRole": "<string>", | |
| "specialty": "<string>", | |
| "roleClass": "<string>", | |
| "roleCode": "<string>", | |
| "isReadOnly": "<string>", | |
| "status": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "personId": "<string>", | |
| "id": "<string>", | |
| "providerId": "<string>", | |
| "encounterId": "<string>", | |
| "firstName": "<string>", | |
| "lastName": "<string>", | |
| "email": "<string>", | |
| "activeDate": "<string>", | |
| "inactiveDate": "<string>", | |
| "address": "<string>", | |
| "city": "<string>", | |
| "state": "<string>", | |
| "zip": "<string>", | |
| "homePhone": "<string>", | |
| "cellPhone": "<string>", | |
| "fax": "<string>", | |
| "agencyName": "<string>", | |
| "agencyType": "<string>", | |
| "patientRelationship": "<string>", | |
| "supportRole": "<string>", | |
| "specialty": "<string>", | |
| "roleClass": "<string>", | |
| "roleCode": "<string>", | |
| "isReadOnly": "<string>", | |
| "status": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ], | |
| "NextPageLink": "<string>", | |
| "Count": "<string>" | |
| }, | |
| "type": "object", | |
| "properties": { | |
| "Items": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Item6" | |
| } | |
| }, | |
| "NextPageLink": { | |
| "type": "string" | |
| }, | |
| "Count": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "Items", | |
| "NextPageLink", | |
| "Count" | |
| ] | |
| }, | |
| "Item6": { | |
| "title": "Item6", | |
| "example": { | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "personId": "<string>", | |
| "id": "<string>", | |
| "providerId": "<string>", | |
| "encounterId": "<string>", | |
| "firstName": "<string>", | |
| "lastName": "<string>", | |
| "email": "<string>", | |
| "activeDate": "<string>", | |
| "inactiveDate": "<string>", | |
| "address": "<string>", | |
| "city": "<string>", | |
| "state": "<string>", | |
| "zip": "<string>", | |
| "homePhone": "<string>", | |
| "cellPhone": "<string>", | |
| "fax": "<string>", | |
| "agencyName": "<string>", | |
| "agencyType": "<string>", | |
| "patientRelationship": "<string>", | |
| "supportRole": "<string>", | |
| "specialty": "<string>", | |
| "roleClass": "<string>", | |
| "roleCode": "<string>", | |
| "isReadOnly": "<string>", | |
| "status": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| "type": "object", | |
| "properties": { | |
| "enterpriseId": { | |
| "type": "string" | |
| }, | |
| "practiceId": { | |
| "type": "string" | |
| }, | |
| "personId": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "providerId": { | |
| "type": "string" | |
| }, | |
| "encounterId": { | |
| "type": "string" | |
| }, | |
| "firstName": { | |
| "type": "string" | |
| }, | |
| "lastName": { | |
| "type": "string" | |
| }, | |
| "email": { | |
| "type": "string" | |
| }, | |
| "activeDate": { | |
| "type": "string" | |
| }, | |
| "inactiveDate": { | |
| "type": "string" | |
| }, | |
| "address": { | |
| "type": "string" | |
| }, | |
| "city": { | |
| "type": "string" | |
| }, | |
| "state": { | |
| "type": "string" | |
| }, | |
| "zip": { | |
| "type": "string" | |
| }, | |
| "homePhone": { | |
| "type": "string" | |
| }, | |
| "cellPhone": { | |
| "type": "string" | |
| }, | |
| "fax": { | |
| "type": "string" | |
| }, | |
| "agencyName": { | |
| "type": "string" | |
| }, | |
| "agencyType": { | |
| "type": "string" | |
| }, | |
| "patientRelationship": { | |
| "type": "string" | |
| }, | |
| "supportRole": { | |
| "type": "string" | |
| }, | |
| "specialty": { | |
| "type": "string" | |
| }, | |
| "roleClass": { | |
| "type": "string" | |
| }, | |
| "roleCode": { | |
| "type": "string" | |
| }, | |
| "isReadOnly": { | |
| "type": "string" | |
| }, | |
| "status": { | |
| "type": "string" | |
| }, | |
| "_links": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| } | |
| }, | |
| "required": [ | |
| "enterpriseId", | |
| "practiceId", | |
| "personId", | |
| "id", | |
| "providerId", | |
| "encounterId", | |
| "firstName", | |
| "lastName", | |
| "email", | |
| "activeDate", | |
| "inactiveDate", | |
| "address", | |
| "city", | |
| "state", | |
| "zip", | |
| "homePhone", | |
| "cellPhone", | |
| "fax", | |
| "agencyName", | |
| "agencyType", | |
| "patientRelationship", | |
| "supportRole", | |
| "specialty", | |
| "roleClass", | |
| "roleCode", | |
| "isReadOnly", | |
| "status", | |
| "_links" | |
| ] | |
| }, | |
| "{{baseUrl}}/persons/:personId/chart/care-team-members-Request": { | |
| "title": "{{baseUrl}}/persons/:personId/chart/care-team-members-Request", | |
| "example": { | |
| "providerId": "<string>", | |
| "firstName": "<string>", | |
| "lastName": "<string>", | |
| "email": "<string>", | |
| "activeDate": "<string>", | |
| "address": "<string>", | |
| "agencyName": "<string>", | |
| "agencyType": "<string>", | |
| "cellPhone": "<string>", | |
| "city": "<string>", | |
| "fax": "<string>", | |
| "homePhone": "<string>", | |
| "inactiveDate": "<string>", | |
| "patientRelationship": "<string>", | |
| "state": "<string>", | |
| "supportRole": "<string>", | |
| "zip": "<string>" | |
| }, | |
| "type": "object", | |
| "properties": { | |
| "providerId": { | |
| "type": "string" | |
| }, | |
| "firstName": { | |
| "type": "string" | |
| }, | |
| "lastName": { | |
| "type": "string" | |
| }, | |
| "email": { | |
| "type": "string" | |
| }, | |
| "activeDate": { | |
| "type": "string" | |
| }, | |
| "address": { | |
| "type": "string" | |
| }, | |
| "agencyName": { | |
| "type": "string" | |
| }, | |
| "agencyType": { | |
| "type": "string" | |
| }, | |
| "cellPhone": { | |
| "type": "string" | |
| }, | |
| "city": { | |
| "type": "string" | |
| }, | |
| "fax": { | |
| "type": "string" | |
| }, | |
| "homePhone": { | |
| "type": "string" | |
| }, | |
| "inactiveDate": { | |
| "type": "string" | |
| }, | |
| "patientRelationship": { | |
| "type": "string" | |
| }, | |
| "state": { | |
| "type": "string" | |
| }, | |
| "supportRole": { | |
| "type": "string" | |
| }, | |
| "zip": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "providerId", | |
| "firstName", | |
| "lastName", | |
| "email", | |
| "activeDate", | |
| "address", | |
| "agencyName", | |
| "agencyType", | |
| "cellPhone", | |
| "city", | |
| "fax", | |
| "homePhone", | |
| "inactiveDate", | |
| "patientRelationship", | |
| "state", | |
| "supportRole", | |
| "zip" | |
| ] | |
| }, | |
| "{{baseUrl}}/persons/:personId/chart/care-team-members/:careTeamMemberId-Request": { | |
| "title": "{{baseUrl}}/persons/:personId/chart/care-team-members/:careTeamMemberId-Request", | |
| "example": { | |
| "providerId": "<string>", | |
| "firstName": "<string>", | |
| "lastName": "<string>", | |
| "email": "<string>", | |
| "activeDate": "<string>", | |
| "address": "<string>", | |
| "agencyName": "<string>", | |
| "agencyType": "<string>", | |
| "cellPhone": "<string>", | |
| "city": "<string>", | |
| "fax": "<string>", | |
| "homePhone": "<string>", | |
| "inactiveDate": "<string>", | |
| "patientRelationship": "<string>", | |
| "state": "<string>", | |
| "supportRole": "<string>", | |
| "zip": "<string>" | |
| }, | |
| "type": "object", | |
| "properties": { | |
| "providerId": { | |
| "type": "string" | |
| }, | |
| "firstName": { | |
| "type": "string" | |
| }, | |
| "lastName": { | |
| "type": "string" | |
| }, | |
| "email": { | |
| "type": "string" | |
| }, | |
| "activeDate": { | |
| "type": "string" | |
| }, | |
| "address": { | |
| "type": "string" | |
| }, | |
| "agencyName": { | |
| "type": "string" | |
| }, | |
| "agencyType": { | |
| "type": "string" | |
| }, | |
| "cellPhone": { | |
| "type": "string" | |
| }, | |
| "city": { | |
| "type": "string" | |
| }, | |
| "fax": { | |
| "type": "string" | |
| }, | |
| "homePhone": { | |
| "type": "string" | |
| }, | |
| "inactiveDate": { | |
| "type": "string" | |
| }, | |
| "patientRelationship": { | |
| "type": "string" | |
| }, | |
| "state": { | |
| "type": "string" | |
| }, | |
| "supportRole": { | |
| "type": "string" | |
| }, | |
| "zip": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "providerId", | |
| "firstName", | |
| "lastName", | |
| "email", | |
| "activeDate", | |
| "address", | |
| "agencyName", | |
| "agencyType", | |
| "cellPhone", | |
| "city", | |
| "fax", | |
| "homePhone", | |
| "inactiveDate", | |
| "patientRelationship", | |
| "state", | |
| "supportRole", | |
| "zip" | |
| ] | |
| }, | |
| "OK12": { | |
| "title": "OK12", | |
| "example": { | |
| "id": "<string>", | |
| "personId": "<string>", | |
| "description": "<string>", | |
| "itemType": "<string>", | |
| "createTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "modifyTimestampTimezone": "<string>", | |
| "encounterId": "<string>", | |
| "isRestricted": "<string>", | |
| "signoffStatus": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "personId": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "itemType": { | |
| "type": "string" | |
| }, | |
| "createTimestamp": { | |
| "type": "string" | |
| }, | |
| "createTimestampTimezone": { | |
| "type": "string" | |
| }, | |
| "modifyTimestamp": { | |
| "type": "string" | |
| }, | |
| "modifyTimestampTimezone": { | |
| "type": "string" | |
| }, | |
| "encounterId": { | |
| "type": "string" | |
| }, | |
| "isRestricted": { | |
| "type": "string" | |
| }, | |
| "signoffStatus": { | |
| "type": "string" | |
| }, | |
| "_links": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| } | |
| }, | |
| "required": [ | |
| "id", | |
| "personId", | |
| "description", | |
| "itemType", | |
| "createTimestamp", | |
| "createTimestampTimezone", | |
| "modifyTimestamp", | |
| "modifyTimestampTimezone", | |
| "encounterId", | |
| "isRestricted", | |
| "signoffStatus", | |
| "_links" | |
| ] | |
| }, | |
| "OK15": { | |
| "title": "OK15", | |
| "example": { | |
| "id": "<string>", | |
| "personId": "<string>", | |
| "description": "<string>", | |
| "itemType": "<string>", | |
| "createTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "modifyTimestampTimezone": "<string>", | |
| "encounterId": "<string>", | |
| "categories": [ | |
| "<string>", | |
| "<string>" | |
| ], | |
| "totalPages": "<string>", | |
| "icsDateOfService": "<string>", | |
| "encounterTimestamp": "<string>", | |
| "appCreatedBy": "<string>", | |
| "docTypeId": "<string>", | |
| "isRestricted": "<string>", | |
| "signoffStatus": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "personId": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "itemType": { | |
| "type": "string" | |
| }, | |
| "createTimestamp": { | |
| "type": "string" | |
| }, | |
| "createTimestampTimezone": { | |
| "type": "string" | |
| }, | |
| "modifyTimestamp": { | |
| "type": "string" | |
| }, | |
| "modifyTimestampTimezone": { | |
| "type": "string" | |
| }, | |
| "encounterId": { | |
| "type": "string" | |
| }, | |
| "categories": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "totalPages": { | |
| "type": "string" | |
| }, | |
| "icsDateOfService": { | |
| "type": "string" | |
| }, | |
| "encounterTimestamp": { | |
| "type": "string" | |
| }, | |
| "appCreatedBy": { | |
| "type": "string" | |
| }, | |
| "docTypeId": { | |
| "type": "string" | |
| }, | |
| "isRestricted": { | |
| "type": "string" | |
| }, | |
| "signoffStatus": { | |
| "type": "string" | |
| }, | |
| "_links": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| } | |
| }, | |
| "required": [ | |
| "id", | |
| "personId", | |
| "description", | |
| "itemType", | |
| "createTimestamp", | |
| "createTimestampTimezone", | |
| "modifyTimestamp", | |
| "modifyTimestampTimezone", | |
| "encounterId", | |
| "categories", | |
| "totalPages", | |
| "icsDateOfService", | |
| "encounterTimestamp", | |
| "appCreatedBy", | |
| "docTypeId", | |
| "isRestricted", | |
| "signoffStatus", | |
| "_links" | |
| ] | |
| }, | |
| "OK16": { | |
| "title": "OK16", | |
| "example": { | |
| "FileBytes": "<string>", | |
| "FileName": "<string>", | |
| "MimeType": "<string>" | |
| }, | |
| "type": "object", | |
| "properties": { | |
| "FileBytes": { | |
| "type": "string" | |
| }, | |
| "FileName": { | |
| "type": "string" | |
| }, | |
| "MimeType": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "FileBytes", | |
| "FileName", | |
| "MimeType" | |
| ] | |
| }, | |
| "OK17": { | |
| "title": "OK17", | |
| "example": { | |
| "Items": [ | |
| { | |
| "goalId": "<string>", | |
| "personId": "<string>", | |
| "encounterId": "<string>", | |
| "healthConcernId": "<string>", | |
| "codeDescription": "<string>", | |
| "codeSystem": "<string>", | |
| "codeValue": "<string>", | |
| "comments": "<string>", | |
| "isDeleted": "<string>", | |
| "description": "<string>", | |
| "isGoalAchieved": "<string>", | |
| "goalAchievedDetails": "<string>", | |
| "goalCompletionDate": "<string>", | |
| "goalStartDate": "<string>", | |
| "isPatientGoal": "<string>", | |
| "patientPriority": "<string>", | |
| "isProviderGoal": "<string>", | |
| "providerPriority": "<string>", | |
| "documentedBy": "<string>", | |
| "encounterDate": "<string>", | |
| "sequenceNumber": "<string>", | |
| "createdBy": "<string>", | |
| "createTimestamp": "<string>", | |
| "modifiedBy": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "modifyTimestampTimezone": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "goalId": "<string>", | |
| "personId": "<string>", | |
| "encounterId": "<string>", | |
| "healthConcernId": "<string>", | |
| "codeDescription": "<string>", | |
| "codeSystem": "<string>", | |
| "codeValue": "<string>", | |
| "comments": "<string>", | |
| "isDeleted": "<string>", | |
| "description": "<string>", | |
| "isGoalAchieved": "<string>", | |
| "goalAchievedDetails": "<string>", | |
| "goalCompletionDate": "<string>", | |
| "goalStartDate": "<string>", | |
| "isPatientGoal": "<string>", | |
| "patientPriority": "<string>", | |
| "isProviderGoal": "<string>", | |
| "providerPriority": "<string>", | |
| "documentedBy": "<string>", | |
| "encounterDate": "<string>", | |
| "sequenceNumber": "<string>", | |
| "createdBy": "<string>", | |
| "createTimestamp": "<string>", | |
| "modifiedBy": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "modifyTimestampTimezone": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ], | |
| "NextPageLink": "<string>", | |
| "Count": "<string>" | |
| }, | |
| "type": "object", | |
| "properties": { | |
| "Items": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Item7" | |
| } | |
| }, | |
| "NextPageLink": { | |
| "type": "string" | |
| }, | |
| "Count": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "Items", | |
| "NextPageLink", | |
| "Count" | |
| ] | |
| }, | |
| "Item7": { | |
| "title": "Item7", | |
| "example": { | |
| "goalId": "<string>", | |
| "personId": "<string>", | |
| "encounterId": "<string>", | |
| "healthConcernId": "<string>", | |
| "codeDescription": "<string>", | |
| "codeSystem": "<string>", | |
| "codeValue": "<string>", | |
| "comments": "<string>", | |
| "isDeleted": "<string>", | |
| "description": "<string>", | |
| "isGoalAchieved": "<string>", | |
| "goalAchievedDetails": "<string>", | |
| "goalCompletionDate": "<string>", | |
| "goalStartDate": "<string>", | |
| "isPatientGoal": "<string>", | |
| "patientPriority": "<string>", | |
| "isProviderGoal": "<string>", | |
| "providerPriority": "<string>", | |
| "documentedBy": "<string>", | |
| "encounterDate": "<string>", | |
| "sequenceNumber": "<string>", | |
| "createdBy": "<string>", | |
| "createTimestamp": "<string>", | |
| "modifiedBy": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "modifyTimestampTimezone": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| "type": "object", | |
| "properties": { | |
| "goalId": { | |
| "type": "string" | |
| }, | |
| "personId": { | |
| "type": "string" | |
| }, | |
| "encounterId": { | |
| "type": "string" | |
| }, | |
| "healthConcernId": { | |
| "type": "string" | |
| }, | |
| "codeDescription": { | |
| "type": "string" | |
| }, | |
| "codeSystem": { | |
| "type": "string" | |
| }, | |
| "codeValue": { | |
| "type": "string" | |
| }, | |
| "comments": { | |
| "type": "string" | |
| }, | |
| "isDeleted": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "isGoalAchieved": { | |
| "type": "string" | |
| }, | |
| "goalAchievedDetails": { | |
| "type": "string" | |
| }, | |
| "goalCompletionDate": { | |
| "type": "string" | |
| }, | |
| "goalStartDate": { | |
| "type": "string" | |
| }, | |
| "isPatientGoal": { | |
| "type": "string" | |
| }, | |
| "patientPriority": { | |
| "type": "string" | |
| }, | |
| "isProviderGoal": { | |
| "type": "string" | |
| }, | |
| "providerPriority": { | |
| "type": "string" | |
| }, | |
| "documentedBy": { | |
| "type": "string" | |
| }, | |
| "encounterDate": { | |
| "type": "string" | |
| }, | |
| "sequenceNumber": { | |
| "type": "string" | |
| }, | |
| "createdBy": { | |
| "type": "string" | |
| }, | |
| "createTimestamp": { | |
| "type": "string" | |
| }, | |
| "modifiedBy": { | |
| "type": "string" | |
| }, | |
| "modifyTimestamp": { | |
| "type": "string" | |
| }, | |
| "createTimestampTimezone": { | |
| "type": "string" | |
| }, | |
| "modifyTimestampTimezone": { | |
| "type": "string" | |
| }, | |
| "_links": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| } | |
| }, | |
| "required": [ | |
| "goalId", | |
| "personId", | |
| "encounterId", | |
| "healthConcernId", | |
| "codeDescription", | |
| "codeSystem", | |
| "codeValue", | |
| "comments", | |
| "isDeleted", | |
| "description", | |
| "isGoalAchieved", | |
| "goalAchievedDetails", | |
| "goalCompletionDate", | |
| "goalStartDate", | |
| "isPatientGoal", | |
| "patientPriority", | |
| "isProviderGoal", | |
| "providerPriority", | |
| "documentedBy", | |
| "encounterDate", | |
| "sequenceNumber", | |
| "createdBy", | |
| "createTimestamp", | |
| "modifiedBy", | |
| "modifyTimestamp", | |
| "createTimestampTimezone", | |
| "modifyTimestampTimezone", | |
| "_links" | |
| ] | |
| }, | |
| "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId/goals-Request": { | |
| "title": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId/goals-Request", | |
| "example": { | |
| "codeDescription": "<string>", | |
| "codeSystem": "<string>", | |
| "codeValue": "<string>", | |
| "comments": "<string>", | |
| "description": "<string>", | |
| "isGoalAchieved": "<string>", | |
| "goalAchievedDetails": "<string>", | |
| "goalCompletionDate": "<string>", | |
| "goalStartDate": "<string>", | |
| "isPatientGoal": "<string>", | |
| "patientPriority": "<string>", | |
| "isProviderGoal": "<string>", | |
| "providerPriority": "<string>" | |
| }, | |
| "type": "object", | |
| "properties": { | |
| "codeDescription": { | |
| "type": "string" | |
| }, | |
| "codeSystem": { | |
| "type": "string" | |
| }, | |
| "codeValue": { | |
| "type": "string" | |
| }, | |
| "comments": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "isGoalAchieved": { | |
| "type": "string" | |
| }, | |
| "goalAchievedDetails": { | |
| "type": "string" | |
| }, | |
| "goalCompletionDate": { | |
| "type": "string" | |
| }, | |
| "goalStartDate": { | |
| "type": "string" | |
| }, | |
| "isPatientGoal": { | |
| "type": "string" | |
| }, | |
| "patientPriority": { | |
| "type": "string" | |
| }, | |
| "isProviderGoal": { | |
| "type": "string" | |
| }, | |
| "providerPriority": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "codeDescription", | |
| "codeSystem", | |
| "codeValue", | |
| "comments", | |
| "description", | |
| "isGoalAchieved", | |
| "goalAchievedDetails", | |
| "goalCompletionDate", | |
| "goalStartDate", | |
| "isPatientGoal", | |
| "patientPriority", | |
| "isProviderGoal", | |
| "providerPriority" | |
| ] | |
| }, | |
| "OK19": { | |
| "title": "OK19", | |
| "example": { | |
| "goalId": "<string>", | |
| "personId": "<string>", | |
| "encounterId": "<string>", | |
| "healthConcernId": "<string>", | |
| "codeDescription": "<string>", | |
| "codeSystem": "<string>", | |
| "codeValue": "<string>", | |
| "comments": "<string>", | |
| "isDeleted": "<string>", | |
| "description": "<string>", | |
| "isGoalAchieved": "<string>", | |
| "goalAchievedDetails": "<string>", | |
| "goalCompletionDate": "<string>", | |
| "goalStartDate": "<string>", | |
| "isPatientGoal": "<string>", | |
| "patientPriority": "<string>", | |
| "isProviderGoal": "<string>", | |
| "providerPriority": "<string>", | |
| "documentedBy": "<string>", | |
| "encounterDate": "<string>", | |
| "sequenceNumber": "<string>", | |
| "createdBy": "<string>", | |
| "createTimestamp": "<string>", | |
| "modifiedBy": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "modifyTimestampTimezone": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| "type": "object", | |
| "properties": { | |
| "goalId": { | |
| "type": "string" | |
| }, | |
| "personId": { | |
| "type": "string" | |
| }, | |
| "encounterId": { | |
| "type": "string" | |
| }, | |
| "healthConcernId": { | |
| "type": "string" | |
| }, | |
| "codeDescription": { | |
| "type": "string" | |
| }, | |
| "codeSystem": { | |
| "type": "string" | |
| }, | |
| "codeValue": { | |
| "type": "string" | |
| }, | |
| "comments": { | |
| "type": "string" | |
| }, | |
| "isDeleted": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "isGoalAchieved": { | |
| "type": "string" | |
| }, | |
| "goalAchievedDetails": { | |
| "type": "string" | |
| }, | |
| "goalCompletionDate": { | |
| "type": "string" | |
| }, | |
| "goalStartDate": { | |
| "type": "string" | |
| }, | |
| "isPatientGoal": { | |
| "type": "string" | |
| }, | |
| "patientPriority": { | |
| "type": "string" | |
| }, | |
| "isProviderGoal": { | |
| "type": "string" | |
| }, | |
| "providerPriority": { | |
| "type": "string" | |
| }, | |
| "documentedBy": { | |
| "type": "string" | |
| }, | |
| "encounterDate": { | |
| "type": "string" | |
| }, | |
| "sequenceNumber": { | |
| "type": "string" | |
| }, | |
| "createdBy": { | |
| "type": "string" | |
| }, | |
| "createTimestamp": { | |
| "type": "string" | |
| }, | |
| "modifiedBy": { | |
| "type": "string" | |
| }, | |
| "modifyTimestamp": { | |
| "type": "string" | |
| }, | |
| "createTimestampTimezone": { | |
| "type": "string" | |
| }, | |
| "modifyTimestampTimezone": { | |
| "type": "string" | |
| }, | |
| "_links": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| } | |
| }, | |
| "required": [ | |
| "goalId", | |
| "personId", | |
| "encounterId", | |
| "healthConcernId", | |
| "codeDescription", | |
| "codeSystem", | |
| "codeValue", | |
| "comments", | |
| "isDeleted", | |
| "description", | |
| "isGoalAchieved", | |
| "goalAchievedDetails", | |
| "goalCompletionDate", | |
| "goalStartDate", | |
| "isPatientGoal", | |
| "patientPriority", | |
| "isProviderGoal", | |
| "providerPriority", | |
| "documentedBy", | |
| "encounterDate", | |
| "sequenceNumber", | |
| "createdBy", | |
| "createTimestamp", | |
| "modifiedBy", | |
| "modifyTimestamp", | |
| "createTimestampTimezone", | |
| "modifyTimestampTimezone", | |
| "_links" | |
| ] | |
| }, | |
| "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId/goals/:goalId-Request": { | |
| "title": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId/goals/:goalId-Request", | |
| "example": { | |
| "codeDescription": "<string>", | |
| "codeSystem": "<string>", | |
| "codeValue": "<string>", | |
| "comments": "<string>", | |
| "description": "<string>", | |
| "isGoalAchieved": "<string>", | |
| "goalAchievedDetails": "<string>", | |
| "goalCompletionDate": "<string>", | |
| "goalStartDate": "<string>", | |
| "isPatientGoal": "<string>", | |
| "patientPriority": "<string>", | |
| "isProviderGoal": "<string>", | |
| "providerPriority": "<string>" | |
| }, | |
| "type": "object", | |
| "properties": { | |
| "codeDescription": { | |
| "type": "string" | |
| }, | |
| "codeSystem": { | |
| "type": "string" | |
| }, | |
| "codeValue": { | |
| "type": "string" | |
| }, | |
| "comments": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "isGoalAchieved": { | |
| "type": "string" | |
| }, | |
| "goalAchievedDetails": { | |
| "type": "string" | |
| }, | |
| "goalCompletionDate": { | |
| "type": "string" | |
| }, | |
| "goalStartDate": { | |
| "type": "string" | |
| }, | |
| "isPatientGoal": { | |
| "type": "string" | |
| }, | |
| "patientPriority": { | |
| "type": "string" | |
| }, | |
| "isProviderGoal": { | |
| "type": "string" | |
| }, | |
| "providerPriority": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "codeDescription", | |
| "codeSystem", | |
| "codeValue", | |
| "comments", | |
| "description", | |
| "isGoalAchieved", | |
| "goalAchievedDetails", | |
| "goalCompletionDate", | |
| "goalStartDate", | |
| "isPatientGoal", | |
| "patientPriority", | |
| "isProviderGoal", | |
| "providerPriority" | |
| ] | |
| }, | |
| "OK20": { | |
| "title": "OK20", | |
| "example": { | |
| "Items": [ | |
| { | |
| "id": "<string>", | |
| "healthConcernId": "<string>", | |
| "goalId": "<string>", | |
| "detail": "<string>", | |
| "category": "<string>", | |
| "frequency": "<string>", | |
| "progress": "<string>", | |
| "reviewDate": "<string>", | |
| "startDate": "<string>", | |
| "status": "<string>", | |
| "codeDescription": "<string>", | |
| "codeSystem": "<string>", | |
| "codeValue": "<string>", | |
| "isDeleted": "<string>", | |
| "personId": "<string>", | |
| "encounterId": "<string>", | |
| "createdBy": "<string>", | |
| "createTimestamp": "<string>", | |
| "modifiedBy": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "modifyTimestampTimezone": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "id": "<string>", | |
| "healthConcernId": "<string>", | |
| "goalId": "<string>", | |
| "detail": "<string>", | |
| "category": "<string>", | |
| "frequency": "<string>", | |
| "progress": "<string>", | |
| "reviewDate": "<string>", | |
| "startDate": "<string>", | |
| "status": "<string>", | |
| "codeDescription": "<string>", | |
| "codeSystem": "<string>", | |
| "codeValue": "<string>", | |
| "isDeleted": "<string>", | |
| "personId": "<string>", | |
| "encounterId": "<string>", | |
| "createdBy": "<string>", | |
| "createTimestamp": "<string>", | |
| "modifiedBy": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "modifyTimestampTimezone": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ], | |
| "NextPageLink": "<string>", | |
| "Count": "<string>" | |
| }, | |
| "type": "object", | |
| "properties": { | |
| "Items": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Item9" | |
| } | |
| }, | |
| "NextPageLink": { | |
| "type": "string" | |
| }, | |
| "Count": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "Items", | |
| "NextPageLink", | |
| "Count" | |
| ] | |
| }, | |
| "Item9": { | |
| "title": "Item9", | |
| "example": { | |
| "id": "<string>", | |
| "healthConcernId": "<string>", | |
| "goalId": "<string>", | |
| "detail": "<string>", | |
| "category": "<string>", | |
| "frequency": "<string>", | |
| "progress": "<string>", | |
| "reviewDate": "<string>", | |
| "startDate": "<string>", | |
| "status": "<string>", | |
| "codeDescription": "<string>", | |
| "codeSystem": "<string>", | |
| "codeValue": "<string>", | |
| "isDeleted": "<string>", | |
| "personId": "<string>", | |
| "encounterId": "<string>", | |
| "createdBy": "<string>", | |
| "createTimestamp": "<string>", | |
| "modifiedBy": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "modifyTimestampTimezone": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "healthConcernId": { | |
| "type": "string" | |
| }, | |
| "goalId": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| }, | |
| "category": { | |
| "type": "string" | |
| }, | |
| "frequency": { | |
| "type": "string" | |
| }, | |
| "progress": { | |
| "type": "string" | |
| }, | |
| "reviewDate": { | |
| "type": "string" | |
| }, | |
| "startDate": { | |
| "type": "string" | |
| }, | |
| "status": { | |
| "type": "string" | |
| }, | |
| "codeDescription": { | |
| "type": "string" | |
| }, | |
| "codeSystem": { | |
| "type": "string" | |
| }, | |
| "codeValue": { | |
| "type": "string" | |
| }, | |
| "isDeleted": { | |
| "type": "string" | |
| }, | |
| "personId": { | |
| "type": "string" | |
| }, | |
| "encounterId": { | |
| "type": "string" | |
| }, | |
| "createdBy": { | |
| "type": "string" | |
| }, | |
| "createTimestamp": { | |
| "type": "string" | |
| }, | |
| "modifiedBy": { | |
| "type": "string" | |
| }, | |
| "modifyTimestamp": { | |
| "type": "string" | |
| }, | |
| "createTimestampTimezone": { | |
| "type": "string" | |
| }, | |
| "modifyTimestampTimezone": { | |
| "type": "string" | |
| }, | |
| "_links": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| } | |
| }, | |
| "required": [ | |
| "id", | |
| "healthConcernId", | |
| "goalId", | |
| "detail", | |
| "category", | |
| "frequency", | |
| "progress", | |
| "reviewDate", | |
| "startDate", | |
| "status", | |
| "codeDescription", | |
| "codeSystem", | |
| "codeValue", | |
| "isDeleted", | |
| "personId", | |
| "encounterId", | |
| "createdBy", | |
| "createTimestamp", | |
| "modifiedBy", | |
| "modifyTimestamp", | |
| "createTimestampTimezone", | |
| "modifyTimestampTimezone", | |
| "_links" | |
| ] | |
| }, | |
| "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId/goals/:goalId/interventions-Request": { | |
| "title": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId/goals/:goalId/interventions-Request", | |
| "example": { | |
| "name": "<string>", | |
| "category": "<string>", | |
| "categoryId": "<string>", | |
| "status": "<string>", | |
| "startDate": "<string>", | |
| "frequency": "<string>", | |
| "nextReviewDate": "<string>", | |
| "interventionProgress": "<string>", | |
| "codeSystem": "<string>", | |
| "codeValue": "<string>", | |
| "codeDescription": "<string>" | |
| }, | |
| "type": "object", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "category": { | |
| "type": "string" | |
| }, | |
| "categoryId": { | |
| "type": "string" | |
| }, | |
| "status": { | |
| "type": "string" | |
| }, | |
| "startDate": { | |
| "type": "string" | |
| }, | |
| "frequency": { | |
| "type": "string" | |
| }, | |
| "nextReviewDate": { | |
| "type": "string" | |
| }, | |
| "interventionProgress": { | |
| "type": "string" | |
| }, | |
| "codeSystem": { | |
| "type": "string" | |
| }, | |
| "codeValue": { | |
| "type": "string" | |
| }, | |
| "codeDescription": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "name", | |
| "category", | |
| "categoryId", | |
| "status", | |
| "startDate", | |
| "frequency", | |
| "nextReviewDate", | |
| "interventionProgress", | |
| "codeSystem", | |
| "codeValue", | |
| "codeDescription" | |
| ] | |
| }, | |
| "OK21": { | |
| "title": "OK21", | |
| "example": { | |
| "id": "<string>", | |
| "healthConcernId": "<string>", | |
| "goalId": "<string>", | |
| "detail": "<string>", | |
| "category": "<string>", | |
| "frequency": "<string>", | |
| "progress": "<string>", | |
| "reviewDate": "<string>", | |
| "startDate": "<string>", | |
| "status": "<string>", | |
| "codeDescription": "<string>", | |
| "codeSystem": "<string>", | |
| "codeValue": "<string>", | |
| "isDeleted": "<string>", | |
| "personId": "<string>", | |
| "encounterId": "<string>", | |
| "createdBy": "<string>", | |
| "createTimestamp": "<string>", | |
| "modifiedBy": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "createTimestampTimezone": "<string>", | |
| "modifyTimestampTimezone": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "healthConcernId": { | |
| "type": "string" | |
| }, | |
| "goalId": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| }, | |
| "category": { | |
| "type": "string" | |
| }, | |
| "frequency": { | |
| "type": "string" | |
| }, | |
| "progress": { | |
| "type": "string" | |
| }, | |
| "reviewDate": { | |
| "type": "string" | |
| }, | |
| "startDate": { | |
| "type": "string" | |
| }, | |
| "status": { | |
| "type": "string" | |
| }, | |
| "codeDescription": { | |
| "type": "string" | |
| }, | |
| "codeSystem": { | |
| "type": "string" | |
| }, | |
| "codeValue": { | |
| "type": "string" | |
| }, | |
| "isDeleted": { | |
| "type": "string" | |
| }, | |
| "personId": { | |
| "type": "string" | |
| }, | |
| "encounterId": { | |
| "type": "string" | |
| }, | |
| "createdBy": { | |
| "type": "string" | |
| }, | |
| "createTimestamp": { | |
| "type": "string" | |
| }, | |
| "modifiedBy": { | |
| "type": "string" | |
| }, | |
| "modifyTimestamp": { | |
| "type": "string" | |
| }, | |
| "createTimestampTimezone": { | |
| "type": "string" | |
| }, | |
| "modifyTimestampTimezone": { | |
| "type": "string" | |
| }, | |
| "_links": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| } | |
| }, | |
| "required": [ | |
| "id", | |
| "healthConcernId", | |
| "goalId", | |
| "detail", | |
| "category", | |
| "frequency", | |
| "progress", | |
| "reviewDate", | |
| "startDate", | |
| "status", | |
| "codeDescription", | |
| "codeSystem", | |
| "codeValue", | |
| "isDeleted", | |
| "personId", | |
| "encounterId", | |
| "createdBy", | |
| "createTimestamp", | |
| "modifiedBy", | |
| "modifyTimestamp", | |
| "createTimestampTimezone", | |
| "modifyTimestampTimezone", | |
| "_links" | |
| ] | |
| }, | |
| "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId/goals/:goalId/interventions/:interventionId-Request": { | |
| "title": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId/goals/:goalId/interventions/:interventionId-Request", | |
| "example": { | |
| "name": "<string>", | |
| "category": "<string>", | |
| "categoryId": "<string>", | |
| "status": "<string>", | |
| "startDate": "<string>", | |
| "frequency": "<string>", | |
| "nextReviewDate": "<string>", | |
| "interventionProgress": "<string>", | |
| "codeSystem": "<string>", | |
| "codeValue": "<string>", | |
| "codeDescription": "<string>" | |
| }, | |
| "type": "object", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "category": { | |
| "type": "string" | |
| }, | |
| "categoryId": { | |
| "type": "string" | |
| }, | |
| "status": { | |
| "type": "string" | |
| }, | |
| "startDate": { | |
| "type": "string" | |
| }, | |
| "frequency": { | |
| "type": "string" | |
| }, | |
| "nextReviewDate": { | |
| "type": "string" | |
| }, | |
| "interventionProgress": { | |
| "type": "string" | |
| }, | |
| "codeSystem": { | |
| "type": "string" | |
| }, | |
| "codeValue": { | |
| "type": "string" | |
| }, | |
| "codeDescription": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "name", | |
| "category", | |
| "categoryId", | |
| "status", | |
| "startDate", | |
| "frequency", | |
| "nextReviewDate", | |
| "interventionProgress", | |
| "codeSystem", | |
| "codeValue", | |
| "codeDescription" | |
| ] | |
| }, | |
| "OK22": { | |
| "title": "OK22", | |
| "example": { | |
| "Items": [ | |
| { | |
| "personId": "<string>", | |
| "encounterId": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "isDeleted": "<string>", | |
| "goalAchieved": "<string>", | |
| "goalAchievedDetails": "<string>", | |
| "goalId": "<string>", | |
| "healthConcernId": "<string>", | |
| "interventionId": "<string>", | |
| "description": "<string>", | |
| "outcomeDate": "<string>", | |
| "OutcomeId": "<string>", | |
| "createdBy": "<string>", | |
| "createTimestamp": "<string>", | |
| "createTimestampTimeZone": "<string>", | |
| "modifiedBy": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "modifyTimestampTimeZone": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "personId": "<string>", | |
| "encounterId": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "isDeleted": "<string>", | |
| "goalAchieved": "<string>", | |
| "goalAchievedDetails": "<string>", | |
| "goalId": "<string>", | |
| "healthConcernId": "<string>", | |
| "interventionId": "<string>", | |
| "description": "<string>", | |
| "outcomeDate": "<string>", | |
| "OutcomeId": "<string>", | |
| "createdBy": "<string>", | |
| "createTimestamp": "<string>", | |
| "createTimestampTimeZone": "<string>", | |
| "modifiedBy": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "modifyTimestampTimeZone": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ], | |
| "NextPageLink": "<string>", | |
| "Count": "<string>" | |
| }, | |
| "type": "object", | |
| "properties": { | |
| "Items": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Item10" | |
| } | |
| }, | |
| "NextPageLink": { | |
| "type": "string" | |
| }, | |
| "Count": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "Items", | |
| "NextPageLink", | |
| "Count" | |
| ] | |
| }, | |
| "Item10": { | |
| "title": "Item10", | |
| "example": { | |
| "personId": "<string>", | |
| "encounterId": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "isDeleted": "<string>", | |
| "goalAchieved": "<string>", | |
| "goalAchievedDetails": "<string>", | |
| "goalId": "<string>", | |
| "healthConcernId": "<string>", | |
| "interventionId": "<string>", | |
| "description": "<string>", | |
| "outcomeDate": "<string>", | |
| "OutcomeId": "<string>", | |
| "createdBy": "<string>", | |
| "createTimestamp": "<string>", | |
| "createTimestampTimeZone": "<string>", | |
| "modifiedBy": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "modifyTimestampTimeZone": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| "type": "object", | |
| "properties": { | |
| "personId": { | |
| "type": "string" | |
| }, | |
| "encounterId": { | |
| "type": "string" | |
| }, | |
| "enterpriseId": { | |
| "type": "string" | |
| }, | |
| "practiceId": { | |
| "type": "string" | |
| }, | |
| "isDeleted": { | |
| "type": "string" | |
| }, | |
| "goalAchieved": { | |
| "type": "string" | |
| }, | |
| "goalAchievedDetails": { | |
| "type": "string" | |
| }, | |
| "goalId": { | |
| "type": "string" | |
| }, | |
| "healthConcernId": { | |
| "type": "string" | |
| }, | |
| "interventionId": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "outcomeDate": { | |
| "type": "string" | |
| }, | |
| "OutcomeId": { | |
| "type": "string" | |
| }, | |
| "createdBy": { | |
| "type": "string" | |
| }, | |
| "createTimestamp": { | |
| "type": "string" | |
| }, | |
| "createTimestampTimeZone": { | |
| "type": "string" | |
| }, | |
| "modifiedBy": { | |
| "type": "string" | |
| }, | |
| "modifyTimestamp": { | |
| "type": "string" | |
| }, | |
| "modifyTimestampTimeZone": { | |
| "type": "string" | |
| }, | |
| "_links": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| } | |
| }, | |
| "required": [ | |
| "personId", | |
| "encounterId", | |
| "enterpriseId", | |
| "practiceId", | |
| "isDeleted", | |
| "goalAchieved", | |
| "goalAchievedDetails", | |
| "goalId", | |
| "healthConcernId", | |
| "interventionId", | |
| "description", | |
| "outcomeDate", | |
| "OutcomeId", | |
| "createdBy", | |
| "createTimestamp", | |
| "createTimestampTimeZone", | |
| "modifiedBy", | |
| "modifyTimestamp", | |
| "modifyTimestampTimeZone", | |
| "_links" | |
| ] | |
| }, | |
| "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId/goals/:goalId/interventions/:interventionId/outcomes-Request": { | |
| "title": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId/goals/:goalId/interventions/:interventionId/outcomes-Request", | |
| "example": { | |
| "outcome": "<string>", | |
| "goalAchieved": "<string>", | |
| "goalAchievedDetails": "<string>", | |
| "outcomeDate": "<string>" | |
| }, | |
| "type": "object", | |
| "properties": { | |
| "outcome": { | |
| "type": "string" | |
| }, | |
| "goalAchieved": { | |
| "type": "string" | |
| }, | |
| "goalAchievedDetails": { | |
| "type": "string" | |
| }, | |
| "outcomeDate": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "outcome", | |
| "goalAchieved", | |
| "goalAchievedDetails", | |
| "outcomeDate" | |
| ] | |
| }, | |
| "OK23": { | |
| "title": "OK23", | |
| "example": { | |
| "personId": "<string>", | |
| "encounterId": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "isDeleted": "<string>", | |
| "goalAchieved": "<string>", | |
| "goalAchievedDetails": "<string>", | |
| "goalId": "<string>", | |
| "healthConcernId": "<string>", | |
| "interventionId": "<string>", | |
| "description": "<string>", | |
| "outcomeDate": "<string>", | |
| "OutcomeId": "<string>", | |
| "createdBy": "<string>", | |
| "createTimestamp": "<string>", | |
| "createTimestampTimeZone": "<string>", | |
| "modifiedBy": "<string>", | |
| "modifyTimestamp": "<string>", | |
| "modifyTimestampTimeZone": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| "type": "object", | |
| "properties": { | |
| "personId": { | |
| "type": "string" | |
| }, | |
| "encounterId": { | |
| "type": "string" | |
| }, | |
| "enterpriseId": { | |
| "type": "string" | |
| }, | |
| "practiceId": { | |
| "type": "string" | |
| }, | |
| "isDeleted": { | |
| "type": "string" | |
| }, | |
| "goalAchieved": { | |
| "type": "string" | |
| }, | |
| "goalAchievedDetails": { | |
| "type": "string" | |
| }, | |
| "goalId": { | |
| "type": "string" | |
| }, | |
| "healthConcernId": { | |
| "type": "string" | |
| }, | |
| "interventionId": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "outcomeDate": { | |
| "type": "string" | |
| }, | |
| "OutcomeId": { | |
| "type": "string" | |
| }, | |
| "createdBy": { | |
| "type": "string" | |
| }, | |
| "createTimestamp": { | |
| "type": "string" | |
| }, | |
| "createTimestampTimeZone": { | |
| "type": "string" | |
| }, | |
| "modifiedBy": { | |
| "type": "string" | |
| }, | |
| "modifyTimestamp": { | |
| "type": "string" | |
| }, | |
| "modifyTimestampTimeZone": { | |
| "type": "string" | |
| }, | |
| "_links": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| } | |
| }, | |
| "required": [ | |
| "personId", | |
| "encounterId", | |
| "enterpriseId", | |
| "practiceId", | |
| "isDeleted", | |
| "goalAchieved", | |
| "goalAchievedDetails", | |
| "goalId", | |
| "healthConcernId", | |
| "interventionId", | |
| "description", | |
| "outcomeDate", | |
| "OutcomeId", | |
| "createdBy", | |
| "createTimestamp", | |
| "createTimestampTimeZone", | |
| "modifiedBy", | |
| "modifyTimestamp", | |
| "modifyTimestampTimeZone", | |
| "_links" | |
| ] | |
| }, | |
| "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId/goals/:goalId/interventions/:interventionId/outcomes/:outcomeId-Request": { | |
| "title": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId/goals/:goalId/interventions/:interventionId/outcomes/:outcomeId-Request", | |
| "example": { | |
| "outcome": "<string>", | |
| "goalAchieved": "<string>", | |
| "goalAchievedDetails": "<string>", | |
| "outcomeDate": "<string>" | |
| }, | |
| "type": "object", | |
| "properties": { | |
| "outcome": { | |
| "type": "string" | |
| }, | |
| "goalAchieved": { | |
| "type": "string" | |
| }, | |
| "goalAchievedDetails": { | |
| "type": "string" | |
| }, | |
| "outcomeDate": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "outcome", | |
| "goalAchieved", | |
| "goalAchievedDetails", | |
| "outcomeDate" | |
| ] | |
| }, | |
| "OK24": { | |
| "title": "OK24", | |
| "example": { | |
| "Items": [ | |
| { | |
| "encounterId": "<string>", | |
| "personId": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "category": "<string>", | |
| "comments": "<string>", | |
| "description": "<string>", | |
| "id": "<string>", | |
| "childRecordExists": "<string>", | |
| "isDeleted": "<string>", | |
| "secondaryTo": "<string>", | |
| "identifiedDate": "<string>", | |
| "resolvedDate": "<string>", | |
| "codeDescription": "<string>", | |
| "codeSystem": "<string>", | |
| "codeValue": "<string>", | |
| "status": "<string>", | |
| "sequenceNumber": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| { | |
| "encounterId": "<string>", | |
| "personId": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "category": "<string>", | |
| "comments": "<string>", | |
| "description": "<string>", | |
| "id": "<string>", | |
| "childRecordExists": "<string>", | |
| "isDeleted": "<string>", | |
| "secondaryTo": "<string>", | |
| "identifiedDate": "<string>", | |
| "resolvedDate": "<string>", | |
| "codeDescription": "<string>", | |
| "codeSystem": "<string>", | |
| "codeValue": "<string>", | |
| "status": "<string>", | |
| "sequenceNumber": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| } | |
| ], | |
| "NextPageLink": "<string>", | |
| "Count": "<string>" | |
| }, | |
| "type": "object", | |
| "properties": { | |
| "Items": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Item11" | |
| } | |
| }, | |
| "NextPageLink": { | |
| "type": "string" | |
| }, | |
| "Count": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "Items", | |
| "NextPageLink", | |
| "Count" | |
| ] | |
| }, | |
| "Item11": { | |
| "title": "Item11", | |
| "example": { | |
| "encounterId": "<string>", | |
| "personId": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "category": "<string>", | |
| "comments": "<string>", | |
| "description": "<string>", | |
| "id": "<string>", | |
| "childRecordExists": "<string>", | |
| "isDeleted": "<string>", | |
| "secondaryTo": "<string>", | |
| "identifiedDate": "<string>", | |
| "resolvedDate": "<string>", | |
| "codeDescription": "<string>", | |
| "codeSystem": "<string>", | |
| "codeValue": "<string>", | |
| "status": "<string>", | |
| "sequenceNumber": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| "type": "object", | |
| "properties": { | |
| "encounterId": { | |
| "type": "string" | |
| }, | |
| "personId": { | |
| "type": "string" | |
| }, | |
| "enterpriseId": { | |
| "type": "string" | |
| }, | |
| "practiceId": { | |
| "type": "string" | |
| }, | |
| "category": { | |
| "type": "string" | |
| }, | |
| "comments": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "childRecordExists": { | |
| "type": "string" | |
| }, | |
| "isDeleted": { | |
| "type": "string" | |
| }, | |
| "secondaryTo": { | |
| "type": "string" | |
| }, | |
| "identifiedDate": { | |
| "type": "string" | |
| }, | |
| "resolvedDate": { | |
| "type": "string" | |
| }, | |
| "codeDescription": { | |
| "type": "string" | |
| }, | |
| "codeSystem": { | |
| "type": "string" | |
| }, | |
| "codeValue": { | |
| "type": "string" | |
| }, | |
| "status": { | |
| "type": "string" | |
| }, | |
| "sequenceNumber": { | |
| "type": "string" | |
| }, | |
| "_links": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| } | |
| }, | |
| "required": [ | |
| "encounterId", | |
| "personId", | |
| "enterpriseId", | |
| "practiceId", | |
| "category", | |
| "comments", | |
| "description", | |
| "id", | |
| "childRecordExists", | |
| "isDeleted", | |
| "secondaryTo", | |
| "identifiedDate", | |
| "resolvedDate", | |
| "codeDescription", | |
| "codeSystem", | |
| "codeValue", | |
| "status", | |
| "sequenceNumber", | |
| "_links" | |
| ] | |
| }, | |
| "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns-Request": { | |
| "title": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns-Request", | |
| "example": { | |
| "category": "<string>", | |
| "otherCategory": "<string>", | |
| "comments": "<string>", | |
| "healthConcern": "<string>", | |
| "secondaryTo": "<string>", | |
| "identifiedDate": "<string>", | |
| "categoryId": "<string>", | |
| "resolvedDate": "<string>", | |
| "codeDescription": "<string>", | |
| "codeSystem": "<string>", | |
| "codeValue": "<string>", | |
| "status": "<string>" | |
| }, | |
| "type": "object", | |
| "properties": { | |
| "category": { | |
| "type": "string" | |
| }, | |
| "otherCategory": { | |
| "type": "string" | |
| }, | |
| "comments": { | |
| "type": "string" | |
| }, | |
| "healthConcern": { | |
| "type": "string" | |
| }, | |
| "secondaryTo": { | |
| "type": "string" | |
| }, | |
| "identifiedDate": { | |
| "type": "string" | |
| }, | |
| "categoryId": { | |
| "type": "string" | |
| }, | |
| "resolvedDate": { | |
| "type": "string" | |
| }, | |
| "codeDescription": { | |
| "type": "string" | |
| }, | |
| "codeSystem": { | |
| "type": "string" | |
| }, | |
| "codeValue": { | |
| "type": "string" | |
| }, | |
| "status": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "category", | |
| "otherCategory", | |
| "comments", | |
| "healthConcern", | |
| "secondaryTo", | |
| "identifiedDate", | |
| "categoryId", | |
| "resolvedDate", | |
| "codeDescription", | |
| "codeSystem", | |
| "codeValue", | |
| "status" | |
| ] | |
| }, | |
| "OK25": { | |
| "title": "OK25", | |
| "example": { | |
| "encounterId": "<string>", | |
| "personId": "<string>", | |
| "enterpriseId": "<string>", | |
| "practiceId": "<string>", | |
| "category": "<string>", | |
| "comments": "<string>", | |
| "description": "<string>", | |
| "id": "<string>", | |
| "childRecordExists": "<string>", | |
| "isDeleted": "<string>", | |
| "secondaryTo": "<string>", | |
| "identifiedDate": "<string>", | |
| "resolvedDate": "<string>", | |
| "codeDescription": "<string>", | |
| "codeSystem": "<string>", | |
| "codeValue": "<string>", | |
| "status": "<string>", | |
| "sequenceNumber": "<string>", | |
| "_links": [ | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| }, | |
| { | |
| "href": "<string>", | |
| "method": "<string>", | |
| "rel": "<string>", | |
| "description": "<string>", | |
| "vendorExtensions": "<string>" | |
| } | |
| ] | |
| }, | |
| "type": "object", | |
| "properties": { | |
| "encounterId": { | |
| "type": "string" | |
| }, | |
| "personId": { | |
| "type": "string" | |
| }, | |
| "enterpriseId": { | |
| "type": "string" | |
| }, | |
| "practiceId": { | |
| "type": "string" | |
| }, | |
| "category": { | |
| "type": "string" | |
| }, | |
| "comments": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "childRecordExists": { | |
| "type": "string" | |
| }, | |
| "isDeleted": { | |
| "type": "string" | |
| }, | |
| "secondaryTo": { | |
| "type": "string" | |
| }, | |
| "identifiedDate": { | |
| "type": "string" | |
| }, | |
| "resolvedDate": { | |
| "type": "string" | |
| }, | |
| "codeDescription": { | |
| "type": "string" | |
| }, | |
| "codeSystem": { | |
| "type": "string" | |
| }, | |
| "codeValue": { | |
| "type": "string" | |
| }, | |
| "status": { | |
| "type": "string" | |
| }, | |
| "sequenceNumber": { | |
| "type": "string" | |
| }, | |
| "_links": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Link" | |
| } | |
| } | |
| }, | |
| "required": [ | |
| "encounterId", | |
| "personId", | |
| "enterpriseId", | |
| "practiceId", | |
| "category", | |
| "comments", | |
| "description", | |
| "id", | |
| "childRecordExists", | |
| "isDeleted", | |
| "secondaryTo", | |
| "identifiedDate", | |
| "resolvedDate", | |
| "codeDescription", | |
| "codeSystem", | |
| "codeValue", | |
| "status", | |
| "sequenceNumber", | |
| "_links" | |
| ] | |
| }, | |
| "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId-Request": { | |
| "title": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/care-plan/health-concerns/:healthConcernId-Request", | |
| "example": { | |
| "comments": "<string>", | |
| "category": "<string>", | |
| "description": "<string>", | |
| "secondaryTo": "<string>", | |
| "identifiedDate": "<string>", | |
| "resolvedDate": "<string>", | |
| "status": "<string>" | |
| }, | |
| "type": "object", | |
| "properties": { | |
| "comments": { | |
| "type": "string" | |
| }, | |
| "category": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "secondaryTo": { | |
| "type": "string" | |
| }, | |
| "identifiedDate": { | |
| "type": "string" | |
| }, | |
| "resolvedDate": { | |
| "type": "string" | |
| }, | |
| "status": { | |
| "type": "string" | |
| } | |
| }, |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment