{ "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 provided in the list of linked documents under the \"Technical Documentation\" section heading on https://www.nextgen.com/api/regulatory-nge - this and an extensive amount of documentation is also available in our API Developer Portal.\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/developer-program and choose the \"Join Today\" link below the most appropriate program description on that page. Each \"Join Today\" link leads to the API Developer Program Onboarding form. The Open Access Program applies solely to NextGen Healthcare Clients. The Distribution Program is applicable solely to 3rd Party Developer Organizations.\r\n\r\nDeveloper 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 via https://www.nextgen.com/api-on-boarding 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 (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": "", "enterpriseId": "", "practiceId": "", "personId": "", "encounterId": "", "encounterTimestamp": "", "encounterTimestampTimezone": "", "allergyId": "", "allergyTypeId": "", "description": "", "allergyType": "", "locationId": "", "providerId": "", "onsetDate": "", "resolvedDate": "", "comment": "", "reactionDescription": "", "criticalityCode": "", "isLocked": "", "isReadOnly": "", "rxNormCode": "", "rxNormDescription": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "id": "", "enterpriseId": "", "practiceId": "", "personId": "", "encounterId": "", "encounterTimestamp": "", "encounterTimestampTimezone": "", "allergyId": "", "allergyTypeId": "", "description": "", "allergyType": "", "locationId": "", "providerId": "", "onsetDate": "", "resolvedDate": "", "comment": "", "reactionDescription": "", "criticalityCode": "", "isLocked": "", "isReadOnly": "", "rxNormCode": "", "rxNormDescription": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "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": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "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": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "enterpriseId": "", "practiceId": "", "personId": "", "encounterId": "", "encounterTimestamp": "", "encounterTimestampTimezone": "", "allergyId": "", "allergyTypeId": "", "description": "", "allergyType": "", "locationId": "", "providerId": "", "onsetDate": "", "resolvedDate": "", "comment": "", "reactionDescription": "", "criticalityCode": "", "isLocked": "", "isReadOnly": "", "rxNormCode": "", "rxNormDescription": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "id": "", "enterpriseId": "", "practiceId": "", "personId": "", "encounterId": "", "encounterTimestamp": "", "encounterTimestampTimezone": "", "allergyId": "", "allergyTypeId": "", "description": "", "allergyType": "", "locationId": "", "providerId": "", "onsetDate": "", "resolvedDate": "", "comment": "", "reactionDescription": "", "criticalityCode": "", "isLocked": "", "isReadOnly": "", "rxNormCode": "", "rxNormDescription": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "enterpriseId": "", "practiceId": "", "personId": "", "encounterId": "", "encounterTimestamp": "", "encounterTimestampTimezone": "", "allergyId": "", "allergyTypeId": "", "description": "", "allergyType": "", "locationId": "", "providerId": "", "onsetDate": "", "resolvedDate": "", "comment": "", "reactionDescription": "", "criticalityCode": "", "isLocked": "", "isReadOnly": "", "rxNormCode": "", "rxNormDescription": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "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": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "patientAllergyId": "", "reactionDescription": "", "snomedCode": "", "severityCode": "", "severityDescription": "", "rank": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "practiceId": "", "encounterId": "", "personId": "", "snomedConceptId": "", "dateOnset": "", "dateResolved": "", "allergyType": "", "encounterTimestamp": "", "allergyComment": "", "id": "", "category": "", "healthConcern": "", "description": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "enterpriseId": "", "practiceId": "", "encounterId": "", "personId": "", "snomedConceptId": "", "dateOnset": "", "dateResolved": "", "allergyType": "", "encounterTimestamp": "", "allergyComment": "", "id": "", "category": "", "healthConcern": "", "description": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "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": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "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": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "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": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "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": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "practiceId": "", "personId": "", "id": "", "completedDate": "", "instrument": "", "score": "", "severity": "", "encounterDate": "", "createTimestamp": "", "healthConcern": "", "category": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "enterpriseId": "", "practiceId": "", "personId": "", "id": "", "completedDate": "", "instrument": "", "score": "", "severity": "", "encounterDate": "", "createTimestamp": "", "healthConcern": "", "category": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "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": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "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": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "personId": "", "description": "", "itemType": "", "createTimestamp": "", "createTimestampTimezone": "", "modifyTimestamp": "", "modifyTimestampTimezone": "", "encounterId": "", "isRestricted": "", "signoffStatus": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "personId": "", "description": "", "itemType": "", "createTimestamp": "", "createTimestampTimezone": "", "modifyTimestamp": "", "modifyTimestampTimezone": "", "encounterId": "", "isRestricted": "", "signoffStatus": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "personId": "", "description": "", "itemType": "", "createTimestamp": "", "createTimestampTimezone": "", "modifyTimestamp": "", "modifyTimestampTimezone": "", "encounterId": "", "isRestricted": "", "signoffStatus": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "personId": "", "description": "", "itemType": "", "createTimestamp": "", "createTimestampTimezone": "", "modifyTimestamp": "", "modifyTimestampTimezone": "", "encounterId": "", "categories": [ "", "" ], "totalPages": "", "icsDateOfService": "", "encounterTimestamp": "", "appCreatedBy": "", "docTypeId": "", "isRestricted": "", "signoffStatus": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "FileName": "", "MimeType": "" } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "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": "", "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": "", "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": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "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": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "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": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "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": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "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": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "healthConcernId": "", "goalId": "", "detail": "", "category": "", "frequency": "", "progress": "", "reviewDate": "", "startDate": "", "status": "", "codeDescription": "", "codeSystem": "", "codeValue": "", "isDeleted": "", "personId": "", "encounterId": "", "createdBy": "", "createTimestamp": "", "modifiedBy": "", "modifyTimestamp": "", "createTimestampTimezone": "", "modifyTimestampTimezone": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "id": "", "healthConcernId": "", "goalId": "", "detail": "", "category": "", "frequency": "", "progress": "", "reviewDate": "", "startDate": "", "status": "", "codeDescription": "", "codeSystem": "", "codeValue": "", "isDeleted": "", "personId": "", "encounterId": "", "createdBy": "", "createTimestamp": "", "modifiedBy": "", "modifyTimestamp": "", "createTimestampTimezone": "", "modifyTimestampTimezone": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "healthConcernId": "", "goalId": "", "detail": "", "category": "", "frequency": "", "progress": "", "reviewDate": "", "startDate": "", "status": "", "codeDescription": "", "codeSystem": "", "codeValue": "", "isDeleted": "", "personId": "", "encounterId": "", "createdBy": "", "createTimestamp": "", "modifiedBy": "", "modifyTimestamp": "", "createTimestampTimezone": "", "modifyTimestampTimezone": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "encounterId": "", "enterpriseId": "", "practiceId": "", "isDeleted": "", "goalAchieved": "", "goalAchievedDetails": "", "goalId": "", "healthConcernId": "", "interventionId": "", "description": "", "outcomeDate": "", "OutcomeId": "", "createdBy": "", "createTimestamp": "", "createTimestampTimeZone": "", "modifiedBy": "", "modifyTimestamp": "", "modifyTimestampTimeZone": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "personId": "", "encounterId": "", "enterpriseId": "", "practiceId": "", "isDeleted": "", "goalAchieved": "", "goalAchievedDetails": "", "goalId": "", "healthConcernId": "", "interventionId": "", "description": "", "outcomeDate": "", "OutcomeId": "", "createdBy": "", "createTimestamp": "", "createTimestampTimeZone": "", "modifiedBy": "", "modifyTimestamp": "", "modifyTimestampTimeZone": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "encounterId": "", "enterpriseId": "", "practiceId": "", "isDeleted": "", "goalAchieved": "", "goalAchievedDetails": "", "goalId": "", "healthConcernId": "", "interventionId": "", "description": "", "outcomeDate": "", "OutcomeId": "", "createdBy": "", "createTimestamp": "", "createTimestampTimeZone": "", "modifiedBy": "", "modifyTimestamp": "", "modifyTimestampTimeZone": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "personId": "", "enterpriseId": "", "practiceId": "", "category": "", "comments": "", "description": "", "id": "", "childRecordExists": "", "isDeleted": "", "secondaryTo": "", "identifiedDate": "", "resolvedDate": "", "codeDescription": "", "codeSystem": "", "codeValue": "", "status": "", "sequenceNumber": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "encounterId": "", "personId": "", "enterpriseId": "", "practiceId": "", "category": "", "comments": "", "description": "", "id": "", "childRecordExists": "", "isDeleted": "", "secondaryTo": "", "identifiedDate": "", "resolvedDate": "", "codeDescription": "", "codeSystem": "", "codeValue": "", "status": "", "sequenceNumber": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "personId": "", "enterpriseId": "", "practiceId": "", "category": "", "comments": "", "description": "", "id": "", "childRecordExists": "", "isDeleted": "", "secondaryTo": "", "identifiedDate": "", "resolvedDate": "", "codeDescription": "", "codeSystem": "", "codeValue": "", "status": "", "sequenceNumber": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "description": "", "icdCode": "", "isChronic": "", "id": "", "enterpriseId": "", "practiceId": "", "personId": "", "healthConcern": "", "category": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "encounterDate": "", "description": "", "icdCode": "", "isChronic": "", "id": "", "enterpriseId": "", "practiceId": "", "personId": "", "healthConcern": "", "category": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "practiceId": "", "personId": "", "relationship": "", "familyMember": "", "isDeceased": "", "age": "", "condition": "", "codeSystem": "", "code": "", "id": "", "healthConcern": "", "category": "", "createTimestamp": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "enterpriseId": "", "practiceId": "", "personId": "", "relationship": "", "familyMember": "", "isDeceased": "", "age": "", "condition": "", "codeSystem": "", "code": "", "id": "", "healthConcern": "", "category": "", "createTimestamp": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "lastAddressedDate": "", "onsetDate": "", "description": "", "isChronic": "", "enterpriseId": "", "practiceId": "", "personId": "", "healthConcern": "", "category": "", "snomedId": "", "isDeleted": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "id": "", "lastAddressedDate": "", "onsetDate": "", "description": "", "isChronic": "", "enterpriseId": "", "practiceId": "", "personId": "", "healthConcern": "", "category": "", "snomedId": "", "isDeleted": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "exerciseType2": "", "exerciseType3": "", "exerciseFrequency": "", "exerciseHoursWork": "", "alcoholUsage": "", "alcoholType": "", "alcoholFrequency": "", "amountPerDay": "", "lastAlcoholicBeverage": "", "drugs": "", "drugAge": "", "drugType1": "", "drugFrequency1": "", "drugRoute": "", "drugType2": "", "drugFrequency2": "", "drugRoute2": "", "drugType3": "", "drugFrequency3": "", "drugRoute3": "", "drugTreatment": "", "drugTreatmentCount": "", "drugMedicalAttention": "", "drugMedicalAttentionCount": "", "educationLevel": "", "degree": "", "passiveSmoker": "", "encounterId": "", "enterpriseId": "", "practiceId": "", "personId": "", "encounterTimestamp": "", "tobaccoUserProfile": "", "passiveTobaccoType": "", "passiveLengthExposure": "", "passiveLevelExposure": "", "employmentName": "", "employmentStatus": "", "employmentRestrictions": "", "occupation": "", "employmentRetireDate": "", "employmentId": "", "tobaccoUseHealthConcern": "", "tobaccoUseCategory": "", "exerciseHealthConcern": "", "exerciseCategory": "", "alcoholIntakeHealthConcern": "", "alcoholIntakeCategory": "", "employmentDetailHealthConcern": "", "employmentDetailCategory": "", "drugMisuseBehaviorHealthConcern": "", "drugMisuseBehaviorCategory": "", "educationalAchievementHealthConcern": "", "educationalAchievementCategory": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "exerciseType": "", "exerciseType2": "", "exerciseType3": "", "exerciseFrequency": "", "exerciseHoursWork": "", "alcoholUsage": "", "alcoholType": "", "alcoholFrequency": "", "amountPerDay": "", "lastAlcoholicBeverage": "", "drugs": "", "drugAge": "", "drugType1": "", "drugFrequency1": "", "drugRoute": "", "drugType2": "", "drugFrequency2": "", "drugRoute2": "", "drugType3": "", "drugFrequency3": "", "drugRoute3": "", "drugTreatment": "", "drugTreatmentCount": "", "drugMedicalAttention": "", "drugMedicalAttentionCount": "", "educationLevel": "", "degree": "", "passiveSmoker": "", "encounterId": "", "enterpriseId": "", "practiceId": "", "personId": "", "encounterTimestamp": "", "tobaccoUserProfile": "", "passiveTobaccoType": "", "passiveLengthExposure": "", "passiveLevelExposure": "", "employmentName": "", "employmentStatus": "", "employmentRestrictions": "", "occupation": "", "employmentRetireDate": "", "employmentId": "", "tobaccoUseHealthConcern": "", "tobaccoUseCategory": "", "exerciseHealthConcern": "", "exerciseCategory": "", "alcoholIntakeHealthConcern": "", "alcoholIntakeCategory": "", "employmentDetailHealthConcern": "", "employmentDetailCategory": "", "drugMisuseBehaviorHealthConcern": "", "drugMisuseBehaviorCategory": "", "educationalAchievementHealthConcern": "", "educationalAchievementCategory": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "bloodPressureCategory": "", "bloodPressureSystolicValue": "", "bloodPressureDiastolicValue": "", "bloodPressureUnit": "", "bodyTemperatureHealthConcern": "", "bodyTemperatureCategory": "", "bodyTemperatureValue": "", "bodyTemperatureUnit": "", "headCircumferenceHealthConcern": "", "headCircumferenceCategory": "", "headCircumferenceValue": "", "headCircumferenceUnit": "", "heartRateHealthConcern": "", "heartRateCategory": "", "heartRateValue": "", "heartRateUnit": "", "heightHealthConcern": "", "heightCategory": "", "heightValue": "", "heightUnit": "", "weightHealthConcern": "", "weightCategory": "", "weightValue": "", "weightUnit": "", "bmiHealthConcern": "", "bmiCategory": "", "bmiValue": "", "o2BldCOximetryHealthConcern": "", "o2BldCOximetryCategory": "", "o2BldCOximetryValue": "", "o2BldCOximetryUnit": "", "respiratoryRateHealthConcern": "", "respiratoryRateCategory": "", "respiratoryRateValue": "", "respiratoryRateUnit": "", "id": "", "encounterId": "", "enterpriseId": "", "practiceId": "", "personId": "", "encounterTimestamp": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "bloodPressureHealthConcern": "", "bloodPressureCategory": "", "bloodPressureSystolicValue": "", "bloodPressureDiastolicValue": "", "bloodPressureUnit": "", "bodyTemperatureHealthConcern": "", "bodyTemperatureCategory": "", "bodyTemperatureValue": "", "bodyTemperatureUnit": "", "headCircumferenceHealthConcern": "", "headCircumferenceCategory": "", "headCircumferenceValue": "", "headCircumferenceUnit": "", "heartRateHealthConcern": "", "heartRateCategory": "", "heartRateValue": "", "heartRateUnit": "", "heightHealthConcern": "", "heightCategory": "", "heightValue": "", "heightUnit": "", "weightHealthConcern": "", "weightCategory": "", "weightValue": "", "weightUnit": "", "bmiHealthConcern": "", "bmiCategory": "", "bmiValue": "", "o2BldCOximetryHealthConcern": "", "o2BldCOximetryCategory": "", "o2BldCOximetryValue": "", "o2BldCOximetryUnit": "", "respiratoryRateHealthConcern": "", "respiratoryRateCategory": "", "respiratoryRateValue": "", "respiratoryRateUnit": "", "id": "", "encounterId": "", "enterpriseId": "", "practiceId": "", "personId": "", "encounterTimestamp": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "personId": "", "enterpriseId": "", "practiceId": "", "orderId": "", "orderStatus": "", "cvxCode": "", "description": "", "recordSourceCode": "", "recordSourceName": "", "administerCptCode": "", "isDeleted": "", "cptCode": "", "sequenceNumber": "", "status": "", "comment": "", "brandName": "", "siteCode": "", "site": "", "sideCode": "", "side": "", "routeCode": "", "route": "", "unitsCode": "", "units": "", "lotNumber": "", "expirationDate": "", "dose": "", "mvxCode": "", "manufacturerNumber": "", "manufacturerName": "", "notAdministeredReason": "", "notAdministeredCode": "", "purchaseType": "", "strength": "", "administeredYear": "", "administeredMonth": "", "administeredDay": "", "administeredDate": "", "administeredTimestamp": "", "administeredByUserId": "", "administeredByName": "", "auditId": "", "chargeId": "", "adminChargeId": "", "isException": "", "isCounselled": "", "counselledCode": "", "counselledUnit": "", "counselChargeId": "", "consentFrom": "", "consentGivenTo": "", "ndcId": "", "isError": "", "snomedImmunity": "", "isVfc": "", "vfcCode": "", "vfcDate": "", "vfcDateTimezone": "", "fundingSourceCode": "", "simCode": "", "signOffUserId": "", "signOffName": "", "signOffDate": "", "signOffDateTimezone": "", "signoffComment": "", "displayName": "", "hideOnChart": "", "createdBy": "", "createTimestamp": "", "createTimestampTimezone": "", "modifiedByUserId": "", "modifiedByName": "", "modifyTimestamp": "", "modifyTimestampTimezone": "", "overrideInvalidDose": "", "billingUnits": "", "vaccineInventoryId": "", "isReported": "", "wasNotGiven": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "id": "", "personId": "", "enterpriseId": "", "practiceId": "", "orderId": "", "orderStatus": "", "cvxCode": "", "description": "", "recordSourceCode": "", "recordSourceName": "", "administerCptCode": "", "isDeleted": "", "cptCode": "", "sequenceNumber": "", "status": "", "comment": "", "brandName": "", "siteCode": "", "site": "", "sideCode": "", "side": "", "routeCode": "", "route": "", "unitsCode": "", "units": "", "lotNumber": "", "expirationDate": "", "dose": "", "mvxCode": "", "manufacturerNumber": "", "manufacturerName": "", "notAdministeredReason": "", "notAdministeredCode": "", "purchaseType": "", "strength": "", "administeredYear": "", "administeredMonth": "", "administeredDay": "", "administeredDate": "", "administeredTimestamp": "", "administeredByUserId": "", "administeredByName": "", "auditId": "", "chargeId": "", "adminChargeId": "", "isException": "", "isCounselled": "", "counselledCode": "", "counselledUnit": "", "counselChargeId": "", "consentFrom": "", "consentGivenTo": "", "ndcId": "", "isError": "", "snomedImmunity": "", "isVfc": "", "vfcCode": "", "vfcDate": "", "vfcDateTimezone": "", "fundingSourceCode": "", "simCode": "", "signOffUserId": "", "signOffName": "", "signOffDate": "", "signOffDateTimezone": "", "signoffComment": "", "displayName": "", "hideOnChart": "", "createdBy": "", "createTimestamp": "", "createTimestampTimezone": "", "modifiedByUserId": "", "modifiedByName": "", "modifyTimestamp": "", "modifyTimestampTimezone": "", "overrideInvalidDose": "", "billingUnits": "", "vaccineInventoryId": "", "isReported": "", "wasNotGiven": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "personId": "", "enterpriseId": "", "practiceId": "", "orderId": "", "orderStatus": "", "cvxCode": "", "description": "", "recordSourceCode": "", "recordSourceName": "", "administerCptCode": "", "isDeleted": "", "cptCode": "", "sequenceNumber": "", "status": "", "comment": "", "brandName": "", "siteCode": "", "site": "", "sideCode": "", "side": "", "routeCode": "", "route": "", "unitsCode": "", "units": "", "lotNumber": "", "expirationDate": "", "dose": "", "mvxCode": "", "manufacturerNumber": "", "manufacturerName": "", "notAdministeredReason": "", "notAdministeredCode": "", "purchaseType": "", "strength": "", "administeredYear": "", "administeredMonth": "", "administeredDay": "", "administeredDate": "", "administeredTimestamp": "", "administeredByUserId": "", "administeredByName": "", "auditId": "", "chargeId": "", "adminChargeId": "", "isException": "", "isCounselled": "", "counselledCode": "", "counselledUnit": "", "counselChargeId": "", "consentFrom": "", "consentGivenTo": "", "ndcId": "", "isError": "", "snomedImmunity": "", "isVfc": "", "vfcCode": "", "vfcDate": "", "vfcDateTimezone": "", "fundingSourceCode": "", "simCode": "", "signOffUserId": "", "signOffName": "", "signOffDate": "", "signOffDateTimezone": "", "signoffComment": "", "displayName": "", "hideOnChart": "", "createdBy": "", "createTimestamp": "", "createTimestampTimezone": "", "modifiedByUserId": "", "modifiedByName": "", "modifyTimestamp": "", "modifyTimestampTimezone": "", "overrideInvalidDose": "", "billingUnits": "", "vaccineInventoryId": "", "isReported": "", "wasNotGiven": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "id": "", "personId": "", "enterpriseId": "", "practiceId": "", "orderId": "", "orderStatus": "", "cvxCode": "", "description": "", "recordSourceCode": "", "recordSourceName": "", "administerCptCode": "", "isDeleted": "", "cptCode": "", "sequenceNumber": "", "status": "", "comment": "", "brandName": "", "siteCode": "", "site": "", "sideCode": "", "side": "", "routeCode": "", "route": "", "unitsCode": "", "units": "", "lotNumber": "", "expirationDate": "", "dose": "", "mvxCode": "", "manufacturerNumber": "", "manufacturerName": "", "notAdministeredReason": "", "notAdministeredCode": "", "purchaseType": "", "strength": "", "administeredYear": "", "administeredMonth": "", "administeredDay": "", "administeredDate": "", "administeredTimestamp": "", "administeredByUserId": "", "administeredByName": "", "auditId": "", "chargeId": "", "adminChargeId": "", "isException": "", "isCounselled": "", "counselledCode": "", "counselledUnit": "", "counselChargeId": "", "consentFrom": "", "consentGivenTo": "", "ndcId": "", "isError": "", "snomedImmunity": "", "isVfc": "", "vfcCode": "", "vfcDate": "", "vfcDateTimezone": "", "fundingSourceCode": "", "simCode": "", "signOffUserId": "", "signOffName": "", "signOffDate": "", "signOffDateTimezone": "", "signoffComment": "", "displayName": "", "hideOnChart": "", "createdBy": "", "createTimestamp": "", "createTimestampTimezone": "", "modifiedByUserId": "", "modifiedByName": "", "modifyTimestamp": "", "modifyTimestampTimezone": "", "overrideInvalidDose": "", "billingUnits": "", "vaccineInventoryId": "", "isReported": "", "wasNotGiven": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "administeredDate": "", "groupName": "", "statusCode": "", "statusMessage": "", "orderVaccineId": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "personId": "", "enterpriseId": "", "practiceId": "", "cvxCode": "", "name": "", "reasons": [ "", "" ], "startDate": "", "endDate": "", "comment": "", "createdBy": "", "createTimestamp": "", "modifiedBy": "", "modifyTimestamp": "", "practiceName": "", "excludedBy": "", "isDeleted": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "id": "", "personId": "", "enterpriseId": "", "practiceId": "", "cvxCode": "", "name": "", "reasons": [ "", "" ], "startDate": "", "endDate": "", "comment": "", "createdBy": "", "createTimestamp": "", "modifiedBy": "", "modifyTimestamp": "", "practiceName": "", "excludedBy": "", "isDeleted": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "personId": "", "isStatusProcessedSuccessfully": "", "isRuleFound": "", "referenceDate": "", "personDateOfBirth": "", "cdcStartMonth": "", "cdcEndMonth": "", "nextDueDate": "", "status": "", "statusCalculationCode": "", "doseSequenceStatusCalulatedFor": "", "groupMinimumAgeInDays": "", "groupMaximumAgeInDays": "", "doseMinimumAgeInDays": "", "doseMaximumAgeInDays": "", "cvxToAdminister": "", "vaccineToAdminister": "", "totalDoses": "", "statusCalculationMessage": "", "nextDueDateCalculationMessage": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "isRequired": "", "acknowledged": "", "severityLevel": "", "description": "", "entityName": "", "eventType": "", "sourceId": "", "cause": "", "warningDetail": "", "warningType": "", "warning": "", "causeText": "", "overrideText": "", "durAuditKey": "", "isSuppressed": "", "isRecordedElseWhere": "", "practiceId": "", "display": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "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": "", "enterpriseId": "", "practiceId": "", "encounterId": "", "personId": "", "userFriendlyOrderNumber": "", "orderingProviderId": "", "orderingProviderName": "", "supervisorProviderId": "", "status": "", "vaccineDescription": "", "createTimestamp": "", "createTimestampTimezone": "", "modifyTimestamp": "", "modifyTimestampTimezone": "", "isDeleted": "", "hasDocuments": "", "hasTrackingComments": "", "immunizationsDescription": "", "isVerbalOrder": "", "encounterTimestamp": "", "encounterTimestampTimezone": "", "locationId": "", "locationName": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "id": "", "enterpriseId": "", "practiceId": "", "encounterId": "", "personId": "", "userFriendlyOrderNumber": "", "orderingProviderId": "", "orderingProviderName": "", "supervisorProviderId": "", "status": "", "vaccineDescription": "", "createTimestamp": "", "createTimestampTimezone": "", "modifyTimestamp": "", "modifyTimestampTimezone": "", "isDeleted": "", "hasDocuments": "", "hasTrackingComments": "", "immunizationsDescription": "", "isVerbalOrder": "", "encounterTimestamp": "", "encounterTimestampTimezone": "", "locationId": "", "locationName": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "enterpriseId": "", "practiceId": "", "encounterId": "", "personId": "", "personName": "", "userFriendlyOrderNumber": "", "generatedBy": "", "locationId": "", "locationName": "", "orderingProviderId": "", "orderingProviderName": "", "supervisorProviderId": "", "status": "", "vaccineDescription": "", "createTimestamp": "", "createTimestampTimezone": "", "modifyTimestamp": "", "modifyTimestampTimezone": "", "registryId": "", "interfaceMessage": "", "hasDocuments": "", "hasTrackingComments": "", "immunizationsDescription": "", "orderComment": "", "isVerbalOrder": "", "allergiesReviewed": [ "", "" ], "cancelReason": "", "signOffDate": "", "signOffDateTimezone": "", "signOffUserId": "", "signOffUserName": "", "privacyLevel": "", "encounterTimestamp": "", "encounterTimestampTimezone": "", "isDeleted": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "personId": "", "personPayerId": "", "payerId": "", "insuredPersonId": "", "cob": "", "orderId": "", "payerName": "", "insuredPersonName": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "orderId": "", "personId": "", "providerId": "", "authorName": "", "authorDisplayName": "", "userName": "", "isDelegate": "", "createTimestamp": "", "createTimestampTimezone": "", "comment": "", "type": "", "generatedBy": "", "isAutoGenerated": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "personId": "", "enterpriseId": "", "practiceId": "", "orderId": "", "cvxCode": "", "description": "", "cptCode": "", "sequenceNumber": "", "status": "", "lotNumber": "", "administeredYear": "", "administeredMonth": "", "administeredDay": "", "administeredDate": "", "administeredTimestamp": "", "administeredByUserId": "", "administeredByName": "", "isVfc": "", "vfcCode": "", "fundingSourceCode": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "personId": "", "enterpriseId": "", "practiceId": "", "orderId": "", "orderStatus": "", "cvxCode": "", "description": "", "recordSourceCode": "", "recordSourceName": "", "administerCptCode": "", "isDeleted": "", "cptCode": "", "sequenceNumber": "", "status": "", "comment": "", "brandName": "", "siteCode": "", "site": "", "sideCode": "", "side": "", "routeCode": "", "route": "", "unitsCode": "", "units": "", "lotNumber": "", "expirationDate": "", "dose": "", "mvxCode": "", "manufacturerNumber": "", "manufacturerName": "", "notAdministeredReason": "", "notAdministeredCode": "", "purchaseType": "", "strength": "", "administeredYear": "", "administeredMonth": "", "administeredDay": "", "administeredDate": "", "administeredTimestamp": "", "administeredByUserId": "", "administeredByName": "", "auditId": "", "chargeId": "", "adminChargeId": "", "isException": "", "isCounselled": "", "counselledCode": "", "counselledUnit": "", "counselChargeId": "", "consentFrom": "", "consentGivenTo": "", "ndcId": "", "isError": "", "snomedImmunity": "", "isVfc": "", "vfcCode": "", "vfcDate": "", "vfcDateTimezone": "", "fundingSourceCode": "", "simCode": "", "signOffUserId": "", "signOffName": "", "signOffDate": "", "signOffDateTimezone": "", "signoffComment": "", "displayName": "", "hideOnChart": "", "createdBy": "", "createTimestamp": "", "createTimestampTimezone": "", "modifiedByUserId": "", "modifiedByName": "", "modifyTimestamp": "", "modifyTimestampTimezone": "", "overrideInvalidDose": "", "billingUnits": "", "vaccineInventoryId": "", "isReported": "", "wasNotGiven": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "id": "", "componentName": "", "lotNumber": "", "diluentLotNumber": "", "orderId": "", "personId": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "orderId": "", "orderVaccineId": "", "id": "", "diagnosisCodeLibraryId": "", "diagnosisCodeId": "", "description": "", "icd9CmCodeId": "", "userDescription": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "orderVaccineId": "", "personId": "", "orderId": "", "visGiveDate": "", "visGiveDateTimeZone": "", "visPublishDate": "", "givenVisId": "", "vaccineType": "", "visDocumentType": "", "createdBy": "", "visDescription": "", "languageId": "", "givenBy": "", "languageName": "", "visHistoryPublishDate": "", "givenVisVaccineType": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "vaccineId": "", "cvxCode": "", "vaccineDescription": "", "lotNumber": "", "cptCode": "", "mvxCode": "", "manufacturerName": "", "manufacturerNumber": "", "strength": "", "units": "", "unitsCode": "", "dose": "", "route": "", "routeCode": "", "side": "", "sideCode": "", "site": "", "siteCode": "", "brandName": "", "purchaseType": "", "wastedReason": "", "wastedDate": "", "orderId": "", "personId": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "vaccineId": "", "cvxCode": "", "vaccineDescription": "", "lotNumber": "", "cptCode": "", "mvxCode": "", "manufacturerName": "", "manufacturerNumber": "", "strength": "", "units": "", "unitsCode": "", "dose": "", "route": "", "routeCode": "", "side": "", "sideCode": "", "site": "", "siteCode": "", "brandName": "", "purchaseType": "", "wastedReason": "", "wastedDate": "", "orderId": "", "personId": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "personId": "", "enterpriseId": "", "practiceId": "", "seriesName": "", "isComplete": "", "comment": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "personId": "", "enterpriseId": "", "practiceId": "", "seriesName": "", "isComplete": "", "comment": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "personId": "", "deviceIdentifier": "", "universalDeviceIdentifier": "", "snoMedCtCode": "", "snoMedCtDescription": "", "lotOrBatchNumber": "", "serialNumber": "", "manufacturingDate": "", "expirationDate": "", "isDeleted": "", "assigningAuthorityOid": "", "assigningAuthority": "", "gmdnProductName": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "id": "", "personId": "", "deviceIdentifier": "", "universalDeviceIdentifier": "", "snoMedCtCode": "", "snoMedCtDescription": "", "lotOrBatchNumber": "", "serialNumber": "", "manufacturingDate": "", "expirationDate": "", "isDeleted": "", "assigningAuthorityOid": "", "assigningAuthority": "", "gmdnProductName": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "personId": "", "deviceIdentifier": "", "universalDeviceIdentifier": "", "snoMedCtCode": "", "snoMedCtDescription": "", "lotOrBatchNumber": "", "serialNumber": "", "manufacturingDate": "", "expirationDate": "", "isDeleted": "", "assigningAuthorityOid": "", "assigningAuthority": "", "gmdnProductName": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "testDescription": "", "encounterId": "", "personId": "", "ufoNumber": "", "generatedBy": "", "orderType": "", "testLocation": "", "orderingProvider": "", "encounterTimestamp": "", "orderDate": "", "orderDateTimezone": "", "signOffDate": "", "signOffPerson": "", "testStatus": "", "nextgenStatus": "", "labId": "", "signoffCommentsIndicator": "", "documentsIndicator": "", "orderControl": "", "orderPriority": "", "timeEntered": "", "specimenActionCode": "", "billingType": "", "clinicalInformation": "", "cancelReason": "", "intrfMessage": "", "practiceId": "", "enterpriseId": "", "isDeleted": "", "providerDisplayName": "", "locationName": "", "addressLine1": "", "addressLine2": "", "city": "", "state": "", "zip": "", "phone": "", "fax": "", "firstName": "", "lastName": "", "middleInitial": "", "isFutureOrder": "", "startDate": "", "nextDueDate": "", "expectedResultDate": "", "generalComment": "", "orderComment": "", "patientComment": "", "isOrderedElseWhere": "", "isCompleted": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "testDescription": "", "testStatus": "", "nextgenStatus": "", "labId": "", "encounterId": "", "encounterTimestamp": "", "personId": "", "ufoNumber": "", "generatedBy": "", "orderType": "", "testLocation": "", "orderControl": "", "orderPriority": "", "orderingProvider": "", "orderDate": "", "orderDateTimezone": "", "signOffDate": "", "intrfMessage": "", "enterpriseId": "", "practiceId": "", "isDeleted": "", "signOffPerson": "", "isFutureOrder": "", "startDate": "", "nextDueDate": "", "expectedResultDate": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "id": "", "testDescription": "", "testStatus": "", "nextgenStatus": "", "labId": "", "encounterId": "", "encounterTimestamp": "", "personId": "", "ufoNumber": "", "generatedBy": "", "orderType": "", "testLocation": "", "orderControl": "", "orderPriority": "", "orderingProvider": "", "orderDate": "", "orderDateTimezone": "", "signOffDate": "", "intrfMessage": "", "enterpriseId": "", "practiceId": "", "isDeleted": "", "signOffPerson": "", "isFutureOrder": "", "startDate": "", "nextDueDate": "", "expectedResultDate": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "testDescription": "", "encounterId": "", "personId": "", "ufoNumber": "", "generatedBy": "", "orderType": "", "testLocation": "", "orderingProvider": "", "encounterTimestamp": "", "orderDate": "", "orderDateTimezone": "", "signOffDate": "", "signOffPerson": "", "testStatus": "", "nextgenStatus": "", "labId": "", "signoffCommentsIndicator": "", "documentsIndicator": "", "orderControl": "", "orderPriority": "", "timeEntered": "", "specimenActionCode": "", "billingType": "", "clinicalInformation": "", "cancelReason": "", "intrfMessage": "", "practiceId": "", "enterpriseId": "", "isDeleted": "", "providerDisplayName": "", "locationName": "", "addressLine1": "", "addressLine2": "", "city": "", "state": "", "zip": "", "phone": "", "fax": "", "firstName": "", "lastName": "", "middleInitial": "", "isFutureOrder": "", "startDate": "", "nextDueDate": "", "expectedResultDate": "", "generalComment": "", "orderComment": "", "patientComment": "", "isOrderedElseWhere": "", "isCompleted": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "personPayerId": "", "payerId": "", "insuredPersonId": "", "cob": "", "orderNumber": "", "personId": "", "lastName": "", "firstName": "", "enterpriseId": "", "practiceId": "", "payerName": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "id": "", "personPayerId": "", "payerId": "", "insuredPersonId": "", "cob": "", "orderNumber": "", "personId": "", "lastName": "", "firstName": "", "enterpriseId": "", "practiceId": "", "payerName": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "personId": "", "enterpriseId": "", "practiceId": "", "orderId": "", "orderType": "", "isFutureOrder": "", "scheduleType": "", "startDate": "", "endDate": "", "interval": "", "timespan": "", "createdBy": "", "createTimestamp": "", "nextDueDate": "", "modifiedBy": "", "isAutoReleasable": "", "maxOccurrence": "", "stopDate": "", "stopReason": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "orderId": "", "enterpriseId": "", "practiceId": "", "personId": "", "testCodeId": "", "testCodeText": "", "testCodeSystem": "", "testComment": "", "collectionTime": "", "collectionTimezone": "", "expectedResultDate": "", "scheduledTime": "", "scheduledTimezone": "", "loincCode": "", "chargeId": "", "orderingReason": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "IsNextGenCompendiumTest": "", "ScheduleDateTime": "", "VolumeQuantity": "", "VolumeUnit": "", "CollectionDate": "", "SourceSite": "", "SourceDescription": "", "Additives": "", "BodySite": "", "SiteModifier": "", "SpecimenRole": "", "SpecimenStorage": "", "CollectionMethod": "", "Comment": "", "OrderingReason": "", "ExpectedResultDate": "", "GeneratedBy": "" }, { "TestCodeId": "", "IsNextGenCompendiumTest": "", "ScheduleDateTime": "", "VolumeQuantity": "", "VolumeUnit": "", "CollectionDate": "", "SourceSite": "", "SourceDescription": "", "Additives": "", "BodySite": "", "SiteModifier": "", "SpecimenRole": "", "SpecimenStorage": "", "CollectionMethod": "", "Comment": "", "OrderingReason": "", "ExpectedResultDate": "", "GeneratedBy": "" } ], "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "orderId": "", "enterpriseId": "", "practiceId": "", "personId": "", "testCodeId": "", "testCodeText": "", "testCodeSystem": "", "collectionTime": "", "volumeQuantity": "", "volumeUnits": "", "specSrcCode": "", "specSrcDesc": "", "specSrcAdditives": "", "scheduledTime": "", "createdBy": "", "generatedBy": "", "createTimestamp": "", "modifiedBy": "", "modifyTimestamp": "", "loincCode": "", "snomedCode": "", "specSrcBodySite": "", "specSrcSiteModifier": "", "specSrcRole": "", "specSrcStorage": "", "specSrcCollectionMethod": "", "collectorId": "", "testComment": "", "expectedResultDate": "", "collectionTimezone": "", "scheduledTimezone": "", "createTimestampTimezone": "", "modifyTimestampTimezone": "", "chargeId": "", "orderingReason": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "enterpriseId": "", "practiceId": "", "personId": "", "orderId": "", "orderedTestId": "", "answer": "", "questionCode": "", "createdBy": "", "createTimestamp": "", "modifiedBy": "", "modifyTimestamp": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "id": "", "enterpriseId": "", "practiceId": "", "personId": "", "orderId": "", "orderedTestId": "", "answer": "", "questionCode": "", "createdBy": "", "createTimestamp": "", "modifiedBy": "", "modifyTimestamp": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "orderNumber": "", "personId": "", "enterpriseId": "", "practiceId": "", "orderTestId": "", "diagnosisCodeLibraryId": "", "diagnosisCodeId": "", "description": "", "icd9cmCodeId": "", "userDescription": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "id": "", "orderNumber": "", "personId": "", "enterpriseId": "", "practiceId": "", "orderTestId": "", "diagnosisCodeLibraryId": "", "diagnosisCodeId": "", "description": "", "icd9cmCodeId": "", "userDescription": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "DiagnosisCodeId": "" }, { "DiagnosisCodeLibraryId": "", "DiagnosisCodeId": "" } ], "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "orderId": "", "personId": "", "providerId": "", "authorName": "", "authorDisplayName": "", "userName": "", "isDelegate": "", "createTimestamp": "", "createTimestampTimezone": "", "comment": "", "type": "", "generatedBy": "", "isAutoGenerated": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "enterpriseId": "", "practiceId": "", "personId": "", "orderId": "", "collectionDateTime": "", "collectionDateTimeTimezone": "", "orderingProviderId": "", "resultStatus": "", "testDescription": "", "isDeleted": "", "createTimestamp": "", "createTimestampTimezone": "", "locationId": "", "obrComment": "", "loincCode": "", "isConfidential": "", "orderTestId": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "id": "", "enterpriseId": "", "practiceId": "", "personId": "", "orderId": "", "collectionDateTime": "", "collectionDateTimeTimezone": "", "orderingProviderId": "", "resultStatus": "", "testDescription": "", "isDeleted": "", "createTimestamp": "", "createTimestampTimezone": "", "locationId": "", "obrComment": "", "loincCode": "", "isConfidential": "", "orderTestId": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "enterpriseId": "", "practiceId": "", "personId": "", "orderId": "", "collectionDateTime": "", "collectionDateTimeTimezone": "", "orderingProviderId": "", "resultStatus": "", "testDescription": "", "isDeleted": "", "createTimestamp": "", "createTimestampTimezone": "", "locationId": "", "obrComment": "", "loincCode": "", "isConfidential": "", "orderTestId": "", "isMicrobiology": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "personId": "", "orderId": "", "observationSequenceNumber": "", "enterpriseId": "", "practiceId": "", "observationId": "", "resultCode": "", "resultDescription": "", "codeSystem": "", "observationValue": "", "abnormalityCode": "", "abnormality": "", "resultType": "", "units": "", "referenceRange": "", "observationResultStatus": "", "clinicalName": "", "observationDateTime": "", "observationDateTimeTimezone": "", "loincCode": "", "resultSequenceNumber": "", "hasComment": "", "isDeleted": "", "isSignedOff": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "ComponentKey": "", "ComponentDescription": "", "Value": "", "Unit": "", "Range": "", "Comment": "", "AbnormalFlag": "", "CodeSystem": "", "ObservationDate": "", "LoincCode": "" }, { "Type": "", "ComponentKey": "", "ComponentDescription": "", "Value": "", "Unit": "", "Range": "", "Comment": "", "AbnormalFlag": "", "CodeSystem": "", "ObservationDate": "", "LoincCode": "" } ], "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "personId": "", "orderId": "", "observationSequenceNumber": "", "enterpriseId": "", "practiceId": "", "observationId": "", "resultCode": "", "resultDescription": "", "codeSystem": "", "observationValue": "", "abnormalityCode": "", "abnormality": "", "resultType": "", "units": "", "referenceRange": "", "observationResultStatus": "", "clinicalName": "", "observationDateTime": "", "observationDateTimeTimezone": "", "loincCode": "", "resultSequenceNumber": "", "hasComment": "", "isDeleted": "", "isSignedOff": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "panelId": "", "personId": "", "orderId": "", "observationSequenceNumber": "", "enterpriseId": "", "practiceId": "", "observationId": "", "resultCode": "", "resultDescription": "", "codeSystem": "", "observationValue": "", "abnormalityCode": "", "abnormality": "", "resultType": "", "units": "", "referenceRange": "", "observationResultStatus": "", "clinicalName": "", "observationDateTime": "", "observationDateTimeTimezone": "", "loincCode": "", "resultSequenceNumber": "", "hasComment": "", "isDeleted": "", "isSignedOff": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "personId": "", "providerId": "", "fdbName": "", "medicationName": "", "genericName": "", "brandName": "", "isGenericSelected": "", "dose": "", "route": "", "doseForm": "", "originalStartDate": "", "startDate": "", "stopDate": "", "sigDescription": "", "enterpriseId": "", "practiceId": "", "encounterId": "", "sourceProductId": "", "lastAuditType": "", "representativeNdcIndicator": "", "privacyIndicator": "", "isHidden": "", "deaClassCode": "", "medicationId": "", "ndcId": "", "createTimestamp": "", "createTimestampTimezone": "", "rxNormCode": "", "status": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "id": "", "personId": "", "providerId": "", "fdbName": "", "medicationName": "", "genericName": "", "brandName": "", "isGenericSelected": "", "dose": "", "route": "", "doseForm": "", "originalStartDate": "", "startDate": "", "stopDate": "", "sigDescription": "", "enterpriseId": "", "practiceId": "", "encounterId": "", "sourceProductId": "", "lastAuditType": "", "representativeNdcIndicator": "", "privacyIndicator": "", "isHidden": "", "deaClassCode": "", "medicationId": "", "ndcId": "", "createTimestamp": "", "createTimestampTimezone": "", "rxNormCode": "", "status": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "personId": "", "pbmId": "", "source": "", "drugDescription": "", "ndcId": "", "quantity": "", "daysSupply": "", "directions": "", "refills": "", "isSubstitutionAllowed": "", "lastFillDate": "", "writtenDate": "", "note": "", "priorAuthorizationStatus": "", "pharmacyName": "", "pharmacyAddressLine1": "", "pharmacyCity": "", "pharmacyState": "", "pharmacyZip": "", "pharmacyPhoneNumber": "", "prescriberName": "", "prescriberAddressLine1": "", "prescriberCity": "", "prescriberState": "", "prescriberZip": "", "prescriberPhoneNumber": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "personId": "", "providerId": "", "fdbName": "", "medicationName": "", "genericName": "", "brandName": "", "isGenericSelected": "", "dose": "", "route": "", "doseForm": "", "originalStartDate": "", "startDate": "", "stopDate": "", "sigDescription": "", "enterpriseId": "", "practiceId": "", "encounterId": "", "sourceProductId": "", "lastAuditType": "", "representativeNdcIndicator": "", "privacyIndicator": "", "isHidden": "", "deaClassCode": "", "medicationId": "", "ndcId": "", "createTimestamp": "", "createTimestampTimezone": "", "rxNormCode": "", "status": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "id": "", "personId": "", "providerId": "", "fdbName": "", "medicationName": "", "genericName": "", "brandName": "", "isGenericSelected": "", "dose": "", "route": "", "doseForm": "", "originalStartDate": "", "startDate": "", "stopDate": "", "sigDescription": "", "enterpriseId": "", "practiceId": "", "encounterId": "", "sourceProductId": "", "lastAuditType": "", "representativeNdcIndicator": "", "privacyIndicator": "", "isHidden": "", "deaClassCode": "", "medicationId": "", "ndcId": "", "createTimestamp": "", "createTimestampTimezone": "", "rxNormCode": "", "status": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "fdbName": "", "medicationName": "", "genericName": "", "brandName": "", "dose": "", "doseForm": "", "ndcId": "", "gcn": "", "route": "", "hiclSequenceNumber": "", "gcnSequenceNumber": "", "deaClassCode": "", "medicationId": "", "isAvailable": "", "createdBy": "", "createTimestamp": "", "createTimestampTimezone": "", "modifiedBy": "", "modifyTimestamp": "", "modifyTimestampTimezone": "", "personId": "", "encounterId": "", "encounterProviderId": "", "encounterTimestamp": "", "encounterTimestampTimezone": "", "providerId": "", "locationId": "", "practiceId": "", "practiceName": "", "enterpriseId": "", "enterpriseName": "", "startDate": "", "originalStartDate": "", "stopDate": "", "sigCodes": "", "rxQuantity": "", "rxRefills": "", "isGenericAllowed": "", "isSample": "", "dispenseAsWritten": "", "orgRefills": "", "lastRefillDate": "", "sigDescription": "", "isPrescribedElsewhere": "", "rxUnits": "", "rxComment": "", "rxSpecialInstruction": "", "printSpanishIndicator": "", "isGenericSelected": "", "diagnosisCode": "", "secondaryDiagnosisCode": "", "tertiaryDiagnosisCode": "", "representativeNdcIndicator": "", "prnReason": "", "formularyId": "", "formulaOverrideCode": "", "formulaOverrideText": "", "originalRxNdc": "", "formulaStatus": "", "auditMask": "", "auditId": "", "sendAuditId": "", "lastAuditType": "", "lotNumber": "", "expirationDate": "", "isPrn": "", "renewParentId": "", "rxUnitCode": "", "oldId": "", "rxRenewNote": "", "FdbDosageId": "", "refillLimit": "", "refillLimitDate": "", "prescribedElsewhereLocation": "", "priorAuthorizationIndicator": "", "priorAuthorizationId": "", "priorAuthorizationDate": "", "privacyIndicator": "", "refillsRemaining": "", "customDosageId": "", "isAutoCalculated": "", "pbmId": "", "formularyDetailData": "", "formularySummaryData": "", "sourceProductId": "", "supervisingProviderId": "", "ineffectiveMedicationIndicator": "", "pedOrderId": "", "eCouponNote": "", "eCouponUrl": "", "auditTimestamp": "", "isErxDisabledByState": "", "isFaxDisabledByState": "", "isHidden": "", "isSupply": "", "rxNormCode": "", "status": "", "rxFillIndicator": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "personId": "", "providerId": "", "fdbName": "", "medicationName": "", "genericName": "", "brandName": "", "isGenericSelected": "", "dose": "", "route": "", "doseForm": "", "originalStartDate": "", "startDate": "", "stopDate": "", "sigDescription": "", "enterpriseId": "", "practiceId": "", "encounterId": "", "sourceProductId": "", "lastAuditType": "", "representativeNdcIndicator": "", "privacyIndicator": "", "isHidden": "", "deaClassCode": "", "medicationId": "", "ndcId": "", "createTimestamp": "", "createTimestampTimezone": "", "rxNormCode": "", "status": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "id": "", "personId": "", "providerId": "", "fdbName": "", "medicationName": "", "genericName": "", "brandName": "", "isGenericSelected": "", "dose": "", "route": "", "doseForm": "", "originalStartDate": "", "startDate": "", "stopDate": "", "sigDescription": "", "enterpriseId": "", "practiceId": "", "encounterId": "", "sourceProductId": "", "lastAuditType": "", "representativeNdcIndicator": "", "privacyIndicator": "", "isHidden": "", "deaClassCode": "", "medicationId": "", "ndcId": "", "createTimestamp": "", "createTimestampTimezone": "", "rxNormCode": "", "status": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "fdbName": "", "medicationName": "", "genericName": "", "brandName": "", "dose": "", "doseForm": "", "ndcId": "", "gcn": "", "route": "", "hiclSequenceNumber": "", "gcnSequenceNumber": "", "deaClassCode": "", "medicationId": "", "isAvailable": "", "createdBy": "", "createTimestamp": "", "createTimestampTimezone": "", "modifiedBy": "", "modifyTimestamp": "", "modifyTimestampTimezone": "", "personId": "", "encounterId": "", "encounterProviderId": "", "encounterTimestamp": "", "encounterTimestampTimezone": "", "providerId": "", "locationId": "", "practiceId": "", "practiceName": "", "enterpriseId": "", "enterpriseName": "", "startDate": "", "originalStartDate": "", "stopDate": "", "sigCodes": "", "rxQuantity": "", "rxRefills": "", "isGenericAllowed": "", "isSample": "", "dispenseAsWritten": "", "orgRefills": "", "lastRefillDate": "", "sigDescription": "", "isPrescribedElsewhere": "", "rxUnits": "", "rxComment": "", "rxSpecialInstruction": "", "printSpanishIndicator": "", "isGenericSelected": "", "diagnosisCode": "", "secondaryDiagnosisCode": "", "tertiaryDiagnosisCode": "", "representativeNdcIndicator": "", "prnReason": "", "formularyId": "", "formulaOverrideCode": "", "formulaOverrideText": "", "originalRxNdc": "", "formulaStatus": "", "auditMask": "", "auditId": "", "sendAuditId": "", "lastAuditType": "", "lotNumber": "", "expirationDate": "", "isPrn": "", "renewParentId": "", "rxUnitCode": "", "oldId": "", "rxRenewNote": "", "FdbDosageId": "", "refillLimit": "", "refillLimitDate": "", "prescribedElsewhereLocation": "", "priorAuthorizationIndicator": "", "priorAuthorizationId": "", "priorAuthorizationDate": "", "privacyIndicator": "", "refillsRemaining": "", "customDosageId": "", "isAutoCalculated": "", "pbmId": "", "formularyDetailData": "", "formularySummaryData": "", "sourceProductId": "", "supervisingProviderId": "", "ineffectiveMedicationIndicator": "", "pedOrderId": "", "eCouponNote": "", "eCouponUrl": "", "auditTimestamp": "", "isErxDisabledByState": "", "isFaxDisabledByState": "", "isHidden": "", "isSupply": "", "rxNormCode": "", "status": "", "rxFillIndicator": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "noteType": "", "note": "", "personId": "", "medicationId": "", "createdBy": "", "modifiedBy": "", "createTimestamp": "", "createTimestampTimezone": "", "modifyTimestamp": "", "modifyTimestampTimezone": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "id": "", "noteType": "", "note": "", "personId": "", "medicationId": "", "createdBy": "", "modifiedBy": "", "createTimestamp": "", "createTimestampTimezone": "", "modifyTimestamp": "", "modifyTimestampTimezone": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "noteType": "", "note": "", "personId": "", "medicationId": "", "createdBy": "", "modifiedBy": "", "createTimestamp": "", "createTimestampTimezone": "", "modifyTimestamp": "", "modifyTimestampTimezone": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "medicationName": "", "gcnSequenceNumber": "", "monographCode": "", "monograph": [ "", "" ], "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "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": "", "baseUrl": "", "resourceUrl": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "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": "", "personId": "", "providerId": "", "fdbName": "", "medicationName": "", "genericName": "", "brandName": "", "isGenericSelected": "", "dose": "", "route": "", "doseForm": "", "originalStartDate": "", "startDate": "", "stopDate": "", "sigDescription": "", "enterpriseId": "", "practiceId": "", "encounterId": "", "sourceProductId": "", "lastAuditType": "", "representativeNdcIndicator": "", "privacyIndicator": "", "isHidden": "", "deaClassCode": "", "medicationId": "", "ndcId": "", "createTimestamp": "", "createTimestampTimezone": "", "rxNormCode": "", "status": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "id": "", "personId": "", "providerId": "", "fdbName": "", "medicationName": "", "genericName": "", "brandName": "", "isGenericSelected": "", "dose": "", "route": "", "doseForm": "", "originalStartDate": "", "startDate": "", "stopDate": "", "sigDescription": "", "enterpriseId": "", "practiceId": "", "encounterId": "", "sourceProductId": "", "lastAuditType": "", "representativeNdcIndicator": "", "privacyIndicator": "", "isHidden": "", "deaClassCode": "", "medicationId": "", "ndcId": "", "createTimestamp": "", "createTimestampTimezone": "", "rxNormCode": "", "status": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "Items": [ { "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ], "checkInDateTime": "", "checkInTimezone": "", "checkOutDateTime": "", "checkOutTimezone": "", "encounterNumber": "", "enterpriseId": "", "id": "", "isLocked": "", "isSensitive": "", "locationId": "", "locationName": "", "personId": "", "practiceId": "", "printOnStatements": "", "referringProviderId": "", "referringProviderName": "", "renderingProviderId": "", "renderingProviderName": "", "status": "", "suppressOutreach": "", "suppressPortal": "", "timestamp": "", "timestampTimezone": "" }, { "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ], "checkInDateTime": "", "checkInTimezone": "", "checkOutDateTime": "", "checkOutTimezone": "", "encounterNumber": "", "enterpriseId": "", "id": "", "isLocked": "", "isSensitive": "", "locationId": "", "locationName": "", "personId": "", "practiceId": "", "printOnStatements": "", "referringProviderId": "", "referringProviderName": "", "renderingProviderId": "", "renderingProviderName": "", "status": "", "suppressOutreach": "", "suppressPortal": "", "timestamp": "", "timestampTimezone": "" } ], "NextPageLink": "" } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "firstName": "", "lastName": "", "middleName": "", "prefix": "", "prefixId": "", "suffix": "", "suffixId": "", "addressLine1": "", "addressLine2": "", "city": "", "state": "", "zip": "", "countryId": "", "country": "", "countyId": "", "county": "", "secondaryAddressLine1": "", "secondaryAddressLine2": "", "secondaryCity": "", "secondaryState": "", "secondaryZip": "", "secondaryCountryId": "", "secondaryCountry": "", "secondaryCountyId": "", "secondaryCounty": "", "homePhone": "", "homePhoneComment": "", "secondaryHomePhone": "", "secondaryHomePhoneComment": "", "dayPhone": "", "dayPhoneExtension": "", "dayPhoneComment": "", "alternatePhone": "", "alternatePhoneDescription": "", "alternatePhoneExtension": "", "alternatePhoneComment": "", "internationalHomePhone": "", "internationalWorkPhone": "", "internationalZip": "", "cellPhone": "", "cellPhoneComment": "", "email": "", "emailAddressComment": "", "contactSequence": "", "sex": "", "dateOfBirth": "", "age": "", "socialSecurityNumber": "", "contactPreferenceId": "", "contactPreferenceDescription": "", "primaryCareProviderId": "", "primaryCareProviderFullName": "", "primaryCareProviderFirstName": "", "primaryCareProviderLastName": "", "primaryCareProviderMiddleInitial": "", "maritalStatus": "", "studentStatus": "", "isExpired": "", "isSmoker": "", "isVeteran": "", "notificationPreferenceSelected": "", "preferredLanguageId": "", "preferredLanguage": "", "religionId": "", "churchId": "", "udsHomelessStatusId": "", "udsMigrantWorkerStatusId": "", "udsLanguageBarrierId": "", "udsPrimaryMedicalCoverageId": "", "udsPublicHousingPrimaryCareId": "", "udsSchoolBasedHealthCenterId": "", "udsTribalAffiliationId": "", "udsBloodQuantumId": "", "udsVeteranStatus": "", "isSelfPayer": "", "udsHasConsentToTreat": "", "udsConsentToTreatDate": "", "udsIhsEligibilityStatusId": "", "udsTribalClassId": "", "udsDecendancyId": "", "communityCodeId": "", "currentGender": "", "previousFirstName": "", "sexualOrientation": "", "preferredPronoun": "", "patientStatusId": "", "patientStatusChangeReasonId": "", "userDefinedDemographic1Id": "", "userDefinedDemographic2Id": "", "userDefinedDemographic3Id": "", "userDefinedDemographic4Id": "", "userDefinedDemographic5Id": "", "userDefinedDemographic6Id": "", "userDefinedDemographic7Id": "", "userDefinedDemographic8Id": "", "userDefinedDemographic9Id": "", "userDefinedDemographic10Id": "", "userDefinedDemographic11Id": "", "userDefinedDemographic12Id": "", "userDefinedDemographic13Id": "", "userDefinedDemographic14Id": "", "isCurrentGenderProtected": "", "isGenderIdentityProtected": "", "isPreferredPronounProtected": "", "isSexualOrientationProtected": "", "otherIdNumber": "", "priorLastName": "", "externalId": "", "primaryDentalProviderId": "", "primaryDentalProviderName": "", "nickname": "", "showContactInfoOnAlert": "", "mothersMaidenName": "", "hasEmail": "", "hasPhoneNumber": "", "usesPortal": "", "usesSms": "", "hasVoice": "", "isOptOut": "", "isHomePhoneNotApplicable": "", "isCellPhoneNotApplicable": "", "isAlternatePhoneNotApplicable": "", "isDayPhoneNotApplicable": "", "isSecondaryHomePhoneNotApplicable": "", "isInternationalPhoneNotApplicable": "", "isEmailNotApplicable": "", "expiredDate": "", "expiredTime": "", "expiredTimeTz": "", "birthMothersLastName": "", "birthMothersFirstName": "", "birthMothersMiddleName": "", "exemptFromPersonMerge": "", "addressTypeId": "", "secondaryAddressTypeId": "", "isEnterpriseChart": "", "otherReasonSexualOrientation": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "firstName": "", "lastName": "", "middleName": "", "prefix": "", "prefixId": "", "suffix": "", "suffixId": "", "addressLine1": "", "addressLine2": "", "city": "", "state": "", "zip": "", "countryId": "", "country": "", "countyId": "", "county": "", "secondaryAddressLine1": "", "secondaryAddressLine2": "", "secondaryCity": "", "secondaryState": "", "secondaryZip": "", "secondaryCountryId": "", "secondaryCountry": "", "secondaryCountyId": "", "secondaryCounty": "", "homePhone": "", "homePhoneComment": "", "secondaryHomePhone": "", "secondaryHomePhoneComment": "", "dayPhone": "", "dayPhoneExtension": "", "dayPhoneComment": "", "alternatePhone": "", "alternatePhoneDescription": "", "alternatePhoneExtension": "", "alternatePhoneComment": "", "internationalHomePhone": "", "internationalWorkPhone": "", "internationalZip": "", "cellPhone": "", "cellPhoneComment": "", "email": "", "emailAddressComment": "", "contactSequence": "", "sex": "", "dateOfBirth": "", "age": "", "socialSecurityNumber": "", "contactPreferenceId": "", "contactPreferenceDescription": "", "primaryCareProviderId": "", "primaryCareProviderFullName": "", "primaryCareProviderFirstName": "", "primaryCareProviderLastName": "", "primaryCareProviderMiddleInitial": "", "maritalStatus": "", "studentStatus": "", "isExpired": "", "isSmoker": "", "isVeteran": "", "notificationPreferenceSelected": "", "preferredLanguageId": "", "preferredLanguage": "", "religionId": "", "churchId": "", "udsHomelessStatusId": "", "udsMigrantWorkerStatusId": "", "udsLanguageBarrierId": "", "udsPrimaryMedicalCoverageId": "", "udsPublicHousingPrimaryCareId": "", "udsSchoolBasedHealthCenterId": "", "udsTribalAffiliationId": "", "udsBloodQuantumId": "", "udsVeteranStatus": "", "isSelfPayer": "", "udsHasConsentToTreat": "", "udsConsentToTreatDate": "", "udsIhsEligibilityStatusId": "", "udsTribalClassId": "", "udsDecendancyId": "", "communityCodeId": "", "currentGender": "", "previousFirstName": "", "sexualOrientation": "", "preferredPronoun": "", "patientStatusId": "", "patientStatusChangeReasonId": "", "userDefinedDemographic1Id": "", "userDefinedDemographic2Id": "", "userDefinedDemographic3Id": "", "userDefinedDemographic4Id": "", "userDefinedDemographic5Id": "", "userDefinedDemographic6Id": "", "userDefinedDemographic7Id": "", "userDefinedDemographic8Id": "", "userDefinedDemographic9Id": "", "userDefinedDemographic10Id": "", "userDefinedDemographic11Id": "", "userDefinedDemographic12Id": "", "userDefinedDemographic13Id": "", "userDefinedDemographic14Id": "", "isCurrentGenderProtected": "", "isGenderIdentityProtected": "", "isPreferredPronounProtected": "", "isSexualOrientationProtected": "", "otherIdNumber": "", "priorLastName": "", "externalId": "", "primaryDentalProviderId": "", "primaryDentalProviderName": "", "nickname": "", "showContactInfoOnAlert": "", "mothersMaidenName": "", "hasEmail": "", "hasPhoneNumber": "", "usesPortal": "", "usesSms": "", "hasVoice": "", "isOptOut": "", "isHomePhoneNotApplicable": "", "isCellPhoneNotApplicable": "", "isAlternatePhoneNotApplicable": "", "isDayPhoneNotApplicable": "", "isSecondaryHomePhoneNotApplicable": "", "isInternationalPhoneNotApplicable": "", "isEmailNotApplicable": "", "expiredDate": "", "expiredTime": "", "expiredTimeTz": "", "birthMothersLastName": "", "birthMothersFirstName": "", "birthMothersMiddleName": "", "exemptFromPersonMerge": "", "addressTypeId": "", "secondaryAddressTypeId": "", "isEnterpriseChart": "", "otherReasonSexualOrientation": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "id": "", "description": "", "order": "", "categoryId": "", "categoryName": "", "cdcEthnicityCode": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "id": "", "description": "", "order": "", "categoryId": "", "categoryName": "", "cdcEthnicityCode": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "id": "", "description": "", "order": "", "categoryId": "", "categoryName": "", "cdcRaceCode": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "firstName": "", "lastName": "", "middleName": "", "nickname": "", "addressLine1": "", "addressLine2": "", "city": "", "state": "", "zip": "", "country": "", "homePhone": "", "dateOfBirth": "", "sex": "", "currentGender": "", "socialSecurityNumber": "", "personNumber": "", "medicalRecordNumber": "", "otherIdNumber": "", "isEnterpriseChart": "", "isPatient": "", "canAddToInclusionList": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "Items": [ { "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ], "checkInDateTime": "", "checkInTimezone": "", "checkOutDateTime": "", "checkOutTimezone": "", "encounterNumber": "", "enterpriseId": "", "id": "", "isLocked": "", "isSensitive": "", "locationId": "", "locationName": "", "personId": "", "practiceId": "", "printOnStatements": "", "referringProviderId": "", "referringProviderName": "", "renderingProviderId": "", "renderingProviderName": "", "status": "", "suppressOutreach": "", "suppressPortal": "", "timestamp": "", "timestampTimezone": "" }, { "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ], "checkInDateTime": "", "checkInTimezone": "", "checkOutDateTime": "", "checkOutTimezone": "", "encounterNumber": "", "enterpriseId": "", "id": "", "isLocked": "", "isSensitive": "", "locationId": "", "locationName": "", "personId": "", "practiceId": "", "printOnStatements": "", "referringProviderId": "", "referringProviderName": "", "renderingProviderId": "", "renderingProviderName": "", "status": "", "suppressOutreach": "", "suppressPortal": "", "timestamp": "", "timestampTimezone": "" } ], "NextPageLink": "" } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "personId": "", "description": "", "fullySpecifiedName": "", "isChronic": "", "hasSecondaryCondition": "", "problemStatusId": "", "problemStatus": "", "recentNoteId": "", "lastAddressedDate": "", "onsetDate": "", "resolvedDate": "", "resolvedReason": "", "conceptId": "", "isComorbid": "", "isDeleted": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "enterpriseId": "", "practiceId": "", "personId": "", "description": "", "fullySpecifiedName": "", "conceptId": "", "sideId": "", "site": "", "onsetDate": "", "lastAddressedDate": "", "resolvedDate": "", "resolvedReason": "", "resolvedBy": "", "problemStatusId": "", "problemStatus": "", "recentNoteId": "", "clinicalStatusId": "", "isChronic": "", "hasSecondaryCondition": "", "isDeleted": "", "locationId": "", "providerId": "", "isRecordedElsewhere": "", "recordedElsewhereSource": "", "responsibleProviderId": "", "isComorbid": "", "createdBy": "", "createTimestamp": "", "modifiedBy": "", "modifyTimestamp": "", "createTimestampTimezone": "", "modifyTimestampTimezone": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "isRequired": "", "acknowledged": "", "severityLevel": "", "description": "", "entityName": "", "eventType": "", "sourceId": "", "cause": "", "warningDetail": "", "warningType": "", "warning": "", "causeText": "", "overrideText": "", "durAuditKey": "", "isSuppressed": "", "isRecordedElseWhere": "", "practiceId": "", "display": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "personId": "", "isRequired": "", "acknowledged": "", "severityLevel": "", "description": "", "entityName": "", "eventType": "", "sourceId": "", "cause": "", "warningDetail": "", "warningType": "", "warning": "", "causeText": "", "overrideText": "", "durAuditKey": "", "isSuppressed": "", "isRecordedElseWhere": "", "practiceId": "", "display": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ] }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "problemId": "", "personId": "", "note": "", "createdBy": "", "createTimestamp": "", "modifiedBy": "", "modifyTimestamp": "", "isDeleted": "", "createTimestampTimezone": "", "modifyTimestampTimezone": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "id": "", "problemId": "", "personId": "", "note": "", "createdBy": "", "createTimestamp": "", "modifiedBy": "", "modifyTimestamp": "", "isDeleted": "", "createTimestampTimezone": "", "modifyTimestampTimezone": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "problemId": "", "personId": "", "note": "", "createdBy": "", "createTimestamp": "", "modifiedBy": "", "modifyTimestamp": "", "isDeleted": "", "createTimestampTimezone": "", "modifyTimestampTimezone": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "isRequired": "", "acknowledged": "", "severityLevel": "", "description": "", "entityName": "", "eventType": "", "sourceId": "", "cause": "", "warningDetail": "", "warningType": "", "warning": "", "causeText": "", "overrideText": "", "durAuditKey": "", "isSuppressed": "", "isRecordedElseWhere": "", "practiceId": "", "display": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "personId": "", "isRequired": "", "acknowledged": "", "severityLevel": "", "description": "", "entityName": "", "eventType": "", "sourceId": "", "cause": "", "warningDetail": "", "warningType": "", "warning": "", "causeText": "", "overrideText": "", "durAuditKey": "", "isSuppressed": "", "isRecordedElseWhere": "", "practiceId": "", "display": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ] }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "enterpriseId": "", "practiceId": "", "id": "", "encounterId": "", "encounterTimestamp": "", "serviceItemId": "", "serviceItemDescription": "", "cpt4Code": "", "serviceDate": "", "isDeleted": "", "isCompleted": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "personId": "", "enterpriseId": "", "practiceId": "", "id": "", "encounterId": "", "encounterTimestamp": "", "serviceItemId": "", "serviceItemDescription": "", "cpt4Code": "", "serviceDate": "", "isDeleted": "", "isCompleted": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "encounterId": "", "personId": "", "serviceItemLibraryId": "", "serviceItemGroupName": "", "serviceItemGroupSequenceNumber": "", "serviceItemId": "", "serviceItemDescription": "", "cpt4Code": "", "serviceDate": "", "providerId": "", "referringProviderId": "", "referringProviderName": "", "assistingProviderId": "", "dateResolved": "", "modifierId1": "", "modifierId2": "", "modifierId3": "", "modifierId4": "", "diagnosisCodeId1": "", "diagnosisCodeLibraryId1": "", "diagnosisCodeId2": "", "diagnosisCodeLibraryId2": "", "diagnosisCodeId3": "", "diagnosisCodeLibraryId3": "", "diagnosisCodeId4": "", "diagnosisCodeLibraryId4": "", "placeOfService": "", "hasAcceptedAssignment": "", "units": "", "locationId": "", "payerId": "", "amount": "", "isBillingSuppressed": "", "tooth": "", "surface": "", "quadrant": "", "note": "", "startTime": "", "stopTime": "", "totalTime": "", "baseUnit": "", "alternateCode": "", "isAnesthesiaBilling": "", "diagnosisCodeId5": "", "diagnosisCodeLibraryId5": "", "diagnosisCodeId6": "", "diagnosisCodeLibraryId6": "", "diagnosisCodeId7": "", "diagnosisCodeLibraryId7": "", "diagnosisCodeId8": "", "diagnosisCodeLibraryId8": "", "sourceProductId": "", "isRxOnFile": "", "nationalDrugCode": "", "isBehavioralBilling": "", "diagnosisCodeId9": "", "diagnosisCodeLibraryId9": "", "diagnosisCodeId10": "", "diagnosisCodeLibraryId10": "", "diagnosisCodeId11": "", "diagnosisCodeLibraryId11": "", "diagnosisCodeId12": "", "diagnosisCodeLibraryId12": "", "snomedConceptId": "", "snomedConceptId2": "", "snomedConceptId3": "", "snomedConceptId4": "", "isDental": "", "isSupernumerary": "", "surfaceDescriptor": "", "isDefective": "", "notApplicableDate": "", "approvalDate": "", "medicalDirectorId": "", "asaCrosswalkLibraryId": "", "surgicalProcedureCodeId": "", "surgicalProcedureDescription": "", "basisOfMeasure": "", "nationalDrugUnits": "", "teeth": "", "isDeleted": "", "enterpriseId": "", "practiceId": "", "createdBy": "", "createTimestamp": "", "createTimestampTimezone": "", "modifiedBy": "", "modifyTimestamp": "", "modifyTimestampTimezone": "", "isCompleted": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "enterpriseId": "", "practiceId": "", "encounterDate": "", "tobaccoType": "", "tobaccoStatus": "", "smokingStatus": "", "usagePerDay": "", "packYears": "", "dateQuit": "", "tobaccoHealthConcern": "", "tobaccoCategory": "", "smokingHealthConcern": "", "smokingCategory": "", "id": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "personId": "", "enterpriseId": "", "practiceId": "", "encounterDate": "", "tobaccoType": "", "tobaccoStatus": "", "smokingStatus": "", "usagePerDay": "", "packYears": "", "dateQuit": "", "tobaccoHealthConcern": "", "tobaccoCategory": "", "smokingHealthConcern": "", "smokingCategory": "", "id": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "createTimestampTimezone": "", "createdBy": "", "modifyTimestamp": "", "modifyTimestampTimezone": "", "modifiedBy": "", "enterpriseId": "", "practiceId": "", "personId": "", "encounterId": "", "homeLanguage": "", "birthCountry": "", "handDominance": "", "educationLevel": "", "educationDegree": "", "educationDegreeCountry": "", "occupationalHazard1": "", "occupationalHazard2": "", "hasMilitaryExperience": "", "militaryType": "", "militaryBranch": "", "militaryYearsServed": "", "militaryDischargeType": "", "militaryStationedOverseas": "", "militaryStationedOverseasLocation": "", "militaryNoiseExposure": "", "militaryBiohazardExposure": "", "previousWidowed": "", "previousWidowedTimes": "", "previousDivorce": "", "previousDivorceTimes": "", "hasChildren": "", "sonsCount": "", "daughtersCount": "", "supportNetworkComments": "", "supportNetwork": "", "primaryResidenceComments": "", "tobaccoUsage": "", "tobaccoType": "", "tobaccoUnitsPerDay": "", "tobaccoUnit": "", "tobaccoYearsSmoked": "", "tobaccoPackYears": "", "tobaccoCurrentOrPast": "", "tobaccoPreviousCessationAttempt": "", "tobaccoYearQuit": "", "tobaccoLongestFreePeriod": "", "tobaccoRelapseReason": "", "passiveSmokeExposure": "", "tobaccoCessationMethods": "", "alcoholUsage": "", "caffeineUsage": "", "caffeineType": "", "caffeineType2": "", "caffeinePerDay": "", "activityLevel": "", "healthClubMember": "", "exerciseFrequency": "", "exerciseHoursWeek": "", "exerciseType": "", "exercisetype2": "", "exercisetype3": "", "hobby1": "", "hobby2": "", "hobby3": "", "dietHistory1": "", "dietHistory2": "", "dietHistory3": "", "dietHistory4": "", "dietHistory5": "", "petAnimals": "", "petBirds": "", "petDogs": "", "petRodents": "", "petReptiles": "", "petOther": "", "pets": "", "cleansAnimals": "", "changesInSleepPatterns": "", "religiousAffiliation": "", "practiceReligion": "", "spiritualBeliefs": "", "importanceOfReligionSpirituality": "", "smokeDetectorsInHome": "", "carbonMonoxideDetectorsInHome": "", "radonInHome": "", "homeHeating": "", "seatBeltUsage": "", "fireArmsAtHome": "", "agreesToTransfusion": "", "travelOutOfState": "", "travelOutOfStateLocation": "", "travelOutOfCountry": "", "travelOutOfCounrtyLocation": "", "travelOutOfCountryRegion": "", "travelExposure": "", "travelExposureDetail": "", "advanceDirectivesReviewDate": "", "advanceDirectivesNone": "", "advanceDirectivesRefused": "", "advanceDirectivesDnr": "", "advanceDirectivesLivingWill": "", "advanceDirectivesDoNotPlaceOnLifeSupport": "", "advanceDirectivesDurablePowerOfAttorney": "", "advanceDirectivesHcProxy": "", "advanceDirectivesHcProxyName": "", "advanceDirectivesIncremented": "", "advanceDirectivesDiscussionsCount": "", "comments": "", "alcoholYearQuit": "", "alcoholType": "", "alcoholFrequency": "", "alcoholLastDrink": "", "alcoholAmount": "", "smokingStatus": "", "smokingStatusCode": "", "maritalStatus": "", "religion": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "createTimestamp": "", "createTimestampTimezone": "", "createdBy": "", "modifyTimestamp": "", "modifyTimestampTimezone": "", "modifiedBy": "", "enterpriseId": "", "practiceId": "", "personId": "", "encounterId": "", "homeLanguage": "", "birthCountry": "", "handDominance": "", "educationLevel": "", "educationDegree": "", "educationDegreeCountry": "", "occupationalHazard1": "", "occupationalHazard2": "", "hasMilitaryExperience": "", "militaryType": "", "militaryBranch": "", "militaryYearsServed": "", "militaryDischargeType": "", "militaryStationedOverseas": "", "militaryStationedOverseasLocation": "", "militaryNoiseExposure": "", "militaryBiohazardExposure": "", "previousWidowed": "", "previousWidowedTimes": "", "previousDivorce": "", "previousDivorceTimes": "", "hasChildren": "", "sonsCount": "", "daughtersCount": "", "supportNetworkComments": "", "supportNetwork": "", "primaryResidenceComments": "", "tobaccoUsage": "", "tobaccoType": "", "tobaccoUnitsPerDay": "", "tobaccoUnit": "", "tobaccoYearsSmoked": "", "tobaccoPackYears": "", "tobaccoCurrentOrPast": "", "tobaccoPreviousCessationAttempt": "", "tobaccoYearQuit": "", "tobaccoLongestFreePeriod": "", "tobaccoRelapseReason": "", "passiveSmokeExposure": "", "tobaccoCessationMethods": "", "alcoholUsage": "", "caffeineUsage": "", "caffeineType": "", "caffeineType2": "", "caffeinePerDay": "", "activityLevel": "", "healthClubMember": "", "exerciseFrequency": "", "exerciseHoursWeek": "", "exerciseType": "", "exercisetype2": "", "exercisetype3": "", "hobby1": "", "hobby2": "", "hobby3": "", "dietHistory1": "", "dietHistory2": "", "dietHistory3": "", "dietHistory4": "", "dietHistory5": "", "petAnimals": "", "petBirds": "", "petDogs": "", "petRodents": "", "petReptiles": "", "petOther": "", "pets": "", "cleansAnimals": "", "changesInSleepPatterns": "", "religiousAffiliation": "", "practiceReligion": "", "spiritualBeliefs": "", "importanceOfReligionSpirituality": "", "smokeDetectorsInHome": "", "carbonMonoxideDetectorsInHome": "", "radonInHome": "", "homeHeating": "", "seatBeltUsage": "", "fireArmsAtHome": "", "agreesToTransfusion": "", "travelOutOfState": "", "travelOutOfStateLocation": "", "travelOutOfCountry": "", "travelOutOfCounrtyLocation": "", "travelOutOfCountryRegion": "", "travelExposure": "", "travelExposureDetail": "", "advanceDirectivesReviewDate": "", "advanceDirectivesNone": "", "advanceDirectivesRefused": "", "advanceDirectivesDnr": "", "advanceDirectivesLivingWill": "", "advanceDirectivesDoNotPlaceOnLifeSupport": "", "advanceDirectivesDurablePowerOfAttorney": "", "advanceDirectivesHcProxy": "", "advanceDirectivesHcProxyName": "", "advanceDirectivesIncremented": "", "advanceDirectivesDiscussionsCount": "", "comments": "", "alcoholYearQuit": "", "alcoholType": "", "alcoholFrequency": "", "alcoholLastDrink": "", "alcoholAmount": "", "smokingStatus": "", "smokingStatusCode": "", "maritalStatus": "", "religion": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "personId": "", "sequenceNumber": "", "createTimestamp": "", "maximumTobaccoFreeDuration": "", "packYears": "", "passiveExposure": "", "relapseReason": "", "tobaccoType": "", "socialHistoryTobaccoType": "", "tobaccoUseStatus": "", "totalPackYears": "", "triedToQuit": "", "unitsPerDay": "", "yearQuit": "", "yearsUsed": "", "ageStarted": "", "ageStopped": "", "dateStarted": "", "dateStopped": "", "smokingStatus": "", "tobaccoStatus": "", "usagePerDay": "", "socialHistoryCreateTimestamp": "", "tobaccoUserProfileCode": "", "tobaccoUserProfile": "", "useDailyCigarette": "", "ageStartedCigarette": "", "ageStoppedCigarette": "", "usagePerDayCigarette": "", "useDailyCigarillo": "", "ageStartedCigarillo": "", "ageStoppedCigarillo": "", "usagePerDayCigarillo": "", "useDailyCigar": "", "ageStartedCigar": "", "ageStoppedCigar": "", "usagePerDayCigar": "", "useDailyPipe": "", "ageStartedPipe": "", "ageStoppedPipe": "", "usagePerDayPipe": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "encounterId": "", "personId": "", "sequenceNumber": "", "createTimestamp": "", "maximumTobaccoFreeDuration": "", "packYears": "", "passiveExposure": "", "relapseReason": "", "tobaccoType": "", "socialHistoryTobaccoType": "", "tobaccoUseStatus": "", "totalPackYears": "", "triedToQuit": "", "unitsPerDay": "", "yearQuit": "", "yearsUsed": "", "ageStarted": "", "ageStopped": "", "dateStarted": "", "dateStopped": "", "smokingStatus": "", "tobaccoStatus": "", "usagePerDay": "", "socialHistoryCreateTimestamp": "", "tobaccoUserProfileCode": "", "tobaccoUserProfile": "", "useDailyCigarette": "", "ageStartedCigarette": "", "ageStoppedCigarette": "", "usagePerDayCigarette": "", "useDailyCigarillo": "", "ageStartedCigarillo": "", "ageStoppedCigarillo": "", "usagePerDayCigarillo": "", "useDailyCigar": "", "ageStartedCigar": "", "ageStoppedCigar": "", "usagePerDayCigar": "", "useDailyPipe": "", "ageStartedPipe": "", "ageStoppedPipe": "", "usagePerDayPipe": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "personId": "", "enterpriseId": "", "practiceId": "", "encounterId": "", "vitalSignsDate": "", "vitalSignsTime": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "id": "", "personId": "", "enterpriseId": "", "practiceId": "", "encounterId": "", "vitalSignsDate": "", "vitalSignsTime": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "personId": "", "enterpriseId": "", "practiceId": "", "encounterId": "", "bmi": "", "bloodPressure": "", "bloodPressureSystolic": "", "bloodPressureDiastolic": "", "bloodPressureMethod": "", "bloodPressureSide": "", "bloodPressureBodySite": "", "bloodPressureSite": "", "bloodPressureBodyPosition": "", "isBloodPressureCuffSizePediatric": "", "isBloodPressureCuffSizeAdult": "", "isBloodPressureCuffSizeLarge": "", "isBloodPressureCuffSizeThigh": "", "isBloodPressureCaptured": "", "measuredBy": "", "vitalSignsDate": "", "vitalSignsTime": "", "fractionOfInspiredOxygen": "", "pulsePattern": "", "pulseRate": "", "pulseOximeterOxygenSaturationRest": "", "pulseOximeterOxygenSaturationRestSite": "", "isGrowthChartCaptured": "", "isHealthAssessmentQuestionnaireCaptured": "", "isExclusionCaptured": "", "bmiPercent": "", "bodySurfaceArea": "", "isHipCircumferenceCaptured": "", "isHeadCircumferenceCaptured": "", "isHeightCaptured": "", "isNeckCircumferenceCaptured": "", "isTemperatureCaptured": "", "isWaistCircumferenceCaptured": "", "isWeightCaptured": "", "hasPatientRefused": "", "isUnobtainable": "", "comments": "", "headCircumferenceCentimeters": "", "headCircumferenceInches": "", "headCircumferencePercent": "", "heightCentimeters": "", "heightDate": "", "heightFeet": "", "heightInches": "", "heightMeters": "", "heightMethod": "", "heightPercent": "", "hipCircumferenceCentimeters": "", "hipCircumferenceInches": "", "heightBodyPosition": "", "neckCircumferenceCentimeters": "", "neckCircumferenceInches": "", "pulseOximeterOxygenSaturationSource": "", "painScoreLoinc": "", "painScoreDisplay": "", "peakFlow": "", "peakFlowMethod": "", "peakFlowTiming": "", "respirationRate": "", "pulseOximeterOxygenSaturationMeasured": "", "temperatureDegreesCelcius": "", "temperatureDegreesFahrenheit": "", "temperatureSite": "", "fractionOfInspiredOxygenLitresPerMinute": "", "currentAge": "", "fractionOfInspiredOxygenRoomAir": "", "pulseOximeterOxygenSaturationRestLitresPerMinute": "", "painMethod": "", "pulseOximeterOxygenSaturationAmbulatory": "", "reasonRefused": "", "unobtainableReason": "", "patientRefusedVitals": "", "unobtainableVitals": "", "waistCircumferenceCentimeters": "", "waistCircumferenceInches": "", "waistHipRatio": "", "weightContext": "", "weightKilograms": "", "weightPounds": "", "weightPercent": "", "bloodPressureCuffSize": "", "areOrthostaticVitalSignsCaptured": "", "menopausalStage": "", "lmp": "", "gestationalWeeks": "", "gestationalDays": "", "heightCentimetersGraph": "", "heightInchesGraph": "", "weightKilogramsGraph": "", "weightPoundsGraph": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "personId": "", "enterpriseId": "", "practiceId": "", "encounterId": "", "bmi": "", "bloodPressure": "", "bloodPressureSystolic": "", "bloodPressureDiastolic": "", "bloodPressureMethod": "", "bloodPressureSide": "", "bloodPressureBodySite": "", "bloodPressureSite": "", "bloodPressureBodyPosition": "", "isBloodPressureCuffSizePediatric": "", "isBloodPressureCuffSizeAdult": "", "isBloodPressureCuffSizeLarge": "", "isBloodPressureCuffSizeThigh": "", "isBloodPressureCaptured": "", "measuredBy": "", "vitalSignsDate": "", "vitalSignsTime": "", "fractionOfInspiredOxygen": "", "pulsePattern": "", "pulseRate": "", "pulseOximeterOxygenSaturationRest": "", "pulseOximeterOxygenSaturationRestSite": "", "isGrowthChartCaptured": "", "isHealthAssessmentQuestionnaireCaptured": "", "isExclusionCaptured": "", "bmiPercent": "", "bodySurfaceArea": "", "isHipCircumferenceCaptured": "", "isHeadCircumferenceCaptured": "", "isHeightCaptured": "", "isNeckCircumferenceCaptured": "", "isTemperatureCaptured": "", "isWaistCircumferenceCaptured": "", "isWeightCaptured": "", "hasPatientRefused": "", "isUnobtainable": "", "comments": "", "headCircumferenceCentimeters": "", "headCircumferenceInches": "", "headCircumferencePercent": "", "heightCentimeters": "", "heightDate": "", "heightFeet": "", "heightInches": "", "heightMeters": "", "heightMethod": "", "heightPercent": "", "hipCircumferenceCentimeters": "", "hipCircumferenceInches": "", "heightBodyPosition": "", "neckCircumferenceCentimeters": "", "neckCircumferenceInches": "", "pulseOximeterOxygenSaturationSource": "", "painScoreLoinc": "", "painScoreDisplay": "", "peakFlow": "", "peakFlowMethod": "", "peakFlowTiming": "", "respirationRate": "", "pulseOximeterOxygenSaturationMeasured": "", "temperatureDegreesCelcius": "", "temperatureDegreesFahrenheit": "", "temperatureSite": "", "fractionOfInspiredOxygenLitresPerMinute": "", "currentAge": "", "fractionOfInspiredOxygenRoomAir": "", "pulseOximeterOxygenSaturationRestLitresPerMinute": "", "painMethod": "", "pulseOximeterOxygenSaturationAmbulatory": "", "reasonRefused": "", "unobtainableReason": "", "patientRefusedVitals": "", "unobtainableVitals": "", "waistCircumferenceCentimeters": "", "waistCircumferenceInches": "", "waistHipRatio": "", "weightContext": "", "weightKilograms": "", "weightPounds": "", "weightPercent": "", "bloodPressureCuffSize": "", "areOrthostaticVitalSignsCaptured": "", "menopausalStage": "", "lmp": "", "gestationalWeeks": "", "gestationalDays": "", "heightCentimetersGraph": "", "heightInchesGraph": "", "weightKilogramsGraph": "", "weightPoundsGraph": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "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": "", "personId": "", "enterpriseId": "", "practiceId": "", "encounterId": "", "bmi": "", "bloodPressure": "", "bloodPressureSystolic": "", "bloodPressureDiastolic": "", "bloodPressureMethod": "", "bloodPressureSide": "", "bloodPressureBodySite": "", "bloodPressureSite": "", "bloodPressureBodyPosition": "", "isBloodPressureCuffSizePediatric": "", "isBloodPressureCuffSizeAdult": "", "isBloodPressureCuffSizeLarge": "", "isBloodPressureCuffSizeThigh": "", "isBloodPressureCaptured": "", "measuredBy": "", "vitalSignsDate": "", "vitalSignsTime": "", "fractionOfInspiredOxygen": "", "pulsePattern": "", "pulseRate": "", "pulseOximeterOxygenSaturationRest": "", "pulseOximeterOxygenSaturationRestSite": "", "isGrowthChartCaptured": "", "isHealthAssessmentQuestionnaireCaptured": "", "isExclusionCaptured": "", "bmiPercent": "", "bodySurfaceArea": "", "isHipCircumferenceCaptured": "", "isHeadCircumferenceCaptured": "", "isHeightCaptured": "", "isNeckCircumferenceCaptured": "", "isTemperatureCaptured": "", "isWaistCircumferenceCaptured": "", "isWeightCaptured": "", "hasPatientRefused": "", "isUnobtainable": "", "comments": "", "headCircumferenceCentimeters": "", "headCircumferenceInches": "", "headCircumferencePercent": "", "heightCentimeters": "", "heightDate": "", "heightFeet": "", "heightInches": "", "heightMeters": "", "heightMethod": "", "heightPercent": "", "hipCircumferenceCentimeters": "", "hipCircumferenceInches": "", "heightBodyPosition": "", "neckCircumferenceCentimeters": "", "neckCircumferenceInches": "", "pulseOximeterOxygenSaturationSource": "", "painScoreLoinc": "", "painScoreDisplay": "", "peakFlow": "", "peakFlowMethod": "", "peakFlowTiming": "", "respirationRate": "", "pulseOximeterOxygenSaturationMeasured": "", "temperatureDegreesCelcius": "", "temperatureDegreesFahrenheit": "", "temperatureSite": "", "fractionOfInspiredOxygenLitresPerMinute": "", "currentAge": "", "fractionOfInspiredOxygenRoomAir": "", "pulseOximeterOxygenSaturationRestLitresPerMinute": "", "painMethod": "", "pulseOximeterOxygenSaturationAmbulatory": "", "reasonRefused": "", "unobtainableReason": "", "patientRefusedVitals": "", "unobtainableVitals": "", "waistCircumferenceCentimeters": "", "waistCircumferenceInches": "", "waistHipRatio": "", "weightContext": "", "weightKilograms": "", "weightPounds": "", "weightPercent": "", "bloodPressureCuffSize": "", "areOrthostaticVitalSignsCaptured": "", "menopausalStage": "", "lmp": "", "gestationalWeeks": "", "gestationalDays": "", "heightCentimetersGraph": "", "heightInchesGraph": "", "weightKilogramsGraph": "", "weightPoundsGraph": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } }, "headers": {} }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequest1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Forbidden1" }, "examples": { "application/json": { "message": "" } }, "headers": {} }, "404": { "description": "Not Found", "headers": {} } } } } }, "definitions": { "OK": { "title": "OK", "example": { "Items": [ { "id": "", "enterpriseId": "", "practiceId": "", "personId": "", "encounterId": "", "encounterTimestamp": "", "encounterTimestampTimezone": "", "allergyId": "", "allergyTypeId": "", "description": "", "allergyType": "", "locationId": "", "providerId": "", "onsetDate": "", "resolvedDate": "", "comment": "", "reactionDescription": "", "criticalityCode": "", "isLocked": "", "isReadOnly": "", "rxNormCode": "", "rxNormDescription": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "id": "", "enterpriseId": "", "practiceId": "", "personId": "", "encounterId": "", "encounterTimestamp": "", "encounterTimestampTimezone": "", "allergyId": "", "allergyTypeId": "", "description": "", "allergyType": "", "locationId": "", "providerId": "", "onsetDate": "", "resolvedDate": "", "comment": "", "reactionDescription": "", "criticalityCode": "", "isLocked": "", "isReadOnly": "", "rxNormCode": "", "rxNormDescription": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" }, "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": "", "enterpriseId": "", "practiceId": "", "personId": "", "encounterId": "", "encounterTimestamp": "", "encounterTimestampTimezone": "", "allergyId": "", "allergyTypeId": "", "description": "", "allergyType": "", "locationId": "", "providerId": "", "onsetDate": "", "resolvedDate": "", "comment": "", "reactionDescription": "", "criticalityCode": "", "isLocked": "", "isReadOnly": "", "rxNormCode": "", "rxNormDescription": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "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": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, "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": "" }, "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] }, "Forbidden1": { "title": "Forbidden1", "example": { "message": "" }, "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] }, "OK1": { "title": "OK1", "example": { "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": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "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": "", "enterpriseId": "", "practiceId": "", "personId": "", "encounterId": "", "encounterTimestamp": "", "encounterTimestampTimezone": "", "allergyId": "", "allergyTypeId": "", "description": "", "allergyType": "", "locationId": "", "providerId": "", "onsetDate": "", "resolvedDate": "", "comment": "", "reactionDescription": "", "criticalityCode": "", "isLocked": "", "isReadOnly": "", "rxNormCode": "", "rxNormDescription": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "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": "", "allergyTypeId": "", "onsetDate": "", "resolvedDate": "", "comment": "", "providerId": "", "locationId": "", "isIntolerant": "", "isRecordedElsewhere": "", "recordedElsewhereSource": "", "allowDuplicateAllergies": "", "noKnownAllergies": "", "criticalityCode": "" }, "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": "", "allergyTypeId": "", "onsetDate": "", "resolvedDate": "", "comment": "", "providerId": "", "locationId": "", "isIntolerant": "", "isRecordedElsewhere": "", "recordedElsewhereSource": "", "allowDuplicateAllergies": "", "criticalityCode": "" }, "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": "", "patientAllergyId": "", "reactionDescription": "", "snomedCode": "", "severityCode": "", "severityDescription": "", "rank": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "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": "", "severityCode": "", "rank": "" }, "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": "", "rank": "" }, "type": "object", "properties": { "severityCode": { "type": "string" }, "rank": { "type": "string" } }, "required": [ "severityCode", "rank" ] }, "OK7": { "title": "OK7", "example": { "Items": [ { "enterpriseId": "", "practiceId": "", "encounterId": "", "personId": "", "snomedConceptId": "", "dateOnset": "", "dateResolved": "", "allergyType": "", "encounterTimestamp": "", "allergyComment": "", "id": "", "category": "", "healthConcern": "", "description": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "enterpriseId": "", "practiceId": "", "encounterId": "", "personId": "", "snomedConceptId": "", "dateOnset": "", "dateResolved": "", "allergyType": "", "encounterTimestamp": "", "allergyComment": "", "id": "", "category": "", "healthConcern": "", "description": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" }, "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": "", "practiceId": "", "encounterId": "", "personId": "", "snomedConceptId": "", "dateOnset": "", "dateResolved": "", "allergyType": "", "encounterTimestamp": "", "allergyComment": "", "id": "", "category": "", "healthConcern": "", "description": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "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": "", "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": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "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": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" }, "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": "", "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": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "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": "", "practiceId": "", "personId": "", "id": "", "completedDate": "", "instrument": "", "score": "", "severity": "", "encounterDate": "", "createTimestamp": "", "healthConcern": "", "category": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "enterpriseId": "", "practiceId": "", "personId": "", "id": "", "completedDate": "", "instrument": "", "score": "", "severity": "", "encounterDate": "", "createTimestamp": "", "healthConcern": "", "category": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" }, "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": "", "practiceId": "", "personId": "", "id": "", "completedDate": "", "instrument": "", "score": "", "severity": "", "encounterDate": "", "createTimestamp": "", "healthConcern": "", "category": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "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": "", "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": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "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": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" }, "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": "", "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": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "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": "", "firstName": "", "lastName": "", "email": "", "activeDate": "", "address": "", "agencyName": "", "agencyType": "", "cellPhone": "", "city": "", "fax": "", "homePhone": "", "inactiveDate": "", "patientRelationship": "", "state": "", "supportRole": "", "zip": "" }, "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": "", "firstName": "", "lastName": "", "email": "", "activeDate": "", "address": "", "agencyName": "", "agencyType": "", "cellPhone": "", "city": "", "fax": "", "homePhone": "", "inactiveDate": "", "patientRelationship": "", "state": "", "supportRole": "", "zip": "" }, "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": "", "personId": "", "description": "", "itemType": "", "createTimestamp": "", "createTimestampTimezone": "", "modifyTimestamp": "", "modifyTimestampTimezone": "", "encounterId": "", "isRestricted": "", "signoffStatus": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "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": "", "personId": "", "description": "", "itemType": "", "createTimestamp": "", "createTimestampTimezone": "", "modifyTimestamp": "", "modifyTimestampTimezone": "", "encounterId": "", "categories": [ "", "" ], "totalPages": "", "icsDateOfService": "", "encounterTimestamp": "", "appCreatedBy": "", "docTypeId": "", "isRestricted": "", "signoffStatus": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "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": "", "FileName": "", "MimeType": "" }, "type": "object", "properties": { "FileBytes": { "type": "string" }, "FileName": { "type": "string" }, "MimeType": { "type": "string" } }, "required": [ "FileBytes", "FileName", "MimeType" ] }, "OK17": { "title": "OK17", "example": { "Items": [ { "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": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "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": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" }, "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": "", "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": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "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": "", "codeSystem": "", "codeValue": "", "comments": "", "description": "", "isGoalAchieved": "", "goalAchievedDetails": "", "goalCompletionDate": "", "goalStartDate": "", "isPatientGoal": "", "patientPriority": "", "isProviderGoal": "", "providerPriority": "" }, "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": "", "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": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "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": "", "codeSystem": "", "codeValue": "", "comments": "", "description": "", "isGoalAchieved": "", "goalAchievedDetails": "", "goalCompletionDate": "", "goalStartDate": "", "isPatientGoal": "", "patientPriority": "", "isProviderGoal": "", "providerPriority": "" }, "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": "", "healthConcernId": "", "goalId": "", "detail": "", "category": "", "frequency": "", "progress": "", "reviewDate": "", "startDate": "", "status": "", "codeDescription": "", "codeSystem": "", "codeValue": "", "isDeleted": "", "personId": "", "encounterId": "", "createdBy": "", "createTimestamp": "", "modifiedBy": "", "modifyTimestamp": "", "createTimestampTimezone": "", "modifyTimestampTimezone": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "id": "", "healthConcernId": "", "goalId": "", "detail": "", "category": "", "frequency": "", "progress": "", "reviewDate": "", "startDate": "", "status": "", "codeDescription": "", "codeSystem": "", "codeValue": "", "isDeleted": "", "personId": "", "encounterId": "", "createdBy": "", "createTimestamp": "", "modifiedBy": "", "modifyTimestamp": "", "createTimestampTimezone": "", "modifyTimestampTimezone": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" }, "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": "", "healthConcernId": "", "goalId": "", "detail": "", "category": "", "frequency": "", "progress": "", "reviewDate": "", "startDate": "", "status": "", "codeDescription": "", "codeSystem": "", "codeValue": "", "isDeleted": "", "personId": "", "encounterId": "", "createdBy": "", "createTimestamp": "", "modifiedBy": "", "modifyTimestamp": "", "createTimestampTimezone": "", "modifyTimestampTimezone": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "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": "", "category": "", "categoryId": "", "status": "", "startDate": "", "frequency": "", "nextReviewDate": "", "interventionProgress": "", "codeSystem": "", "codeValue": "", "codeDescription": "" }, "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": "", "healthConcernId": "", "goalId": "", "detail": "", "category": "", "frequency": "", "progress": "", "reviewDate": "", "startDate": "", "status": "", "codeDescription": "", "codeSystem": "", "codeValue": "", "isDeleted": "", "personId": "", "encounterId": "", "createdBy": "", "createTimestamp": "", "modifiedBy": "", "modifyTimestamp": "", "createTimestampTimezone": "", "modifyTimestampTimezone": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "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": "", "category": "", "categoryId": "", "status": "", "startDate": "", "frequency": "", "nextReviewDate": "", "interventionProgress": "", "codeSystem": "", "codeValue": "", "codeDescription": "" }, "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": "", "encounterId": "", "enterpriseId": "", "practiceId": "", "isDeleted": "", "goalAchieved": "", "goalAchievedDetails": "", "goalId": "", "healthConcernId": "", "interventionId": "", "description": "", "outcomeDate": "", "OutcomeId": "", "createdBy": "", "createTimestamp": "", "createTimestampTimeZone": "", "modifiedBy": "", "modifyTimestamp": "", "modifyTimestampTimeZone": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "personId": "", "encounterId": "", "enterpriseId": "", "practiceId": "", "isDeleted": "", "goalAchieved": "", "goalAchievedDetails": "", "goalId": "", "healthConcernId": "", "interventionId": "", "description": "", "outcomeDate": "", "OutcomeId": "", "createdBy": "", "createTimestamp": "", "createTimestampTimeZone": "", "modifiedBy": "", "modifyTimestamp": "", "modifyTimestampTimeZone": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" }, "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": "", "encounterId": "", "enterpriseId": "", "practiceId": "", "isDeleted": "", "goalAchieved": "", "goalAchievedDetails": "", "goalId": "", "healthConcernId": "", "interventionId": "", "description": "", "outcomeDate": "", "OutcomeId": "", "createdBy": "", "createTimestamp": "", "createTimestampTimeZone": "", "modifiedBy": "", "modifyTimestamp": "", "modifyTimestampTimeZone": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "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": "", "goalAchieved": "", "goalAchievedDetails": "", "outcomeDate": "" }, "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": "", "encounterId": "", "enterpriseId": "", "practiceId": "", "isDeleted": "", "goalAchieved": "", "goalAchievedDetails": "", "goalId": "", "healthConcernId": "", "interventionId": "", "description": "", "outcomeDate": "", "OutcomeId": "", "createdBy": "", "createTimestamp": "", "createTimestampTimeZone": "", "modifiedBy": "", "modifyTimestamp": "", "modifyTimestampTimeZone": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "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": "", "goalAchieved": "", "goalAchievedDetails": "", "outcomeDate": "" }, "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": "", "personId": "", "enterpriseId": "", "practiceId": "", "category": "", "comments": "", "description": "", "id": "", "childRecordExists": "", "isDeleted": "", "secondaryTo": "", "identifiedDate": "", "resolvedDate": "", "codeDescription": "", "codeSystem": "", "codeValue": "", "status": "", "sequenceNumber": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "encounterId": "", "personId": "", "enterpriseId": "", "practiceId": "", "category": "", "comments": "", "description": "", "id": "", "childRecordExists": "", "isDeleted": "", "secondaryTo": "", "identifiedDate": "", "resolvedDate": "", "codeDescription": "", "codeSystem": "", "codeValue": "", "status": "", "sequenceNumber": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" }, "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": "", "personId": "", "enterpriseId": "", "practiceId": "", "category": "", "comments": "", "description": "", "id": "", "childRecordExists": "", "isDeleted": "", "secondaryTo": "", "identifiedDate": "", "resolvedDate": "", "codeDescription": "", "codeSystem": "", "codeValue": "", "status": "", "sequenceNumber": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "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": "", "otherCategory": "", "comments": "", "healthConcern": "", "secondaryTo": "", "identifiedDate": "", "categoryId": "", "resolvedDate": "", "codeDescription": "", "codeSystem": "", "codeValue": "", "status": "" }, "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": "", "personId": "", "enterpriseId": "", "practiceId": "", "category": "", "comments": "", "description": "", "id": "", "childRecordExists": "", "isDeleted": "", "secondaryTo": "", "identifiedDate": "", "resolvedDate": "", "codeDescription": "", "codeSystem": "", "codeValue": "", "status": "", "sequenceNumber": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "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": "", "category": "", "description": "", "secondaryTo": "", "identifiedDate": "", "resolvedDate": "", "status": "" }, "type": "object", "properties": { "comments": { "type": "string" }, "category": { "type": "string" }, "description": { "type": "string" }, "secondaryTo": { "type": "string" }, "identifiedDate": { "type": "string" }, "resolvedDate": { "type": "string" }, "status": { "type": "string" } }, "required": [ "comments", "category", "description", "secondaryTo", "identifiedDate", "resolvedDate", "status" ] }, "OK26": { "title": "OK26", "example": { "Items": [ { "encounterDate": "", "description": "", "icdCode": "", "isChronic": "", "id": "", "enterpriseId": "", "practiceId": "", "personId": "", "healthConcern": "", "category": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "encounterDate": "", "description": "", "icdCode": "", "isChronic": "", "id": "", "enterpriseId": "", "practiceId": "", "personId": "", "healthConcern": "", "category": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" }, "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/Item12" } }, "NextPageLink": { "type": "string" }, "Count": { "type": "string" } }, "required": [ "Items", "NextPageLink", "Count" ] }, "Item12": { "title": "Item12", "example": { "encounterDate": "", "description": "", "icdCode": "", "isChronic": "", "id": "", "enterpriseId": "", "practiceId": "", "personId": "", "healthConcern": "", "category": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "encounterDate": { "type": "string" }, "description": { "type": "string" }, "icdCode": { "type": "string" }, "isChronic": { "type": "string" }, "id": { "type": "string" }, "enterpriseId": { "type": "string" }, "practiceId": { "type": "string" }, "personId": { "type": "string" }, "healthConcern": { "type": "string" }, "category": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "encounterDate", "description", "icdCode", "isChronic", "id", "enterpriseId", "practiceId", "personId", "healthConcern", "category", "_links" ] }, "OK28": { "title": "OK28", "example": { "Items": [ { "enterpriseId": "", "practiceId": "", "personId": "", "relationship": "", "familyMember": "", "isDeceased": "", "age": "", "condition": "", "codeSystem": "", "code": "", "id": "", "healthConcern": "", "category": "", "createTimestamp": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "enterpriseId": "", "practiceId": "", "personId": "", "relationship": "", "familyMember": "", "isDeceased": "", "age": "", "condition": "", "codeSystem": "", "code": "", "id": "", "healthConcern": "", "category": "", "createTimestamp": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" }, "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/Item14" } }, "NextPageLink": { "type": "string" }, "Count": { "type": "string" } }, "required": [ "Items", "NextPageLink", "Count" ] }, "Item14": { "title": "Item14", "example": { "enterpriseId": "", "practiceId": "", "personId": "", "relationship": "", "familyMember": "", "isDeceased": "", "age": "", "condition": "", "codeSystem": "", "code": "", "id": "", "healthConcern": "", "category": "", "createTimestamp": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "enterpriseId": { "type": "string" }, "practiceId": { "type": "string" }, "personId": { "type": "string" }, "relationship": { "type": "string" }, "familyMember": { "type": "string" }, "isDeceased": { "type": "string" }, "age": { "type": "string" }, "condition": { "type": "string" }, "codeSystem": { "type": "string" }, "code": { "type": "string" }, "id": { "type": "string" }, "healthConcern": { "type": "string" }, "category": { "type": "string" }, "createTimestamp": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "enterpriseId", "practiceId", "personId", "relationship", "familyMember", "isDeceased", "age", "condition", "codeSystem", "code", "id", "healthConcern", "category", "createTimestamp", "_links" ] }, "OK29": { "title": "OK29", "example": { "Items": [ { "id": "", "lastAddressedDate": "", "onsetDate": "", "description": "", "isChronic": "", "enterpriseId": "", "practiceId": "", "personId": "", "healthConcern": "", "category": "", "snomedId": "", "isDeleted": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "id": "", "lastAddressedDate": "", "onsetDate": "", "description": "", "isChronic": "", "enterpriseId": "", "practiceId": "", "personId": "", "healthConcern": "", "category": "", "snomedId": "", "isDeleted": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" }, "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/Item15" } }, "NextPageLink": { "type": "string" }, "Count": { "type": "string" } }, "required": [ "Items", "NextPageLink", "Count" ] }, "Item15": { "title": "Item15", "example": { "id": "", "lastAddressedDate": "", "onsetDate": "", "description": "", "isChronic": "", "enterpriseId": "", "practiceId": "", "personId": "", "healthConcern": "", "category": "", "snomedId": "", "isDeleted": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "id": { "type": "string" }, "lastAddressedDate": { "type": "string" }, "onsetDate": { "type": "string" }, "description": { "type": "string" }, "isChronic": { "type": "string" }, "enterpriseId": { "type": "string" }, "practiceId": { "type": "string" }, "personId": { "type": "string" }, "healthConcern": { "type": "string" }, "category": { "type": "string" }, "snomedId": { "type": "string" }, "isDeleted": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "id", "lastAddressedDate", "onsetDate", "description", "isChronic", "enterpriseId", "practiceId", "personId", "healthConcern", "category", "snomedId", "isDeleted", "_links" ] }, "OK30": { "title": "OK30", "example": { "Items": [ { "exerciseType": "", "exerciseType2": "", "exerciseType3": "", "exerciseFrequency": "", "exerciseHoursWork": "", "alcoholUsage": "", "alcoholType": "", "alcoholFrequency": "", "amountPerDay": "", "lastAlcoholicBeverage": "", "drugs": "", "drugAge": "", "drugType1": "", "drugFrequency1": "", "drugRoute": "", "drugType2": "", "drugFrequency2": "", "drugRoute2": "", "drugType3": "", "drugFrequency3": "", "drugRoute3": "", "drugTreatment": "", "drugTreatmentCount": "", "drugMedicalAttention": "", "drugMedicalAttentionCount": "", "educationLevel": "", "degree": "", "passiveSmoker": "", "encounterId": "", "enterpriseId": "", "practiceId": "", "personId": "", "encounterTimestamp": "", "tobaccoUserProfile": "", "passiveTobaccoType": "", "passiveLengthExposure": "", "passiveLevelExposure": "", "employmentName": "", "employmentStatus": "", "employmentRestrictions": "", "occupation": "", "employmentRetireDate": "", "employmentId": "", "tobaccoUseHealthConcern": "", "tobaccoUseCategory": "", "exerciseHealthConcern": "", "exerciseCategory": "", "alcoholIntakeHealthConcern": "", "alcoholIntakeCategory": "", "employmentDetailHealthConcern": "", "employmentDetailCategory": "", "drugMisuseBehaviorHealthConcern": "", "drugMisuseBehaviorCategory": "", "educationalAchievementHealthConcern": "", "educationalAchievementCategory": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "exerciseType": "", "exerciseType2": "", "exerciseType3": "", "exerciseFrequency": "", "exerciseHoursWork": "", "alcoholUsage": "", "alcoholType": "", "alcoholFrequency": "", "amountPerDay": "", "lastAlcoholicBeverage": "", "drugs": "", "drugAge": "", "drugType1": "", "drugFrequency1": "", "drugRoute": "", "drugType2": "", "drugFrequency2": "", "drugRoute2": "", "drugType3": "", "drugFrequency3": "", "drugRoute3": "", "drugTreatment": "", "drugTreatmentCount": "", "drugMedicalAttention": "", "drugMedicalAttentionCount": "", "educationLevel": "", "degree": "", "passiveSmoker": "", "encounterId": "", "enterpriseId": "", "practiceId": "", "personId": "", "encounterTimestamp": "", "tobaccoUserProfile": "", "passiveTobaccoType": "", "passiveLengthExposure": "", "passiveLevelExposure": "", "employmentName": "", "employmentStatus": "", "employmentRestrictions": "", "occupation": "", "employmentRetireDate": "", "employmentId": "", "tobaccoUseHealthConcern": "", "tobaccoUseCategory": "", "exerciseHealthConcern": "", "exerciseCategory": "", "alcoholIntakeHealthConcern": "", "alcoholIntakeCategory": "", "employmentDetailHealthConcern": "", "employmentDetailCategory": "", "drugMisuseBehaviorHealthConcern": "", "drugMisuseBehaviorCategory": "", "educationalAchievementHealthConcern": "", "educationalAchievementCategory": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" }, "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/Item16" } }, "NextPageLink": { "type": "string" }, "Count": { "type": "string" } }, "required": [ "Items", "NextPageLink", "Count" ] }, "Item16": { "title": "Item16", "example": { "exerciseType": "", "exerciseType2": "", "exerciseType3": "", "exerciseFrequency": "", "exerciseHoursWork": "", "alcoholUsage": "", "alcoholType": "", "alcoholFrequency": "", "amountPerDay": "", "lastAlcoholicBeverage": "", "drugs": "", "drugAge": "", "drugType1": "", "drugFrequency1": "", "drugRoute": "", "drugType2": "", "drugFrequency2": "", "drugRoute2": "", "drugType3": "", "drugFrequency3": "", "drugRoute3": "", "drugTreatment": "", "drugTreatmentCount": "", "drugMedicalAttention": "", "drugMedicalAttentionCount": "", "educationLevel": "", "degree": "", "passiveSmoker": "", "encounterId": "", "enterpriseId": "", "practiceId": "", "personId": "", "encounterTimestamp": "", "tobaccoUserProfile": "", "passiveTobaccoType": "", "passiveLengthExposure": "", "passiveLevelExposure": "", "employmentName": "", "employmentStatus": "", "employmentRestrictions": "", "occupation": "", "employmentRetireDate": "", "employmentId": "", "tobaccoUseHealthConcern": "", "tobaccoUseCategory": "", "exerciseHealthConcern": "", "exerciseCategory": "", "alcoholIntakeHealthConcern": "", "alcoholIntakeCategory": "", "employmentDetailHealthConcern": "", "employmentDetailCategory": "", "drugMisuseBehaviorHealthConcern": "", "drugMisuseBehaviorCategory": "", "educationalAchievementHealthConcern": "", "educationalAchievementCategory": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "exerciseType": { "type": "string" }, "exerciseType2": { "type": "string" }, "exerciseType3": { "type": "string" }, "exerciseFrequency": { "type": "string" }, "exerciseHoursWork": { "type": "string" }, "alcoholUsage": { "type": "string" }, "alcoholType": { "type": "string" }, "alcoholFrequency": { "type": "string" }, "amountPerDay": { "type": "string" }, "lastAlcoholicBeverage": { "type": "string" }, "drugs": { "type": "string" }, "drugAge": { "type": "string" }, "drugType1": { "type": "string" }, "drugFrequency1": { "type": "string" }, "drugRoute": { "type": "string" }, "drugType2": { "type": "string" }, "drugFrequency2": { "type": "string" }, "drugRoute2": { "type": "string" }, "drugType3": { "type": "string" }, "drugFrequency3": { "type": "string" }, "drugRoute3": { "type": "string" }, "drugTreatment": { "type": "string" }, "drugTreatmentCount": { "type": "string" }, "drugMedicalAttention": { "type": "string" }, "drugMedicalAttentionCount": { "type": "string" }, "educationLevel": { "type": "string" }, "degree": { "type": "string" }, "passiveSmoker": { "type": "string" }, "encounterId": { "type": "string" }, "enterpriseId": { "type": "string" }, "practiceId": { "type": "string" }, "personId": { "type": "string" }, "encounterTimestamp": { "type": "string" }, "tobaccoUserProfile": { "type": "string" }, "passiveTobaccoType": { "type": "string" }, "passiveLengthExposure": { "type": "string" }, "passiveLevelExposure": { "type": "string" }, "employmentName": { "type": "string" }, "employmentStatus": { "type": "string" }, "employmentRestrictions": { "type": "string" }, "occupation": { "type": "string" }, "employmentRetireDate": { "type": "string" }, "employmentId": { "type": "string" }, "tobaccoUseHealthConcern": { "type": "string" }, "tobaccoUseCategory": { "type": "string" }, "exerciseHealthConcern": { "type": "string" }, "exerciseCategory": { "type": "string" }, "alcoholIntakeHealthConcern": { "type": "string" }, "alcoholIntakeCategory": { "type": "string" }, "employmentDetailHealthConcern": { "type": "string" }, "employmentDetailCategory": { "type": "string" }, "drugMisuseBehaviorHealthConcern": { "type": "string" }, "drugMisuseBehaviorCategory": { "type": "string" }, "educationalAchievementHealthConcern": { "type": "string" }, "educationalAchievementCategory": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "exerciseType", "exerciseType2", "exerciseType3", "exerciseFrequency", "exerciseHoursWork", "alcoholUsage", "alcoholType", "alcoholFrequency", "amountPerDay", "lastAlcoholicBeverage", "drugs", "drugAge", "drugType1", "drugFrequency1", "drugRoute", "drugType2", "drugFrequency2", "drugRoute2", "drugType3", "drugFrequency3", "drugRoute3", "drugTreatment", "drugTreatmentCount", "drugMedicalAttention", "drugMedicalAttentionCount", "educationLevel", "degree", "passiveSmoker", "encounterId", "enterpriseId", "practiceId", "personId", "encounterTimestamp", "tobaccoUserProfile", "passiveTobaccoType", "passiveLengthExposure", "passiveLevelExposure", "employmentName", "employmentStatus", "employmentRestrictions", "occupation", "employmentRetireDate", "employmentId", "tobaccoUseHealthConcern", "tobaccoUseCategory", "exerciseHealthConcern", "exerciseCategory", "alcoholIntakeHealthConcern", "alcoholIntakeCategory", "employmentDetailHealthConcern", "employmentDetailCategory", "drugMisuseBehaviorHealthConcern", "drugMisuseBehaviorCategory", "educationalAchievementHealthConcern", "educationalAchievementCategory", "_links" ] }, "OK31": { "title": "OK31", "example": { "Items": [ { "bloodPressureHealthConcern": "", "bloodPressureCategory": "", "bloodPressureSystolicValue": "", "bloodPressureDiastolicValue": "", "bloodPressureUnit": "", "bodyTemperatureHealthConcern": "", "bodyTemperatureCategory": "", "bodyTemperatureValue": "", "bodyTemperatureUnit": "", "headCircumferenceHealthConcern": "", "headCircumferenceCategory": "", "headCircumferenceValue": "", "headCircumferenceUnit": "", "heartRateHealthConcern": "", "heartRateCategory": "", "heartRateValue": "", "heartRateUnit": "", "heightHealthConcern": "", "heightCategory": "", "heightValue": "", "heightUnit": "", "weightHealthConcern": "", "weightCategory": "", "weightValue": "", "weightUnit": "", "bmiHealthConcern": "", "bmiCategory": "", "bmiValue": "", "o2BldCOximetryHealthConcern": "", "o2BldCOximetryCategory": "", "o2BldCOximetryValue": "", "o2BldCOximetryUnit": "", "respiratoryRateHealthConcern": "", "respiratoryRateCategory": "", "respiratoryRateValue": "", "respiratoryRateUnit": "", "id": "", "encounterId": "", "enterpriseId": "", "practiceId": "", "personId": "", "encounterTimestamp": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "bloodPressureHealthConcern": "", "bloodPressureCategory": "", "bloodPressureSystolicValue": "", "bloodPressureDiastolicValue": "", "bloodPressureUnit": "", "bodyTemperatureHealthConcern": "", "bodyTemperatureCategory": "", "bodyTemperatureValue": "", "bodyTemperatureUnit": "", "headCircumferenceHealthConcern": "", "headCircumferenceCategory": "", "headCircumferenceValue": "", "headCircumferenceUnit": "", "heartRateHealthConcern": "", "heartRateCategory": "", "heartRateValue": "", "heartRateUnit": "", "heightHealthConcern": "", "heightCategory": "", "heightValue": "", "heightUnit": "", "weightHealthConcern": "", "weightCategory": "", "weightValue": "", "weightUnit": "", "bmiHealthConcern": "", "bmiCategory": "", "bmiValue": "", "o2BldCOximetryHealthConcern": "", "o2BldCOximetryCategory": "", "o2BldCOximetryValue": "", "o2BldCOximetryUnit": "", "respiratoryRateHealthConcern": "", "respiratoryRateCategory": "", "respiratoryRateValue": "", "respiratoryRateUnit": "", "id": "", "encounterId": "", "enterpriseId": "", "practiceId": "", "personId": "", "encounterTimestamp": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" }, "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/Item17" } }, "NextPageLink": { "type": "string" }, "Count": { "type": "string" } }, "required": [ "Items", "NextPageLink", "Count" ] }, "Item17": { "title": "Item17", "example": { "bloodPressureHealthConcern": "", "bloodPressureCategory": "", "bloodPressureSystolicValue": "", "bloodPressureDiastolicValue": "", "bloodPressureUnit": "", "bodyTemperatureHealthConcern": "", "bodyTemperatureCategory": "", "bodyTemperatureValue": "", "bodyTemperatureUnit": "", "headCircumferenceHealthConcern": "", "headCircumferenceCategory": "", "headCircumferenceValue": "", "headCircumferenceUnit": "", "heartRateHealthConcern": "", "heartRateCategory": "", "heartRateValue": "", "heartRateUnit": "", "heightHealthConcern": "", "heightCategory": "", "heightValue": "", "heightUnit": "", "weightHealthConcern": "", "weightCategory": "", "weightValue": "", "weightUnit": "", "bmiHealthConcern": "", "bmiCategory": "", "bmiValue": "", "o2BldCOximetryHealthConcern": "", "o2BldCOximetryCategory": "", "o2BldCOximetryValue": "", "o2BldCOximetryUnit": "", "respiratoryRateHealthConcern": "", "respiratoryRateCategory": "", "respiratoryRateValue": "", "respiratoryRateUnit": "", "id": "", "encounterId": "", "enterpriseId": "", "practiceId": "", "personId": "", "encounterTimestamp": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "bloodPressureHealthConcern": { "type": "string" }, "bloodPressureCategory": { "type": "string" }, "bloodPressureSystolicValue": { "type": "string" }, "bloodPressureDiastolicValue": { "type": "string" }, "bloodPressureUnit": { "type": "string" }, "bodyTemperatureHealthConcern": { "type": "string" }, "bodyTemperatureCategory": { "type": "string" }, "bodyTemperatureValue": { "type": "string" }, "bodyTemperatureUnit": { "type": "string" }, "headCircumferenceHealthConcern": { "type": "string" }, "headCircumferenceCategory": { "type": "string" }, "headCircumferenceValue": { "type": "string" }, "headCircumferenceUnit": { "type": "string" }, "heartRateHealthConcern": { "type": "string" }, "heartRateCategory": { "type": "string" }, "heartRateValue": { "type": "string" }, "heartRateUnit": { "type": "string" }, "heightHealthConcern": { "type": "string" }, "heightCategory": { "type": "string" }, "heightValue": { "type": "string" }, "heightUnit": { "type": "string" }, "weightHealthConcern": { "type": "string" }, "weightCategory": { "type": "string" }, "weightValue": { "type": "string" }, "weightUnit": { "type": "string" }, "bmiHealthConcern": { "type": "string" }, "bmiCategory": { "type": "string" }, "bmiValue": { "type": "string" }, "o2BldCOximetryHealthConcern": { "type": "string" }, "o2BldCOximetryCategory": { "type": "string" }, "o2BldCOximetryValue": { "type": "string" }, "o2BldCOximetryUnit": { "type": "string" }, "respiratoryRateHealthConcern": { "type": "string" }, "respiratoryRateCategory": { "type": "string" }, "respiratoryRateValue": { "type": "string" }, "respiratoryRateUnit": { "type": "string" }, "id": { "type": "string" }, "encounterId": { "type": "string" }, "enterpriseId": { "type": "string" }, "practiceId": { "type": "string" }, "personId": { "type": "string" }, "encounterTimestamp": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "bloodPressureHealthConcern", "bloodPressureCategory", "bloodPressureSystolicValue", "bloodPressureDiastolicValue", "bloodPressureUnit", "bodyTemperatureHealthConcern", "bodyTemperatureCategory", "bodyTemperatureValue", "bodyTemperatureUnit", "headCircumferenceHealthConcern", "headCircumferenceCategory", "headCircumferenceValue", "headCircumferenceUnit", "heartRateHealthConcern", "heartRateCategory", "heartRateValue", "heartRateUnit", "heightHealthConcern", "heightCategory", "heightValue", "heightUnit", "weightHealthConcern", "weightCategory", "weightValue", "weightUnit", "bmiHealthConcern", "bmiCategory", "bmiValue", "o2BldCOximetryHealthConcern", "o2BldCOximetryCategory", "o2BldCOximetryValue", "o2BldCOximetryUnit", "respiratoryRateHealthConcern", "respiratoryRateCategory", "respiratoryRateValue", "respiratoryRateUnit", "id", "encounterId", "enterpriseId", "practiceId", "personId", "encounterTimestamp", "_links" ] }, "OK32": { "title": "OK32", "example": { "Items": [ { "id": "", "personId": "", "enterpriseId": "", "practiceId": "", "orderId": "", "orderStatus": "", "cvxCode": "", "description": "", "recordSourceCode": "", "recordSourceName": "", "administerCptCode": "", "isDeleted": "", "cptCode": "", "sequenceNumber": "", "status": "", "comment": "", "brandName": "", "siteCode": "", "site": "", "sideCode": "", "side": "", "routeCode": "", "route": "", "unitsCode": "", "units": "", "lotNumber": "", "expirationDate": "", "dose": "", "mvxCode": "", "manufacturerNumber": "", "manufacturerName": "", "notAdministeredReason": "", "notAdministeredCode": "", "purchaseType": "", "strength": "", "administeredYear": "", "administeredMonth": "", "administeredDay": "", "administeredDate": "", "administeredTimestamp": "", "administeredByUserId": "", "administeredByName": "", "auditId": "", "chargeId": "", "adminChargeId": "", "isException": "", "isCounselled": "", "counselledCode": "", "counselledUnit": "", "counselChargeId": "", "consentFrom": "", "consentGivenTo": "", "ndcId": "", "isError": "", "snomedImmunity": "", "isVfc": "", "vfcCode": "", "vfcDate": "", "vfcDateTimezone": "", "fundingSourceCode": "", "simCode": "", "signOffUserId": "", "signOffName": "", "signOffDate": "", "signOffDateTimezone": "", "signoffComment": "", "displayName": "", "hideOnChart": "", "createdBy": "", "createTimestamp": "", "createTimestampTimezone": "", "modifiedByUserId": "", "modifiedByName": "", "modifyTimestamp": "", "modifyTimestampTimezone": "", "overrideInvalidDose": "", "billingUnits": "", "vaccineInventoryId": "", "isReported": "", "wasNotGiven": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "id": "", "personId": "", "enterpriseId": "", "practiceId": "", "orderId": "", "orderStatus": "", "cvxCode": "", "description": "", "recordSourceCode": "", "recordSourceName": "", "administerCptCode": "", "isDeleted": "", "cptCode": "", "sequenceNumber": "", "status": "", "comment": "", "brandName": "", "siteCode": "", "site": "", "sideCode": "", "side": "", "routeCode": "", "route": "", "unitsCode": "", "units": "", "lotNumber": "", "expirationDate": "", "dose": "", "mvxCode": "", "manufacturerNumber": "", "manufacturerName": "", "notAdministeredReason": "", "notAdministeredCode": "", "purchaseType": "", "strength": "", "administeredYear": "", "administeredMonth": "", "administeredDay": "", "administeredDate": "", "administeredTimestamp": "", "administeredByUserId": "", "administeredByName": "", "auditId": "", "chargeId": "", "adminChargeId": "", "isException": "", "isCounselled": "", "counselledCode": "", "counselledUnit": "", "counselChargeId": "", "consentFrom": "", "consentGivenTo": "", "ndcId": "", "isError": "", "snomedImmunity": "", "isVfc": "", "vfcCode": "", "vfcDate": "", "vfcDateTimezone": "", "fundingSourceCode": "", "simCode": "", "signOffUserId": "", "signOffName": "", "signOffDate": "", "signOffDateTimezone": "", "signoffComment": "", "displayName": "", "hideOnChart": "", "createdBy": "", "createTimestamp": "", "createTimestampTimezone": "", "modifiedByUserId": "", "modifiedByName": "", "modifyTimestamp": "", "modifyTimestampTimezone": "", "overrideInvalidDose": "", "billingUnits": "", "vaccineInventoryId": "", "isReported": "", "wasNotGiven": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" }, "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/Item18" } }, "NextPageLink": { "type": "string" }, "Count": { "type": "string" } }, "required": [ "Items", "NextPageLink", "Count" ] }, "Item18": { "title": "Item18", "example": { "id": "", "personId": "", "enterpriseId": "", "practiceId": "", "orderId": "", "orderStatus": "", "cvxCode": "", "description": "", "recordSourceCode": "", "recordSourceName": "", "administerCptCode": "", "isDeleted": "", "cptCode": "", "sequenceNumber": "", "status": "", "comment": "", "brandName": "", "siteCode": "", "site": "", "sideCode": "", "side": "", "routeCode": "", "route": "", "unitsCode": "", "units": "", "lotNumber": "", "expirationDate": "", "dose": "", "mvxCode": "", "manufacturerNumber": "", "manufacturerName": "", "notAdministeredReason": "", "notAdministeredCode": "", "purchaseType": "", "strength": "", "administeredYear": "", "administeredMonth": "", "administeredDay": "", "administeredDate": "", "administeredTimestamp": "", "administeredByUserId": "", "administeredByName": "", "auditId": "", "chargeId": "", "adminChargeId": "", "isException": "", "isCounselled": "", "counselledCode": "", "counselledUnit": "", "counselChargeId": "", "consentFrom": "", "consentGivenTo": "", "ndcId": "", "isError": "", "snomedImmunity": "", "isVfc": "", "vfcCode": "", "vfcDate": "", "vfcDateTimezone": "", "fundingSourceCode": "", "simCode": "", "signOffUserId": "", "signOffName": "", "signOffDate": "", "signOffDateTimezone": "", "signoffComment": "", "displayName": "", "hideOnChart": "", "createdBy": "", "createTimestamp": "", "createTimestampTimezone": "", "modifiedByUserId": "", "modifiedByName": "", "modifyTimestamp": "", "modifyTimestampTimezone": "", "overrideInvalidDose": "", "billingUnits": "", "vaccineInventoryId": "", "isReported": "", "wasNotGiven": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "id": { "type": "string" }, "personId": { "type": "string" }, "enterpriseId": { "type": "string" }, "practiceId": { "type": "string" }, "orderId": { "type": "string" }, "orderStatus": { "type": "string" }, "cvxCode": { "type": "string" }, "description": { "type": "string" }, "recordSourceCode": { "type": "string" }, "recordSourceName": { "type": "string" }, "administerCptCode": { "type": "string" }, "isDeleted": { "type": "string" }, "cptCode": { "type": "string" }, "sequenceNumber": { "type": "string" }, "status": { "type": "string" }, "comment": { "type": "string" }, "brandName": { "type": "string" }, "siteCode": { "type": "string" }, "site": { "type": "string" }, "sideCode": { "type": "string" }, "side": { "type": "string" }, "routeCode": { "type": "string" }, "route": { "type": "string" }, "unitsCode": { "type": "string" }, "units": { "type": "string" }, "lotNumber": { "type": "string" }, "expirationDate": { "type": "string" }, "dose": { "type": "string" }, "mvxCode": { "type": "string" }, "manufacturerNumber": { "type": "string" }, "manufacturerName": { "type": "string" }, "notAdministeredReason": { "type": "string" }, "notAdministeredCode": { "type": "string" }, "purchaseType": { "type": "string" }, "strength": { "type": "string" }, "administeredYear": { "type": "string" }, "administeredMonth": { "type": "string" }, "administeredDay": { "type": "string" }, "administeredDate": { "type": "string" }, "administeredTimestamp": { "type": "string" }, "administeredByUserId": { "type": "string" }, "administeredByName": { "type": "string" }, "auditId": { "type": "string" }, "chargeId": { "type": "string" }, "adminChargeId": { "type": "string" }, "isException": { "type": "string" }, "isCounselled": { "type": "string" }, "counselledCode": { "type": "string" }, "counselledUnit": { "type": "string" }, "counselChargeId": { "type": "string" }, "consentFrom": { "type": "string" }, "consentGivenTo": { "type": "string" }, "ndcId": { "type": "string" }, "isError": { "type": "string" }, "snomedImmunity": { "type": "string" }, "isVfc": { "type": "string" }, "vfcCode": { "type": "string" }, "vfcDate": { "type": "string" }, "vfcDateTimezone": { "type": "string" }, "fundingSourceCode": { "type": "string" }, "simCode": { "type": "string" }, "signOffUserId": { "type": "string" }, "signOffName": { "type": "string" }, "signOffDate": { "type": "string" }, "signOffDateTimezone": { "type": "string" }, "signoffComment": { "type": "string" }, "displayName": { "type": "string" }, "hideOnChart": { "type": "string" }, "createdBy": { "type": "string" }, "createTimestamp": { "type": "string" }, "createTimestampTimezone": { "type": "string" }, "modifiedByUserId": { "type": "string" }, "modifiedByName": { "type": "string" }, "modifyTimestamp": { "type": "string" }, "modifyTimestampTimezone": { "type": "string" }, "overrideInvalidDose": { "type": "string" }, "billingUnits": { "type": "string" }, "vaccineInventoryId": { "type": "string" }, "isReported": { "type": "string" }, "wasNotGiven": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "id", "personId", "enterpriseId", "practiceId", "orderId", "orderStatus", "cvxCode", "description", "recordSourceCode", "recordSourceName", "administerCptCode", "isDeleted", "cptCode", "sequenceNumber", "status", "comment", "brandName", "siteCode", "site", "sideCode", "side", "routeCode", "route", "unitsCode", "units", "lotNumber", "expirationDate", "dose", "mvxCode", "manufacturerNumber", "manufacturerName", "notAdministeredReason", "notAdministeredCode", "purchaseType", "strength", "administeredYear", "administeredMonth", "administeredDay", "administeredDate", "administeredTimestamp", "administeredByUserId", "administeredByName", "auditId", "chargeId", "adminChargeId", "isException", "isCounselled", "counselledCode", "counselledUnit", "counselChargeId", "consentFrom", "consentGivenTo", "ndcId", "isError", "snomedImmunity", "isVfc", "vfcCode", "vfcDate", "vfcDateTimezone", "fundingSourceCode", "simCode", "signOffUserId", "signOffName", "signOffDate", "signOffDateTimezone", "signoffComment", "displayName", "hideOnChart", "createdBy", "createTimestamp", "createTimestampTimezone", "modifiedByUserId", "modifiedByName", "modifyTimestamp", "modifyTimestampTimezone", "overrideInvalidDose", "billingUnits", "vaccineInventoryId", "isReported", "wasNotGiven", "_links" ] }, "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/immunizations/ordersRequest": { "title": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/immunizations/ordersRequest", "example": { "GeneratedBy": "", "LocationId": "", "OrderingProviderId": "", "SupervisorProviderId": "", "RegistryId": "", "Comment": "", "VerbalOrderIndicator": "", "AllergiesReviewed": [ "", "" ] }, "type": "object", "properties": { "GeneratedBy": { "type": "string" }, "LocationId": { "type": "string" }, "OrderingProviderId": { "type": "string" }, "SupervisorProviderId": { "type": "string" }, "RegistryId": { "type": "string" }, "Comment": { "type": "string" }, "VerbalOrderIndicator": { "type": "string" }, "AllergiesReviewed": { "type": "array", "items": { "type": "string" } } }, "required": [ "GeneratedBy", "LocationId", "OrderingProviderId", "SupervisorProviderId", "RegistryId", "Comment", "VerbalOrderIndicator", "AllergiesReviewed" ] }, "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/immunizations/orders/:orderIdRequest": { "title": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/immunizations/orders/:orderIdRequest", "example": { "id": "", "enterpriseId": "", "practiceId": "", "encounterId": "", "personId": "", "personName": "", "userFriendlyOrderNumber": "", "generatedBy": "", "locationId": "", "locationName": "", "orderingProviderId": "", "orderingProviderName": "", "supervisorProviderId": "", "status": "", "vaccineDescription": "", "createTimestamp": "", "createTimestampTimezone": "", "modifyTimestamp": "", "modifyTimestampTimezone": "", "registryId": "", "interfaceMessage": "", "hasDocuments": "", "hasTrackingComments": "", "immunizationsDescription": "", "orderComment": "", "isVerbalOrder": "", "allergiesReviewed": [ "", "" ], "cancelReason": "", "signOffDate": "", "signOffDateTimezone": "", "signOffUserId": "", "signOffUserName": "", "privacyLevel": "", "encounterTimestamp": "", "encounterTimestampTimezone": "", "isDeleted": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "id": { "type": "string" }, "enterpriseId": { "type": "string" }, "practiceId": { "type": "string" }, "encounterId": { "type": "string" }, "personId": { "type": "string" }, "personName": { "type": "string" }, "userFriendlyOrderNumber": { "type": "string" }, "generatedBy": { "type": "string" }, "locationId": { "type": "string" }, "locationName": { "type": "string" }, "orderingProviderId": { "type": "string" }, "orderingProviderName": { "type": "string" }, "supervisorProviderId": { "type": "string" }, "status": { "type": "string" }, "vaccineDescription": { "type": "string" }, "createTimestamp": { "type": "string" }, "createTimestampTimezone": { "type": "string" }, "modifyTimestamp": { "type": "string" }, "modifyTimestampTimezone": { "type": "string" }, "registryId": { "type": "string" }, "interfaceMessage": { "type": "string" }, "hasDocuments": { "type": "string" }, "hasTrackingComments": { "type": "string" }, "immunizationsDescription": { "type": "string" }, "orderComment": { "type": "string" }, "isVerbalOrder": { "type": "string" }, "allergiesReviewed": { "type": "array", "items": { "type": "string" } }, "cancelReason": { "type": "string" }, "signOffDate": { "type": "string" }, "signOffDateTimezone": { "type": "string" }, "signOffUserId": { "type": "string" }, "signOffUserName": { "type": "string" }, "privacyLevel": { "type": "string" }, "encounterTimestamp": { "type": "string" }, "encounterTimestampTimezone": { "type": "string" }, "isDeleted": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "id", "enterpriseId", "practiceId", "encounterId", "personId", "personName", "userFriendlyOrderNumber", "generatedBy", "locationId", "locationName", "orderingProviderId", "orderingProviderName", "supervisorProviderId", "status", "vaccineDescription", "createTimestamp", "createTimestampTimezone", "modifyTimestamp", "modifyTimestampTimezone", "registryId", "interfaceMessage", "hasDocuments", "hasTrackingComments", "immunizationsDescription", "orderComment", "isVerbalOrder", "allergiesReviewed", "cancelReason", "signOffDate", "signOffDateTimezone", "signOffUserId", "signOffUserName", "privacyLevel", "encounterTimestamp", "encounterTimestampTimezone", "isDeleted", "_links" ] }, "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/immunizations/orders/:orderId/vaccinesRequest": { "title": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/immunizations/orders/:orderId/vaccinesRequest", "example": { "AdministerYear": "", "AdministerMonth": "", "AdministerDay": "", "CvxCode": "", "VaccineDescription": "", "RecordSource": "", "Cpt4Code": "", "SequenceNumber": "", "Status": "", "BrandName": "", "SiteCode": "", "Site": "", "RouteCode": "", "Route": "", "UnitsCode": "", "LotNumber": "", "ExpirationDate": "", "Units": "", "Dose": "", "ManufacturerName": "", "NotAdministeredReason": "", "NotAdministeredCode": "", "Comment": "", "ManufacturerNumber": "", "Strength": "", "AdministerBy": "", "AuditId": "", "IsException": "", "IsCounselled": "", "ConsentFrom": "", "NdcId": "", "IsError": "", "SnomedImmunityCode": "", "AdministerTime": "", "VfcCode": "", "FundingSourceCode": "", "IsVfc": "", "OverrideInvalidDose": "", "VaccineInventoryId": "", "BillingUnits": "" }, "type": "object", "properties": { "AdministerYear": { "type": "string" }, "AdministerMonth": { "type": "string" }, "AdministerDay": { "type": "string" }, "CvxCode": { "type": "string" }, "VaccineDescription": { "type": "string" }, "RecordSource": { "type": "string" }, "Cpt4Code": { "type": "string" }, "SequenceNumber": { "type": "string" }, "Status": { "type": "string" }, "BrandName": { "type": "string" }, "SiteCode": { "type": "string" }, "Site": { "type": "string" }, "RouteCode": { "type": "string" }, "Route": { "type": "string" }, "UnitsCode": { "type": "string" }, "LotNumber": { "type": "string" }, "ExpirationDate": { "type": "string" }, "Units": { "type": "string" }, "Dose": { "type": "string" }, "ManufacturerName": { "type": "string" }, "NotAdministeredReason": { "type": "string" }, "NotAdministeredCode": { "type": "string" }, "Comment": { "type": "string" }, "ManufacturerNumber": { "type": "string" }, "Strength": { "type": "string" }, "AdministerBy": { "type": "string" }, "AuditId": { "type": "string" }, "IsException": { "type": "string" }, "IsCounselled": { "type": "string" }, "ConsentFrom": { "type": "string" }, "NdcId": { "type": "string" }, "IsError": { "type": "string" }, "SnomedImmunityCode": { "type": "string" }, "AdministerTime": { "type": "string" }, "VfcCode": { "type": "string" }, "FundingSourceCode": { "type": "string" }, "IsVfc": { "type": "string" }, "OverrideInvalidDose": { "type": "string" }, "VaccineInventoryId": { "type": "string" }, "BillingUnits": { "type": "string" } }, "required": [ "AdministerYear", "AdministerMonth", "AdministerDay", "CvxCode", "VaccineDescription", "RecordSource", "Cpt4Code", "SequenceNumber", "Status", "BrandName", "SiteCode", "Site", "RouteCode", "Route", "UnitsCode", "LotNumber", "ExpirationDate", "Units", "Dose", "ManufacturerName", "NotAdministeredReason", "NotAdministeredCode", "Comment", "ManufacturerNumber", "Strength", "AdministerBy", "AuditId", "IsException", "IsCounselled", "ConsentFrom", "NdcId", "IsError", "SnomedImmunityCode", "AdministerTime", "VfcCode", "FundingSourceCode", "IsVfc", "OverrideInvalidDose", "VaccineInventoryId", "BillingUnits" ] }, "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/immunizations/orders/:orderId/vaccines/:vaccineIdRequest": { "title": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/immunizations/orders/:orderId/vaccines/:vaccineIdRequest", "example": { "id": "", "personId": "", "enterpriseId": "", "practiceId": "", "orderId": "", "orderStatus": "", "cvxCode": "", "description": "", "recordSourceCode": "", "recordSourceName": "", "administerCptCode": "", "isDeleted": "", "cptCode": "", "sequenceNumber": "", "status": "", "comment": "", "brandName": "", "siteCode": "", "site": "", "sideCode": "", "side": "", "routeCode": "", "route": "", "unitsCode": "", "units": "", "lotNumber": "", "expirationDate": "", "dose": "", "mvxCode": "", "manufacturerNumber": "", "manufacturerName": "", "notAdministeredReason": "", "notAdministeredCode": "", "purchaseType": "", "strength": "", "administeredYear": "", "administeredMonth": "", "administeredDay": "", "administeredDate": "", "administeredTimestamp": "", "administeredByUserId": "", "administeredByName": "", "auditId": "", "chargeId": "", "adminChargeId": "", "isException": "", "isCounselled": "", "counselledCode": "", "counselledUnit": "", "counselChargeId": "", "consentFrom": "", "consentGivenTo": "", "ndcId": "", "isError": "", "snomedImmunity": "", "isVfc": "", "vfcCode": "", "vfcDate": "", "vfcDateTimezone": "", "fundingSourceCode": "", "simCode": "", "signOffUserId": "", "signOffName": "", "signOffDate": "", "signOffDateTimezone": "", "signoffComment": "", "displayName": "", "hideOnChart": "", "createdBy": "", "createTimestamp": "", "createTimestampTimezone": "", "modifiedByUserId": "", "modifiedByName": "", "modifyTimestamp": "", "modifyTimestampTimezone": "", "overrideInvalidDose": "", "billingUnits": "", "vaccineInventoryId": "", "isReported": "", "wasNotGiven": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "id": { "type": "string" }, "personId": { "type": "string" }, "enterpriseId": { "type": "string" }, "practiceId": { "type": "string" }, "orderId": { "type": "string" }, "orderStatus": { "type": "string" }, "cvxCode": { "type": "string" }, "description": { "type": "string" }, "recordSourceCode": { "type": "string" }, "recordSourceName": { "type": "string" }, "administerCptCode": { "type": "string" }, "isDeleted": { "type": "string" }, "cptCode": { "type": "string" }, "sequenceNumber": { "type": "string" }, "status": { "type": "string" }, "comment": { "type": "string" }, "brandName": { "type": "string" }, "siteCode": { "type": "string" }, "site": { "type": "string" }, "sideCode": { "type": "string" }, "side": { "type": "string" }, "routeCode": { "type": "string" }, "route": { "type": "string" }, "unitsCode": { "type": "string" }, "units": { "type": "string" }, "lotNumber": { "type": "string" }, "expirationDate": { "type": "string" }, "dose": { "type": "string" }, "mvxCode": { "type": "string" }, "manufacturerNumber": { "type": "string" }, "manufacturerName": { "type": "string" }, "notAdministeredReason": { "type": "string" }, "notAdministeredCode": { "type": "string" }, "purchaseType": { "type": "string" }, "strength": { "type": "string" }, "administeredYear": { "type": "string" }, "administeredMonth": { "type": "string" }, "administeredDay": { "type": "string" }, "administeredDate": { "type": "string" }, "administeredTimestamp": { "type": "string" }, "administeredByUserId": { "type": "string" }, "administeredByName": { "type": "string" }, "auditId": { "type": "string" }, "chargeId": { "type": "string" }, "adminChargeId": { "type": "string" }, "isException": { "type": "string" }, "isCounselled": { "type": "string" }, "counselledCode": { "type": "string" }, "counselledUnit": { "type": "string" }, "counselChargeId": { "type": "string" }, "consentFrom": { "type": "string" }, "consentGivenTo": { "type": "string" }, "ndcId": { "type": "string" }, "isError": { "type": "string" }, "snomedImmunity": { "type": "string" }, "isVfc": { "type": "string" }, "vfcCode": { "type": "string" }, "vfcDate": { "type": "string" }, "vfcDateTimezone": { "type": "string" }, "fundingSourceCode": { "type": "string" }, "simCode": { "type": "string" }, "signOffUserId": { "type": "string" }, "signOffName": { "type": "string" }, "signOffDate": { "type": "string" }, "signOffDateTimezone": { "type": "string" }, "signoffComment": { "type": "string" }, "displayName": { "type": "string" }, "hideOnChart": { "type": "string" }, "createdBy": { "type": "string" }, "createTimestamp": { "type": "string" }, "createTimestampTimezone": { "type": "string" }, "modifiedByUserId": { "type": "string" }, "modifiedByName": { "type": "string" }, "modifyTimestamp": { "type": "string" }, "modifyTimestampTimezone": { "type": "string" }, "overrideInvalidDose": { "type": "string" }, "billingUnits": { "type": "string" }, "vaccineInventoryId": { "type": "string" }, "isReported": { "type": "string" }, "wasNotGiven": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "id", "personId", "enterpriseId", "practiceId", "orderId", "orderStatus", "cvxCode", "description", "recordSourceCode", "recordSourceName", "administerCptCode", "isDeleted", "cptCode", "sequenceNumber", "status", "comment", "brandName", "siteCode", "site", "sideCode", "side", "routeCode", "route", "unitsCode", "units", "lotNumber", "expirationDate", "dose", "mvxCode", "manufacturerNumber", "manufacturerName", "notAdministeredReason", "notAdministeredCode", "purchaseType", "strength", "administeredYear", "administeredMonth", "administeredDay", "administeredDate", "administeredTimestamp", "administeredByUserId", "administeredByName", "auditId", "chargeId", "adminChargeId", "isException", "isCounselled", "counselledCode", "counselledUnit", "counselChargeId", "consentFrom", "consentGivenTo", "ndcId", "isError", "snomedImmunity", "isVfc", "vfcCode", "vfcDate", "vfcDateTimezone", "fundingSourceCode", "simCode", "signOffUserId", "signOffName", "signOffDate", "signOffDateTimezone", "signoffComment", "displayName", "hideOnChart", "createdBy", "createTimestamp", "createTimestampTimezone", "modifiedByUserId", "modifiedByName", "modifyTimestamp", "modifyTimestampTimezone", "overrideInvalidDose", "billingUnits", "vaccineInventoryId", "isReported", "wasNotGiven", "_links" ] }, "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/immunizations/orders/:orderId/vaccines/:vaccineId/vis-histories-Request": { "title": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/immunizations/orders/:orderId/vaccines/:vaccineId/vis-histories-Request", "example": { "VaccineVisId": "", "VisGiveDate": "", "VisPublishDate": "" }, "type": "object", "properties": { "VaccineVisId": { "type": "string" }, "VisGiveDate": { "type": "string" }, "VisPublishDate": { "type": "string" } }, "required": [ "VaccineVisId", "VisGiveDate", "VisPublishDate" ] }, "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/immunizations/orders/:orderId/vaccines/:vaccineId/vis-histories/:visId-Request": { "title": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/immunizations/orders/:orderId/vaccines/:vaccineId/vis-histories/:visId-Request", "example": { "vaccineVisId": "", "orderVaccineId": "", "personId": "", "orderId": "", "visGiveDate": "", "visGiveDateTimeZone": "", "visPublishDate": "", "givenVisId": "", "vaccineType": "", "visDocumentType": "", "createdBy": "", "visDescription": "", "languageId": "", "givenBy": "", "languageName": "", "visHistoryPublishDate": "", "givenVisVaccineType": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "vaccineVisId": { "type": "string" }, "orderVaccineId": { "type": "string" }, "personId": { "type": "string" }, "orderId": { "type": "string" }, "visGiveDate": { "type": "string" }, "visGiveDateTimeZone": { "type": "string" }, "visPublishDate": { "type": "string" }, "givenVisId": { "type": "string" }, "vaccineType": { "type": "string" }, "visDocumentType": { "type": "string" }, "createdBy": { "type": "string" }, "visDescription": { "type": "string" }, "languageId": { "type": "string" }, "givenBy": { "type": "string" }, "languageName": { "type": "string" }, "visHistoryPublishDate": { "type": "string" }, "givenVisVaccineType": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "vaccineVisId", "orderVaccineId", "personId", "orderId", "visGiveDate", "visGiveDateTimeZone", "visPublishDate", "givenVisId", "vaccineType", "visDocumentType", "createdBy", "visDescription", "languageId", "givenBy", "languageName", "visHistoryPublishDate", "givenVisVaccineType", "_links" ] }, "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/immunizations/orders/:orderId/vaccines/:vaccineId/wasted-vaccines-Request": { "title": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/immunizations/orders/:orderId/vaccines/:vaccineId/wasted-vaccines-Request", "example": { "LotNumber": "", "ManufacturerName": "", "ManufacturerNumber": "", "Strength": "", "Units": "", "UnitsCode": "", "Dose": "", "Route": "", "RouteCode": "", "Site": "", "SiteCode": "", "BrandName": "", "WastedReason": "", "WastedDate": "", "VaccineInventoryId": "", "BillingUnits": "" }, "type": "object", "properties": { "LotNumber": { "type": "string" }, "ManufacturerName": { "type": "string" }, "ManufacturerNumber": { "type": "string" }, "Strength": { "type": "string" }, "Units": { "type": "string" }, "UnitsCode": { "type": "string" }, "Dose": { "type": "string" }, "Route": { "type": "string" }, "RouteCode": { "type": "string" }, "Site": { "type": "string" }, "SiteCode": { "type": "string" }, "BrandName": { "type": "string" }, "WastedReason": { "type": "string" }, "WastedDate": { "type": "string" }, "VaccineInventoryId": { "type": "string" }, "BillingUnits": { "type": "string" } }, "required": [ "LotNumber", "ManufacturerName", "ManufacturerNumber", "Strength", "Units", "UnitsCode", "Dose", "Route", "RouteCode", "Site", "SiteCode", "BrandName", "WastedReason", "WastedDate", "VaccineInventoryId", "BillingUnits" ] }, "OK34": { "title": "OK34", "example": { "personId": "", "administeredDate": "", "groupName": "", "statusCode": "", "statusMessage": "", "orderVaccineId": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "personId": { "type": "string" }, "administeredDate": { "type": "string" }, "groupName": { "type": "string" }, "statusCode": { "type": "string" }, "statusMessage": { "type": "string" }, "orderVaccineId": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "personId", "administeredDate", "groupName", "statusCode", "statusMessage", "orderVaccineId", "_links" ] }, "OK35": { "title": "OK35", "example": { "Items": [ { "id": "", "personId": "", "enterpriseId": "", "practiceId": "", "cvxCode": "", "name": "", "reasons": [ "", "" ], "startDate": "", "endDate": "", "comment": "", "createdBy": "", "createTimestamp": "", "modifiedBy": "", "modifyTimestamp": "", "practiceName": "", "excludedBy": "", "isDeleted": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "id": "", "personId": "", "enterpriseId": "", "practiceId": "", "cvxCode": "", "name": "", "reasons": [ "", "" ], "startDate": "", "endDate": "", "comment": "", "createdBy": "", "createTimestamp": "", "modifiedBy": "", "modifyTimestamp": "", "practiceName": "", "excludedBy": "", "isDeleted": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" }, "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/Item20" } }, "NextPageLink": { "type": "string" }, "Count": { "type": "string" } }, "required": [ "Items", "NextPageLink", "Count" ] }, "Item20": { "title": "Item20", "example": { "id": "", "personId": "", "enterpriseId": "", "practiceId": "", "cvxCode": "", "name": "", "reasons": [ "", "" ], "startDate": "", "endDate": "", "comment": "", "createdBy": "", "createTimestamp": "", "modifiedBy": "", "modifyTimestamp": "", "practiceName": "", "excludedBy": "", "isDeleted": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "id": { "type": "string" }, "personId": { "type": "string" }, "enterpriseId": { "type": "string" }, "practiceId": { "type": "string" }, "cvxCode": { "type": "string" }, "name": { "type": "string" }, "reasons": { "type": "array", "items": { "type": "string" } }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "comment": { "type": "string" }, "createdBy": { "type": "string" }, "createTimestamp": { "type": "string" }, "modifiedBy": { "type": "string" }, "modifyTimestamp": { "type": "string" }, "practiceName": { "type": "string" }, "excludedBy": { "type": "string" }, "isDeleted": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "id", "personId", "enterpriseId", "practiceId", "cvxCode", "name", "reasons", "startDate", "endDate", "comment", "createdBy", "createTimestamp", "modifiedBy", "modifyTimestamp", "practiceName", "excludedBy", "isDeleted", "_links" ] }, "{{baseUrl}}/persons/:personId/chart/immunizations/exclusionsRequest": { "title": "{{baseUrl}}/persons/:personId/chart/immunizations/exclusionsRequest", "example": { "CvxCode": "", "Reasons": [ "", "" ], "StartDate": "", "EndDate": "", "Comment": "" }, "type": "object", "properties": { "CvxCode": { "type": "string" }, "Reasons": { "type": "array", "items": { "type": "string" } }, "StartDate": { "type": "string" }, "EndDate": { "type": "string" }, "Comment": { "type": "string" } }, "required": [ "CvxCode", "Reasons", "StartDate", "EndDate", "Comment" ] }, "{{baseUrl}}/persons/:personId/chart/immunizations/exclusions/:exclusionIdRequest": { "title": "{{baseUrl}}/persons/:personId/chart/immunizations/exclusions/:exclusionIdRequest", "example": { "id": "", "personId": "", "enterpriseId": "", "practiceId": "", "cvxCode": "", "name": "", "reasons": [ "", "" ], "startDate": "", "endDate": "", "comment": "", "createdBy": "", "createTimestamp": "", "modifiedBy": "", "modifyTimestamp": "", "practiceName": "", "excludedBy": "", "isDeleted": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "id": { "type": "string" }, "personId": { "type": "string" }, "enterpriseId": { "type": "string" }, "practiceId": { "type": "string" }, "cvxCode": { "type": "string" }, "name": { "type": "string" }, "reasons": { "type": "array", "items": { "type": "string" } }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "comment": { "type": "string" }, "createdBy": { "type": "string" }, "createTimestamp": { "type": "string" }, "modifiedBy": { "type": "string" }, "modifyTimestamp": { "type": "string" }, "practiceName": { "type": "string" }, "excludedBy": { "type": "string" }, "isDeleted": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "id", "personId", "enterpriseId", "practiceId", "cvxCode", "name", "reasons", "startDate", "endDate", "comment", "createdBy", "createTimestamp", "modifiedBy", "modifyTimestamp", "practiceName", "excludedBy", "isDeleted", "_links" ] }, "OK36": { "title": "OK36", "example": { "groupName": "", "personId": "", "isStatusProcessedSuccessfully": "", "isRuleFound": "", "referenceDate": "", "personDateOfBirth": "", "cdcStartMonth": "", "cdcEndMonth": "", "nextDueDate": "", "status": "", "statusCalculationCode": "", "doseSequenceStatusCalulatedFor": "", "groupMinimumAgeInDays": "", "groupMaximumAgeInDays": "", "doseMinimumAgeInDays": "", "doseMaximumAgeInDays": "", "cvxToAdminister": "", "vaccineToAdminister": "", "totalDoses": "", "statusCalculationMessage": "", "nextDueDateCalculationMessage": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "groupName": { "type": "string" }, "personId": { "type": "string" }, "isStatusProcessedSuccessfully": { "type": "string" }, "isRuleFound": { "type": "string" }, "referenceDate": { "type": "string" }, "personDateOfBirth": { "type": "string" }, "cdcStartMonth": { "type": "string" }, "cdcEndMonth": { "type": "string" }, "nextDueDate": { "type": "string" }, "status": { "type": "string" }, "statusCalculationCode": { "type": "string" }, "doseSequenceStatusCalulatedFor": { "type": "string" }, "groupMinimumAgeInDays": { "type": "string" }, "groupMaximumAgeInDays": { "type": "string" }, "doseMinimumAgeInDays": { "type": "string" }, "doseMaximumAgeInDays": { "type": "string" }, "cvxToAdminister": { "type": "string" }, "vaccineToAdminister": { "type": "string" }, "totalDoses": { "type": "string" }, "statusCalculationMessage": { "type": "string" }, "nextDueDateCalculationMessage": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "groupName", "personId", "isStatusProcessedSuccessfully", "isRuleFound", "referenceDate", "personDateOfBirth", "cdcStartMonth", "cdcEndMonth", "nextDueDate", "status", "statusCalculationCode", "doseSequenceStatusCalulatedFor", "groupMinimumAgeInDays", "groupMaximumAgeInDays", "doseMinimumAgeInDays", "doseMaximumAgeInDays", "cvxToAdminister", "vaccineToAdminister", "totalDoses", "statusCalculationMessage", "nextDueDateCalculationMessage", "_links" ] }, "OK37": { "title": "OK37", "example": { "personId": "", "isRequired": "", "acknowledged": "", "severityLevel": "", "description": "", "entityName": "", "eventType": "", "sourceId": "", "cause": "", "warningDetail": "", "warningType": "", "warning": "", "causeText": "", "overrideText": "", "durAuditKey": "", "isSuppressed": "", "isRecordedElseWhere": "", "practiceId": "", "display": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "personId": { "type": "string" }, "isRequired": { "type": "string" }, "acknowledged": { "type": "string" }, "severityLevel": { "type": "string" }, "description": { "type": "string" }, "entityName": { "type": "string" }, "eventType": { "type": "string" }, "sourceId": { "type": "string" }, "cause": { "type": "string" }, "warningDetail": { "type": "string" }, "warningType": { "type": "string" }, "warning": { "type": "string" }, "causeText": { "type": "string" }, "overrideText": { "type": "string" }, "durAuditKey": { "type": "string" }, "isSuppressed": { "type": "string" }, "isRecordedElseWhere": { "type": "string" }, "practiceId": { "type": "string" }, "display": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "personId", "isRequired", "acknowledged", "severityLevel", "description", "entityName", "eventType", "sourceId", "cause", "warningDetail", "warningType", "warning", "causeText", "overrideText", "durAuditKey", "isSuppressed", "isRecordedElseWhere", "practiceId", "display", "_links" ] }, "OK38": { "title": "OK38", "example": { "Items": [ { "id": "", "enterpriseId": "", "practiceId": "", "encounterId": "", "personId": "", "userFriendlyOrderNumber": "", "orderingProviderId": "", "orderingProviderName": "", "supervisorProviderId": "", "status": "", "vaccineDescription": "", "createTimestamp": "", "createTimestampTimezone": "", "modifyTimestamp": "", "modifyTimestampTimezone": "", "isDeleted": "", "hasDocuments": "", "hasTrackingComments": "", "immunizationsDescription": "", "isVerbalOrder": "", "encounterTimestamp": "", "encounterTimestampTimezone": "", "locationId": "", "locationName": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "id": "", "enterpriseId": "", "practiceId": "", "encounterId": "", "personId": "", "userFriendlyOrderNumber": "", "orderingProviderId": "", "orderingProviderName": "", "supervisorProviderId": "", "status": "", "vaccineDescription": "", "createTimestamp": "", "createTimestampTimezone": "", "modifyTimestamp": "", "modifyTimestampTimezone": "", "isDeleted": "", "hasDocuments": "", "hasTrackingComments": "", "immunizationsDescription": "", "isVerbalOrder": "", "encounterTimestamp": "", "encounterTimestampTimezone": "", "locationId": "", "locationName": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" }, "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/Item21" } }, "NextPageLink": { "type": "string" }, "Count": { "type": "string" } }, "required": [ "Items", "NextPageLink", "Count" ] }, "Item21": { "title": "Item21", "example": { "id": "", "enterpriseId": "", "practiceId": "", "encounterId": "", "personId": "", "userFriendlyOrderNumber": "", "orderingProviderId": "", "orderingProviderName": "", "supervisorProviderId": "", "status": "", "vaccineDescription": "", "createTimestamp": "", "createTimestampTimezone": "", "modifyTimestamp": "", "modifyTimestampTimezone": "", "isDeleted": "", "hasDocuments": "", "hasTrackingComments": "", "immunizationsDescription": "", "isVerbalOrder": "", "encounterTimestamp": "", "encounterTimestampTimezone": "", "locationId": "", "locationName": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "id": { "type": "string" }, "enterpriseId": { "type": "string" }, "practiceId": { "type": "string" }, "encounterId": { "type": "string" }, "personId": { "type": "string" }, "userFriendlyOrderNumber": { "type": "string" }, "orderingProviderId": { "type": "string" }, "orderingProviderName": { "type": "string" }, "supervisorProviderId": { "type": "string" }, "status": { "type": "string" }, "vaccineDescription": { "type": "string" }, "createTimestamp": { "type": "string" }, "createTimestampTimezone": { "type": "string" }, "modifyTimestamp": { "type": "string" }, "modifyTimestampTimezone": { "type": "string" }, "isDeleted": { "type": "string" }, "hasDocuments": { "type": "string" }, "hasTrackingComments": { "type": "string" }, "immunizationsDescription": { "type": "string" }, "isVerbalOrder": { "type": "string" }, "encounterTimestamp": { "type": "string" }, "encounterTimestampTimezone": { "type": "string" }, "locationId": { "type": "string" }, "locationName": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "id", "enterpriseId", "practiceId", "encounterId", "personId", "userFriendlyOrderNumber", "orderingProviderId", "orderingProviderName", "supervisorProviderId", "status", "vaccineDescription", "createTimestamp", "createTimestampTimezone", "modifyTimestamp", "modifyTimestampTimezone", "isDeleted", "hasDocuments", "hasTrackingComments", "immunizationsDescription", "isVerbalOrder", "encounterTimestamp", "encounterTimestampTimezone", "locationId", "locationName", "_links" ] }, "OK39": { "title": "OK39", "example": { "id": "", "enterpriseId": "", "practiceId": "", "encounterId": "", "personId": "", "personName": "", "userFriendlyOrderNumber": "", "generatedBy": "", "locationId": "", "locationName": "", "orderingProviderId": "", "orderingProviderName": "", "supervisorProviderId": "", "status": "", "vaccineDescription": "", "createTimestamp": "", "createTimestampTimezone": "", "modifyTimestamp": "", "modifyTimestampTimezone": "", "registryId": "", "interfaceMessage": "", "hasDocuments": "", "hasTrackingComments": "", "immunizationsDescription": "", "orderComment": "", "isVerbalOrder": "", "allergiesReviewed": [ "", "" ], "cancelReason": "", "signOffDate": "", "signOffDateTimezone": "", "signOffUserId": "", "signOffUserName": "", "privacyLevel": "", "encounterTimestamp": "", "encounterTimestampTimezone": "", "isDeleted": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "id": { "type": "string" }, "enterpriseId": { "type": "string" }, "practiceId": { "type": "string" }, "encounterId": { "type": "string" }, "personId": { "type": "string" }, "personName": { "type": "string" }, "userFriendlyOrderNumber": { "type": "string" }, "generatedBy": { "type": "string" }, "locationId": { "type": "string" }, "locationName": { "type": "string" }, "orderingProviderId": { "type": "string" }, "orderingProviderName": { "type": "string" }, "supervisorProviderId": { "type": "string" }, "status": { "type": "string" }, "vaccineDescription": { "type": "string" }, "createTimestamp": { "type": "string" }, "createTimestampTimezone": { "type": "string" }, "modifyTimestamp": { "type": "string" }, "modifyTimestampTimezone": { "type": "string" }, "registryId": { "type": "string" }, "interfaceMessage": { "type": "string" }, "hasDocuments": { "type": "string" }, "hasTrackingComments": { "type": "string" }, "immunizationsDescription": { "type": "string" }, "orderComment": { "type": "string" }, "isVerbalOrder": { "type": "string" }, "allergiesReviewed": { "type": "array", "items": { "type": "string" } }, "cancelReason": { "type": "string" }, "signOffDate": { "type": "string" }, "signOffDateTimezone": { "type": "string" }, "signOffUserId": { "type": "string" }, "signOffUserName": { "type": "string" }, "privacyLevel": { "type": "string" }, "encounterTimestamp": { "type": "string" }, "encounterTimestampTimezone": { "type": "string" }, "isDeleted": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "id", "enterpriseId", "practiceId", "encounterId", "personId", "personName", "userFriendlyOrderNumber", "generatedBy", "locationId", "locationName", "orderingProviderId", "orderingProviderName", "supervisorProviderId", "status", "vaccineDescription", "createTimestamp", "createTimestampTimezone", "modifyTimestamp", "modifyTimestampTimezone", "registryId", "interfaceMessage", "hasDocuments", "hasTrackingComments", "immunizationsDescription", "orderComment", "isVerbalOrder", "allergiesReviewed", "cancelReason", "signOffDate", "signOffDateTimezone", "signOffUserId", "signOffUserName", "privacyLevel", "encounterTimestamp", "encounterTimestampTimezone", "isDeleted", "_links" ] }, "OK40": { "title": "OK40", "example": { "id": "", "personId": "", "personPayerId": "", "payerId": "", "insuredPersonId": "", "cob": "", "orderId": "", "payerName": "", "insuredPersonName": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "id": { "type": "string" }, "personId": { "type": "string" }, "personPayerId": { "type": "string" }, "payerId": { "type": "string" }, "insuredPersonId": { "type": "string" }, "cob": { "type": "string" }, "orderId": { "type": "string" }, "payerName": { "type": "string" }, "insuredPersonName": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "id", "personId", "personPayerId", "payerId", "insuredPersonId", "cob", "orderId", "payerName", "insuredPersonName", "_links" ] }, "OK41": { "title": "OK41", "example": { "id": "", "orderId": "", "personId": "", "providerId": "", "authorName": "", "authorDisplayName": "", "userName": "", "isDelegate": "", "createTimestamp": "", "createTimestampTimezone": "", "comment": "", "type": "", "generatedBy": "", "isAutoGenerated": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "id": { "type": "string" }, "orderId": { "type": "string" }, "personId": { "type": "string" }, "providerId": { "type": "string" }, "authorName": { "type": "string" }, "authorDisplayName": { "type": "string" }, "userName": { "type": "string" }, "isDelegate": { "type": "string" }, "createTimestamp": { "type": "string" }, "createTimestampTimezone": { "type": "string" }, "comment": { "type": "string" }, "type": { "type": "string" }, "generatedBy": { "type": "string" }, "isAutoGenerated": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "id", "orderId", "personId", "providerId", "authorName", "authorDisplayName", "userName", "isDelegate", "createTimestamp", "createTimestampTimezone", "comment", "type", "generatedBy", "isAutoGenerated", "_links" ] }, "{{baseUrl}}/persons/:personId/chart/immunizations/orders/:orderId/tracking-comments-Request": { "title": "{{baseUrl}}/persons/:personId/chart/immunizations/orders/:orderId/tracking-comments-Request", "example": { "Comment": "" }, "type": "object", "properties": { "Comment": { "type": "string" } }, "required": [ "Comment" ] }, "OK42": { "title": "OK42", "example": { "id": "", "personId": "", "enterpriseId": "", "practiceId": "", "orderId": "", "cvxCode": "", "description": "", "cptCode": "", "sequenceNumber": "", "status": "", "lotNumber": "", "administeredYear": "", "administeredMonth": "", "administeredDay": "", "administeredDate": "", "administeredTimestamp": "", "administeredByUserId": "", "administeredByName": "", "isVfc": "", "vfcCode": "", "fundingSourceCode": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "id": { "type": "string" }, "personId": { "type": "string" }, "enterpriseId": { "type": "string" }, "practiceId": { "type": "string" }, "orderId": { "type": "string" }, "cvxCode": { "type": "string" }, "description": { "type": "string" }, "cptCode": { "type": "string" }, "sequenceNumber": { "type": "string" }, "status": { "type": "string" }, "lotNumber": { "type": "string" }, "administeredYear": { "type": "string" }, "administeredMonth": { "type": "string" }, "administeredDay": { "type": "string" }, "administeredDate": { "type": "string" }, "administeredTimestamp": { "type": "string" }, "administeredByUserId": { "type": "string" }, "administeredByName": { "type": "string" }, "isVfc": { "type": "string" }, "vfcCode": { "type": "string" }, "fundingSourceCode": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "id", "personId", "enterpriseId", "practiceId", "orderId", "cvxCode", "description", "cptCode", "sequenceNumber", "status", "lotNumber", "administeredYear", "administeredMonth", "administeredDay", "administeredDate", "administeredTimestamp", "administeredByUserId", "administeredByName", "isVfc", "vfcCode", "fundingSourceCode", "_links" ] }, "OK43": { "title": "OK43", "example": { "id": "", "personId": "", "enterpriseId": "", "practiceId": "", "orderId": "", "orderStatus": "", "cvxCode": "", "description": "", "recordSourceCode": "", "recordSourceName": "", "administerCptCode": "", "isDeleted": "", "cptCode": "", "sequenceNumber": "", "status": "", "comment": "", "brandName": "", "siteCode": "", "site": "", "sideCode": "", "side": "", "routeCode": "", "route": "", "unitsCode": "", "units": "", "lotNumber": "", "expirationDate": "", "dose": "", "mvxCode": "", "manufacturerNumber": "", "manufacturerName": "", "notAdministeredReason": "", "notAdministeredCode": "", "purchaseType": "", "strength": "", "administeredYear": "", "administeredMonth": "", "administeredDay": "", "administeredDate": "", "administeredTimestamp": "", "administeredByUserId": "", "administeredByName": "", "auditId": "", "chargeId": "", "adminChargeId": "", "isException": "", "isCounselled": "", "counselledCode": "", "counselledUnit": "", "counselChargeId": "", "consentFrom": "", "consentGivenTo": "", "ndcId": "", "isError": "", "snomedImmunity": "", "isVfc": "", "vfcCode": "", "vfcDate": "", "vfcDateTimezone": "", "fundingSourceCode": "", "simCode": "", "signOffUserId": "", "signOffName": "", "signOffDate": "", "signOffDateTimezone": "", "signoffComment": "", "displayName": "", "hideOnChart": "", "createdBy": "", "createTimestamp": "", "createTimestampTimezone": "", "modifiedByUserId": "", "modifiedByName": "", "modifyTimestamp": "", "modifyTimestampTimezone": "", "overrideInvalidDose": "", "billingUnits": "", "vaccineInventoryId": "", "isReported": "", "wasNotGiven": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "id": { "type": "string" }, "personId": { "type": "string" }, "enterpriseId": { "type": "string" }, "practiceId": { "type": "string" }, "orderId": { "type": "string" }, "orderStatus": { "type": "string" }, "cvxCode": { "type": "string" }, "description": { "type": "string" }, "recordSourceCode": { "type": "string" }, "recordSourceName": { "type": "string" }, "administerCptCode": { "type": "string" }, "isDeleted": { "type": "string" }, "cptCode": { "type": "string" }, "sequenceNumber": { "type": "string" }, "status": { "type": "string" }, "comment": { "type": "string" }, "brandName": { "type": "string" }, "siteCode": { "type": "string" }, "site": { "type": "string" }, "sideCode": { "type": "string" }, "side": { "type": "string" }, "routeCode": { "type": "string" }, "route": { "type": "string" }, "unitsCode": { "type": "string" }, "units": { "type": "string" }, "lotNumber": { "type": "string" }, "expirationDate": { "type": "string" }, "dose": { "type": "string" }, "mvxCode": { "type": "string" }, "manufacturerNumber": { "type": "string" }, "manufacturerName": { "type": "string" }, "notAdministeredReason": { "type": "string" }, "notAdministeredCode": { "type": "string" }, "purchaseType": { "type": "string" }, "strength": { "type": "string" }, "administeredYear": { "type": "string" }, "administeredMonth": { "type": "string" }, "administeredDay": { "type": "string" }, "administeredDate": { "type": "string" }, "administeredTimestamp": { "type": "string" }, "administeredByUserId": { "type": "string" }, "administeredByName": { "type": "string" }, "auditId": { "type": "string" }, "chargeId": { "type": "string" }, "adminChargeId": { "type": "string" }, "isException": { "type": "string" }, "isCounselled": { "type": "string" }, "counselledCode": { "type": "string" }, "counselledUnit": { "type": "string" }, "counselChargeId": { "type": "string" }, "consentFrom": { "type": "string" }, "consentGivenTo": { "type": "string" }, "ndcId": { "type": "string" }, "isError": { "type": "string" }, "snomedImmunity": { "type": "string" }, "isVfc": { "type": "string" }, "vfcCode": { "type": "string" }, "vfcDate": { "type": "string" }, "vfcDateTimezone": { "type": "string" }, "fundingSourceCode": { "type": "string" }, "simCode": { "type": "string" }, "signOffUserId": { "type": "string" }, "signOffName": { "type": "string" }, "signOffDate": { "type": "string" }, "signOffDateTimezone": { "type": "string" }, "signoffComment": { "type": "string" }, "displayName": { "type": "string" }, "hideOnChart": { "type": "string" }, "createdBy": { "type": "string" }, "createTimestamp": { "type": "string" }, "createTimestampTimezone": { "type": "string" }, "modifiedByUserId": { "type": "string" }, "modifiedByName": { "type": "string" }, "modifyTimestamp": { "type": "string" }, "modifyTimestampTimezone": { "type": "string" }, "overrideInvalidDose": { "type": "string" }, "billingUnits": { "type": "string" }, "vaccineInventoryId": { "type": "string" }, "isReported": { "type": "string" }, "wasNotGiven": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "id", "personId", "enterpriseId", "practiceId", "orderId", "orderStatus", "cvxCode", "description", "recordSourceCode", "recordSourceName", "administerCptCode", "isDeleted", "cptCode", "sequenceNumber", "status", "comment", "brandName", "siteCode", "site", "sideCode", "side", "routeCode", "route", "unitsCode", "units", "lotNumber", "expirationDate", "dose", "mvxCode", "manufacturerNumber", "manufacturerName", "notAdministeredReason", "notAdministeredCode", "purchaseType", "strength", "administeredYear", "administeredMonth", "administeredDay", "administeredDate", "administeredTimestamp", "administeredByUserId", "administeredByName", "auditId", "chargeId", "adminChargeId", "isException", "isCounselled", "counselledCode", "counselledUnit", "counselChargeId", "consentFrom", "consentGivenTo", "ndcId", "isError", "snomedImmunity", "isVfc", "vfcCode", "vfcDate", "vfcDateTimezone", "fundingSourceCode", "simCode", "signOffUserId", "signOffName", "signOffDate", "signOffDateTimezone", "signoffComment", "displayName", "hideOnChart", "createdBy", "createTimestamp", "createTimestampTimezone", "modifiedByUserId", "modifiedByName", "modifyTimestamp", "modifyTimestampTimezone", "overrideInvalidDose", "billingUnits", "vaccineInventoryId", "isReported", "wasNotGiven", "_links" ] }, "OK44": { "title": "OK44", "example": { "vaccineId": "", "id": "", "componentName": "", "lotNumber": "", "diluentLotNumber": "", "orderId": "", "personId": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "vaccineId": { "type": "string" }, "id": { "type": "string" }, "componentName": { "type": "string" }, "lotNumber": { "type": "string" }, "diluentLotNumber": { "type": "string" }, "orderId": { "type": "string" }, "personId": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "vaccineId", "id", "componentName", "lotNumber", "diluentLotNumber", "orderId", "personId", "_links" ] }, "OK45": { "title": "OK45", "example": { "personId": "", "orderId": "", "orderVaccineId": "", "id": "", "diagnosisCodeLibraryId": "", "diagnosisCodeId": "", "description": "", "icd9CmCodeId": "", "userDescription": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "personId": { "type": "string" }, "orderId": { "type": "string" }, "orderVaccineId": { "type": "string" }, "id": { "type": "string" }, "diagnosisCodeLibraryId": { "type": "string" }, "diagnosisCodeId": { "type": "string" }, "description": { "type": "string" }, "icd9CmCodeId": { "type": "string" }, "userDescription": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "personId", "orderId", "orderVaccineId", "id", "diagnosisCodeLibraryId", "diagnosisCodeId", "description", "icd9CmCodeId", "userDescription", "_links" ] }, "OK46": { "title": "OK46", "example": { "vaccineVisId": "", "orderVaccineId": "", "personId": "", "orderId": "", "visGiveDate": "", "visGiveDateTimeZone": "", "visPublishDate": "", "givenVisId": "", "vaccineType": "", "visDocumentType": "", "createdBy": "", "visDescription": "", "languageId": "", "givenBy": "", "languageName": "", "visHistoryPublishDate": "", "givenVisVaccineType": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "vaccineVisId": { "type": "string" }, "orderVaccineId": { "type": "string" }, "personId": { "type": "string" }, "orderId": { "type": "string" }, "visGiveDate": { "type": "string" }, "visGiveDateTimeZone": { "type": "string" }, "visPublishDate": { "type": "string" }, "givenVisId": { "type": "string" }, "vaccineType": { "type": "string" }, "visDocumentType": { "type": "string" }, "createdBy": { "type": "string" }, "visDescription": { "type": "string" }, "languageId": { "type": "string" }, "givenBy": { "type": "string" }, "languageName": { "type": "string" }, "visHistoryPublishDate": { "type": "string" }, "givenVisVaccineType": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "vaccineVisId", "orderVaccineId", "personId", "orderId", "visGiveDate", "visGiveDateTimeZone", "visPublishDate", "givenVisId", "vaccineType", "visDocumentType", "createdBy", "visDescription", "languageId", "givenBy", "languageName", "visHistoryPublishDate", "givenVisVaccineType", "_links" ] }, "OK47": { "title": "OK47", "example": { "id": "", "vaccineId": "", "cvxCode": "", "vaccineDescription": "", "lotNumber": "", "cptCode": "", "mvxCode": "", "manufacturerName": "", "manufacturerNumber": "", "strength": "", "units": "", "unitsCode": "", "dose": "", "route": "", "routeCode": "", "side": "", "sideCode": "", "site": "", "siteCode": "", "brandName": "", "purchaseType": "", "wastedReason": "", "wastedDate": "", "orderId": "", "personId": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "id": { "type": "string" }, "vaccineId": { "type": "string" }, "cvxCode": { "type": "string" }, "vaccineDescription": { "type": "string" }, "lotNumber": { "type": "string" }, "cptCode": { "type": "string" }, "mvxCode": { "type": "string" }, "manufacturerName": { "type": "string" }, "manufacturerNumber": { "type": "string" }, "strength": { "type": "string" }, "units": { "type": "string" }, "unitsCode": { "type": "string" }, "dose": { "type": "string" }, "route": { "type": "string" }, "routeCode": { "type": "string" }, "side": { "type": "string" }, "sideCode": { "type": "string" }, "site": { "type": "string" }, "siteCode": { "type": "string" }, "brandName": { "type": "string" }, "purchaseType": { "type": "string" }, "wastedReason": { "type": "string" }, "wastedDate": { "type": "string" }, "orderId": { "type": "string" }, "personId": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "id", "vaccineId", "cvxCode", "vaccineDescription", "lotNumber", "cptCode", "mvxCode", "manufacturerName", "manufacturerNumber", "strength", "units", "unitsCode", "dose", "route", "routeCode", "side", "sideCode", "site", "siteCode", "brandName", "purchaseType", "wastedReason", "wastedDate", "orderId", "personId", "_links" ] }, "OK49": { "title": "OK49", "example": { "id": "", "personId": "", "enterpriseId": "", "practiceId": "", "seriesName": "", "isComplete": "", "comment": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "id": { "type": "string" }, "personId": { "type": "string" }, "enterpriseId": { "type": "string" }, "practiceId": { "type": "string" }, "seriesName": { "type": "string" }, "isComplete": { "type": "string" }, "comment": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "id", "personId", "enterpriseId", "practiceId", "seriesName", "isComplete", "comment", "_links" ] }, "{{baseUrl}}/persons/:personId/chart/immunizations/series-completions-Request": { "title": "{{baseUrl}}/persons/:personId/chart/immunizations/series-completions-Request", "example": { "SeriesName": "", "IsComplete": "", "Comment": "" }, "type": "object", "properties": { "SeriesName": { "type": "string" }, "IsComplete": { "type": "string" }, "Comment": { "type": "string" } }, "required": [ "SeriesName", "IsComplete", "Comment" ] }, "{{baseUrl}}/persons/:personId/chart/immunizations/series-completions/:seriesId-Request": { "title": "{{baseUrl}}/persons/:personId/chart/immunizations/series-completions/:seriesId-Request", "example": { "id": "", "personId": "", "enterpriseId": "", "practiceId": "", "seriesName": "", "isComplete": "", "comment": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "id": { "type": "string" }, "personId": { "type": "string" }, "enterpriseId": { "type": "string" }, "practiceId": { "type": "string" }, "seriesName": { "type": "string" }, "isComplete": { "type": "string" }, "comment": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "id", "personId", "enterpriseId", "practiceId", "seriesName", "isComplete", "comment", "_links" ] }, "OK51": { "title": "OK51", "example": { "Items": [ { "id": "", "personId": "", "deviceIdentifier": "", "universalDeviceIdentifier": "", "snoMedCtCode": "", "snoMedCtDescription": "", "lotOrBatchNumber": "", "serialNumber": "", "manufacturingDate": "", "expirationDate": "", "isDeleted": "", "assigningAuthorityOid": "", "assigningAuthority": "", "gmdnProductName": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "id": "", "personId": "", "deviceIdentifier": "", "universalDeviceIdentifier": "", "snoMedCtCode": "", "snoMedCtDescription": "", "lotOrBatchNumber": "", "serialNumber": "", "manufacturingDate": "", "expirationDate": "", "isDeleted": "", "assigningAuthorityOid": "", "assigningAuthority": "", "gmdnProductName": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" }, "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/Item22" } }, "NextPageLink": { "type": "string" }, "Count": { "type": "string" } }, "required": [ "Items", "NextPageLink", "Count" ] }, "Item22": { "title": "Item22", "example": { "id": "", "personId": "", "deviceIdentifier": "", "universalDeviceIdentifier": "", "snoMedCtCode": "", "snoMedCtDescription": "", "lotOrBatchNumber": "", "serialNumber": "", "manufacturingDate": "", "expirationDate": "", "isDeleted": "", "assigningAuthorityOid": "", "assigningAuthority": "", "gmdnProductName": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "id": { "type": "string" }, "personId": { "type": "string" }, "deviceIdentifier": { "type": "string" }, "universalDeviceIdentifier": { "type": "string" }, "snoMedCtCode": { "type": "string" }, "snoMedCtDescription": { "type": "string" }, "lotOrBatchNumber": { "type": "string" }, "serialNumber": { "type": "string" }, "manufacturingDate": { "type": "string" }, "expirationDate": { "type": "string" }, "isDeleted": { "type": "string" }, "assigningAuthorityOid": { "type": "string" }, "assigningAuthority": { "type": "string" }, "gmdnProductName": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "id", "personId", "deviceIdentifier", "universalDeviceIdentifier", "snoMedCtCode", "snoMedCtDescription", "lotOrBatchNumber", "serialNumber", "manufacturingDate", "expirationDate", "isDeleted", "assigningAuthorityOid", "assigningAuthority", "gmdnProductName", "_links" ] }, "OK52": { "title": "OK52", "example": { "id": "", "personId": "", "deviceIdentifier": "", "universalDeviceIdentifier": "", "snoMedCtCode": "", "snoMedCtDescription": "", "lotOrBatchNumber": "", "serialNumber": "", "manufacturingDate": "", "expirationDate": "", "isDeleted": "", "assigningAuthorityOid": "", "assigningAuthority": "", "gmdnProductName": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "id": { "type": "string" }, "personId": { "type": "string" }, "deviceIdentifier": { "type": "string" }, "universalDeviceIdentifier": { "type": "string" }, "snoMedCtCode": { "type": "string" }, "snoMedCtDescription": { "type": "string" }, "lotOrBatchNumber": { "type": "string" }, "serialNumber": { "type": "string" }, "manufacturingDate": { "type": "string" }, "expirationDate": { "type": "string" }, "isDeleted": { "type": "string" }, "assigningAuthorityOid": { "type": "string" }, "assigningAuthority": { "type": "string" }, "gmdnProductName": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "id", "personId", "deviceIdentifier", "universalDeviceIdentifier", "snoMedCtCode", "snoMedCtDescription", "lotOrBatchNumber", "serialNumber", "manufacturingDate", "expirationDate", "isDeleted", "assigningAuthorityOid", "assigningAuthority", "gmdnProductName", "_links" ] }, "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/lab/ordersRequest": { "title": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/lab/ordersRequest", "example": { "TestLocationId": "", "OrderingProvider": "", "OrderedElsewhere": "", "CopyToProviders": [ "", "" ], "Payers": [ "", "" ], "GeneralComment": "", "OrderComment": "", "PatientComment": "", "CancelReason": "", "ClinicalInfo": "", "LabId": "", "GeneratedBy": "", "BillingType": "", "OrderControl": "", "OrderPriority": "", "AbnCode": "", "SpecimenAction": "" }, "type": "object", "properties": { "TestLocationId": { "type": "string" }, "OrderingProvider": { "type": "string" }, "OrderedElsewhere": { "type": "string" }, "CopyToProviders": { "type": "array", "items": { "type": "string" } }, "Payers": { "type": "array", "items": { "type": "string" } }, "GeneralComment": { "type": "string" }, "OrderComment": { "type": "string" }, "PatientComment": { "type": "string" }, "CancelReason": { "type": "string" }, "ClinicalInfo": { "type": "string" }, "LabId": { "type": "string" }, "GeneratedBy": { "type": "string" }, "BillingType": { "type": "string" }, "OrderControl": { "type": "string" }, "OrderPriority": { "type": "string" }, "AbnCode": { "type": "string" }, "SpecimenAction": { "type": "string" } }, "required": [ "TestLocationId", "OrderingProvider", "OrderedElsewhere", "CopyToProviders", "Payers", "GeneralComment", "OrderComment", "PatientComment", "CancelReason", "ClinicalInfo", "LabId", "GeneratedBy", "BillingType", "OrderControl", "OrderPriority", "AbnCode", "SpecimenAction" ] }, "OK53": { "title": "OK53", "example": { "id": "", "testDescription": "", "encounterId": "", "personId": "", "ufoNumber": "", "generatedBy": "", "orderType": "", "testLocation": "", "orderingProvider": "", "encounterTimestamp": "", "orderDate": "", "orderDateTimezone": "", "signOffDate": "", "signOffPerson": "", "testStatus": "", "nextgenStatus": "", "labId": "", "signoffCommentsIndicator": "", "documentsIndicator": "", "orderControl": "", "orderPriority": "", "timeEntered": "", "specimenActionCode": "", "billingType": "", "clinicalInformation": "", "cancelReason": "", "intrfMessage": "", "practiceId": "", "enterpriseId": "", "isDeleted": "", "providerDisplayName": "", "locationName": "", "addressLine1": "", "addressLine2": "", "city": "", "state": "", "zip": "", "phone": "", "fax": "", "firstName": "", "lastName": "", "middleInitial": "", "isFutureOrder": "", "startDate": "", "nextDueDate": "", "expectedResultDate": "", "generalComment": "", "orderComment": "", "patientComment": "", "isOrderedElseWhere": "", "isCompleted": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "id": { "type": "string" }, "testDescription": { "type": "string" }, "encounterId": { "type": "string" }, "personId": { "type": "string" }, "ufoNumber": { "type": "string" }, "generatedBy": { "type": "string" }, "orderType": { "type": "string" }, "testLocation": { "type": "string" }, "orderingProvider": { "type": "string" }, "encounterTimestamp": { "type": "string" }, "orderDate": { "type": "string" }, "orderDateTimezone": { "type": "string" }, "signOffDate": { "type": "string" }, "signOffPerson": { "type": "string" }, "testStatus": { "type": "string" }, "nextgenStatus": { "type": "string" }, "labId": { "type": "string" }, "signoffCommentsIndicator": { "type": "string" }, "documentsIndicator": { "type": "string" }, "orderControl": { "type": "string" }, "orderPriority": { "type": "string" }, "timeEntered": { "type": "string" }, "specimenActionCode": { "type": "string" }, "billingType": { "type": "string" }, "clinicalInformation": { "type": "string" }, "cancelReason": { "type": "string" }, "intrfMessage": { "type": "string" }, "practiceId": { "type": "string" }, "enterpriseId": { "type": "string" }, "isDeleted": { "type": "string" }, "providerDisplayName": { "type": "string" }, "locationName": { "type": "string" }, "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "phone": { "type": "string" }, "fax": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "middleInitial": { "type": "string" }, "isFutureOrder": { "type": "string" }, "startDate": { "type": "string" }, "nextDueDate": { "type": "string" }, "expectedResultDate": { "type": "string" }, "generalComment": { "type": "string" }, "orderComment": { "type": "string" }, "patientComment": { "type": "string" }, "isOrderedElseWhere": { "type": "string" }, "isCompleted": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "id", "testDescription", "encounterId", "personId", "ufoNumber", "generatedBy", "orderType", "testLocation", "orderingProvider", "encounterTimestamp", "orderDate", "orderDateTimezone", "signOffDate", "signOffPerson", "testStatus", "nextgenStatus", "labId", "signoffCommentsIndicator", "documentsIndicator", "orderControl", "orderPriority", "timeEntered", "specimenActionCode", "billingType", "clinicalInformation", "cancelReason", "intrfMessage", "practiceId", "enterpriseId", "isDeleted", "providerDisplayName", "locationName", "addressLine1", "addressLine2", "city", "state", "zip", "phone", "fax", "firstName", "lastName", "middleInitial", "isFutureOrder", "startDate", "nextDueDate", "expectedResultDate", "generalComment", "orderComment", "patientComment", "isOrderedElseWhere", "isCompleted", "_links" ] }, "OK54": { "title": "OK54", "example": { "Items": [ { "id": "", "testDescription": "", "testStatus": "", "nextgenStatus": "", "labId": "", "encounterId": "", "encounterTimestamp": "", "personId": "", "ufoNumber": "", "generatedBy": "", "orderType": "", "testLocation": "", "orderControl": "", "orderPriority": "", "orderingProvider": "", "orderDate": "", "orderDateTimezone": "", "signOffDate": "", "intrfMessage": "", "enterpriseId": "", "practiceId": "", "isDeleted": "", "signOffPerson": "", "isFutureOrder": "", "startDate": "", "nextDueDate": "", "expectedResultDate": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "id": "", "testDescription": "", "testStatus": "", "nextgenStatus": "", "labId": "", "encounterId": "", "encounterTimestamp": "", "personId": "", "ufoNumber": "", "generatedBy": "", "orderType": "", "testLocation": "", "orderControl": "", "orderPriority": "", "orderingProvider": "", "orderDate": "", "orderDateTimezone": "", "signOffDate": "", "intrfMessage": "", "enterpriseId": "", "practiceId": "", "isDeleted": "", "signOffPerson": "", "isFutureOrder": "", "startDate": "", "nextDueDate": "", "expectedResultDate": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" }, "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/Item23" } }, "NextPageLink": { "type": "string" }, "Count": { "type": "string" } }, "required": [ "Items", "NextPageLink", "Count" ] }, "Item23": { "title": "Item23", "example": { "id": "", "testDescription": "", "testStatus": "", "nextgenStatus": "", "labId": "", "encounterId": "", "encounterTimestamp": "", "personId": "", "ufoNumber": "", "generatedBy": "", "orderType": "", "testLocation": "", "orderControl": "", "orderPriority": "", "orderingProvider": "", "orderDate": "", "orderDateTimezone": "", "signOffDate": "", "intrfMessage": "", "enterpriseId": "", "practiceId": "", "isDeleted": "", "signOffPerson": "", "isFutureOrder": "", "startDate": "", "nextDueDate": "", "expectedResultDate": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "id": { "type": "string" }, "testDescription": { "type": "string" }, "testStatus": { "type": "string" }, "nextgenStatus": { "type": "string" }, "labId": { "type": "string" }, "encounterId": { "type": "string" }, "encounterTimestamp": { "type": "string" }, "personId": { "type": "string" }, "ufoNumber": { "type": "string" }, "generatedBy": { "type": "string" }, "orderType": { "type": "string" }, "testLocation": { "type": "string" }, "orderControl": { "type": "string" }, "orderPriority": { "type": "string" }, "orderingProvider": { "type": "string" }, "orderDate": { "type": "string" }, "orderDateTimezone": { "type": "string" }, "signOffDate": { "type": "string" }, "intrfMessage": { "type": "string" }, "enterpriseId": { "type": "string" }, "practiceId": { "type": "string" }, "isDeleted": { "type": "string" }, "signOffPerson": { "type": "string" }, "isFutureOrder": { "type": "string" }, "startDate": { "type": "string" }, "nextDueDate": { "type": "string" }, "expectedResultDate": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "id", "testDescription", "testStatus", "nextgenStatus", "labId", "encounterId", "encounterTimestamp", "personId", "ufoNumber", "generatedBy", "orderType", "testLocation", "orderControl", "orderPriority", "orderingProvider", "orderDate", "orderDateTimezone", "signOffDate", "intrfMessage", "enterpriseId", "practiceId", "isDeleted", "signOffPerson", "isFutureOrder", "startDate", "nextDueDate", "expectedResultDate", "_links" ] }, "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderIdRequest": { "title": "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderIdRequest", "example": { "LabId": "", "TestLocation": "", "OrderingProvider": "", "NextgenStatus": "", "OrderControl": "", "OrderPriority": "", "SpecimenActionCode": "", "BillingType": "", "ClinicalInformation": "", "CancelReason": "", "GeneralComment": "", "OrderComment": "", "PatientComment": "", "IsOrderedElseWhere": "" }, "type": "object", "properties": { "LabId": { "type": "string" }, "TestLocation": { "type": "string" }, "OrderingProvider": { "type": "string" }, "NextgenStatus": { "type": "string" }, "OrderControl": { "type": "string" }, "OrderPriority": { "type": "string" }, "SpecimenActionCode": { "type": "string" }, "BillingType": { "type": "string" }, "ClinicalInformation": { "type": "string" }, "CancelReason": { "type": "string" }, "GeneralComment": { "type": "string" }, "OrderComment": { "type": "string" }, "PatientComment": { "type": "string" }, "IsOrderedElseWhere": { "type": "string" } }, "required": [ "LabId", "TestLocation", "OrderingProvider", "NextgenStatus", "OrderControl", "OrderPriority", "SpecimenActionCode", "BillingType", "ClinicalInformation", "CancelReason", "GeneralComment", "OrderComment", "PatientComment", "IsOrderedElseWhere" ] }, "OK56": { "title": "OK56", "example": { "Items": [ { "id": "", "personPayerId": "", "payerId": "", "insuredPersonId": "", "cob": "", "orderNumber": "", "personId": "", "lastName": "", "firstName": "", "enterpriseId": "", "practiceId": "", "payerName": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "id": "", "personPayerId": "", "payerId": "", "insuredPersonId": "", "cob": "", "orderNumber": "", "personId": "", "lastName": "", "firstName": "", "enterpriseId": "", "practiceId": "", "payerName": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" }, "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/Item24" } }, "NextPageLink": { "type": "string" }, "Count": { "type": "string" } }, "required": [ "Items", "NextPageLink", "Count" ] }, "Item24": { "title": "Item24", "example": { "id": "", "personPayerId": "", "payerId": "", "insuredPersonId": "", "cob": "", "orderNumber": "", "personId": "", "lastName": "", "firstName": "", "enterpriseId": "", "practiceId": "", "payerName": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "id": { "type": "string" }, "personPayerId": { "type": "string" }, "payerId": { "type": "string" }, "insuredPersonId": { "type": "string" }, "cob": { "type": "string" }, "orderNumber": { "type": "string" }, "personId": { "type": "string" }, "lastName": { "type": "string" }, "firstName": { "type": "string" }, "enterpriseId": { "type": "string" }, "practiceId": { "type": "string" }, "payerName": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "id", "personPayerId", "payerId", "insuredPersonId", "cob", "orderNumber", "personId", "lastName", "firstName", "enterpriseId", "practiceId", "payerName", "_links" ] }, "OK57": { "title": "OK57", "example": { "id": "", "personId": "", "enterpriseId": "", "practiceId": "", "orderId": "", "orderType": "", "isFutureOrder": "", "scheduleType": "", "startDate": "", "endDate": "", "interval": "", "timespan": "", "createdBy": "", "createTimestamp": "", "nextDueDate": "", "modifiedBy": "", "isAutoReleasable": "", "maxOccurrence": "", "stopDate": "", "stopReason": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "id": { "type": "string" }, "personId": { "type": "string" }, "enterpriseId": { "type": "string" }, "practiceId": { "type": "string" }, "orderId": { "type": "string" }, "orderType": { "type": "string" }, "isFutureOrder": { "type": "string" }, "scheduleType": { "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "interval": { "type": "string" }, "timespan": { "type": "string" }, "createdBy": { "type": "string" }, "createTimestamp": { "type": "string" }, "nextDueDate": { "type": "string" }, "modifiedBy": { "type": "string" }, "isAutoReleasable": { "type": "string" }, "maxOccurrence": { "type": "string" }, "stopDate": { "type": "string" }, "stopReason": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "id", "personId", "enterpriseId", "practiceId", "orderId", "orderType", "isFutureOrder", "scheduleType", "startDate", "endDate", "interval", "timespan", "createdBy", "createTimestamp", "nextDueDate", "modifiedBy", "isAutoReleasable", "maxOccurrence", "stopDate", "stopReason", "_links" ] }, "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/scheduleRequest": { "title": "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/scheduleRequest", "example": { "ScheduleType": "", "StartDate": "", "EndDate": "", "Interval": "", "IntervalMode": "", "IsAutoReleasable": "" }, "type": "object", "properties": { "ScheduleType": { "type": "string" }, "StartDate": { "type": "string" }, "EndDate": { "type": "string" }, "Interval": { "type": "string" }, "IntervalMode": { "type": "string" }, "IsAutoReleasable": { "type": "string" } }, "required": [ "ScheduleType", "StartDate", "EndDate", "Interval", "IntervalMode", "IsAutoReleasable" ] }, "OK58": { "title": "OK58", "example": { "id": "", "orderId": "", "enterpriseId": "", "practiceId": "", "personId": "", "testCodeId": "", "testCodeText": "", "testCodeSystem": "", "testComment": "", "collectionTime": "", "collectionTimezone": "", "expectedResultDate": "", "scheduledTime": "", "scheduledTimezone": "", "loincCode": "", "chargeId": "", "orderingReason": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "id": { "type": "string" }, "orderId": { "type": "string" }, "enterpriseId": { "type": "string" }, "practiceId": { "type": "string" }, "personId": { "type": "string" }, "testCodeId": { "type": "string" }, "testCodeText": { "type": "string" }, "testCodeSystem": { "type": "string" }, "testComment": { "type": "string" }, "collectionTime": { "type": "string" }, "collectionTimezone": { "type": "string" }, "expectedResultDate": { "type": "string" }, "scheduledTime": { "type": "string" }, "scheduledTimezone": { "type": "string" }, "loincCode": { "type": "string" }, "chargeId": { "type": "string" }, "orderingReason": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "id", "orderId", "enterpriseId", "practiceId", "personId", "testCodeId", "testCodeText", "testCodeSystem", "testComment", "collectionTime", "collectionTimezone", "expectedResultDate", "scheduledTime", "scheduledTimezone", "loincCode", "chargeId", "orderingReason", "_links" ] }, "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/testsRequest": { "title": "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/testsRequest", "example": { "TestCodeId": "", "IsNextGenCompendiumTest": "", "ScheduleDateTime": "", "VolumeQuantity": "", "VolumeUnit": "", "CollectionDate": "", "SourceSite": "", "SourceDescription": "", "Additives": "", "BodySite": "", "SiteModifier": "", "SpecimenRole": "", "SpecimenStorage": "", "CollectionMethod": "", "Comment": "", "OrderingReason": "", "ExpectedResultDate": "", "GeneratedBy": "" }, "type": "object", "properties": { "TestCodeId": { "type": "string" }, "IsNextGenCompendiumTest": { "type": "string" }, "ScheduleDateTime": { "type": "string" }, "VolumeQuantity": { "type": "string" }, "VolumeUnit": { "type": "string" }, "CollectionDate": { "type": "string" }, "SourceSite": { "type": "string" }, "SourceDescription": { "type": "string" }, "Additives": { "type": "string" }, "BodySite": { "type": "string" }, "SiteModifier": { "type": "string" }, "SpecimenRole": { "type": "string" }, "SpecimenStorage": { "type": "string" }, "CollectionMethod": { "type": "string" }, "Comment": { "type": "string" }, "OrderingReason": { "type": "string" }, "ExpectedResultDate": { "type": "string" }, "GeneratedBy": { "type": "string" } }, "required": [ "TestCodeId", "IsNextGenCompendiumTest", "ScheduleDateTime", "VolumeQuantity", "VolumeUnit", "CollectionDate", "SourceSite", "SourceDescription", "Additives", "BodySite", "SiteModifier", "SpecimenRole", "SpecimenStorage", "CollectionMethod", "Comment", "OrderingReason", "ExpectedResultDate", "GeneratedBy" ] }, "OK59": { "title": "OK59", "example": { "id": "", "orderId": "", "enterpriseId": "", "practiceId": "", "personId": "", "testCodeId": "", "testCodeText": "", "testCodeSystem": "", "collectionTime": "", "volumeQuantity": "", "volumeUnits": "", "specSrcCode": "", "specSrcDesc": "", "specSrcAdditives": "", "scheduledTime": "", "createdBy": "", "generatedBy": "", "createTimestamp": "", "modifiedBy": "", "modifyTimestamp": "", "loincCode": "", "snomedCode": "", "specSrcBodySite": "", "specSrcSiteModifier": "", "specSrcRole": "", "specSrcStorage": "", "specSrcCollectionMethod": "", "collectorId": "", "testComment": "", "expectedResultDate": "", "collectionTimezone": "", "scheduledTimezone": "", "createTimestampTimezone": "", "modifyTimestampTimezone": "", "chargeId": "", "orderingReason": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "id": { "type": "string" }, "orderId": { "type": "string" }, "enterpriseId": { "type": "string" }, "practiceId": { "type": "string" }, "personId": { "type": "string" }, "testCodeId": { "type": "string" }, "testCodeText": { "type": "string" }, "testCodeSystem": { "type": "string" }, "collectionTime": { "type": "string" }, "volumeQuantity": { "type": "string" }, "volumeUnits": { "type": "string" }, "specSrcCode": { "type": "string" }, "specSrcDesc": { "type": "string" }, "specSrcAdditives": { "type": "string" }, "scheduledTime": { "type": "string" }, "createdBy": { "type": "string" }, "generatedBy": { "type": "string" }, "createTimestamp": { "type": "string" }, "modifiedBy": { "type": "string" }, "modifyTimestamp": { "type": "string" }, "loincCode": { "type": "string" }, "snomedCode": { "type": "string" }, "specSrcBodySite": { "type": "string" }, "specSrcSiteModifier": { "type": "string" }, "specSrcRole": { "type": "string" }, "specSrcStorage": { "type": "string" }, "specSrcCollectionMethod": { "type": "string" }, "collectorId": { "type": "string" }, "testComment": { "type": "string" }, "expectedResultDate": { "type": "string" }, "collectionTimezone": { "type": "string" }, "scheduledTimezone": { "type": "string" }, "createTimestampTimezone": { "type": "string" }, "modifyTimestampTimezone": { "type": "string" }, "chargeId": { "type": "string" }, "orderingReason": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "id", "orderId", "enterpriseId", "practiceId", "personId", "testCodeId", "testCodeText", "testCodeSystem", "collectionTime", "volumeQuantity", "volumeUnits", "specSrcCode", "specSrcDesc", "specSrcAdditives", "scheduledTime", "createdBy", "generatedBy", "createTimestamp", "modifiedBy", "modifyTimestamp", "loincCode", "snomedCode", "specSrcBodySite", "specSrcSiteModifier", "specSrcRole", "specSrcStorage", "specSrcCollectionMethod", "collectorId", "testComment", "expectedResultDate", "collectionTimezone", "scheduledTimezone", "createTimestampTimezone", "modifyTimestampTimezone", "chargeId", "orderingReason", "_links" ] }, "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/tests/:testIdRequest": { "title": "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/tests/:testIdRequest", "example": { "id": "", "orderId": "", "enterpriseId": "", "practiceId": "", "personId": "", "testCodeId": "", "testCodeText": "", "testCodeSystem": "", "collectionTime": "", "volumeQuantity": "", "volumeUnits": "", "specSrcCode": "", "specSrcDesc": "", "specSrcAdditives": "", "scheduledTime": "", "createdBy": "", "generatedBy": "", "createTimestamp": "", "modifiedBy": "", "modifyTimestamp": "", "loincCode": "", "snomedCode": "", "specSrcBodySite": "", "specSrcSiteModifier": "", "specSrcRole": "", "specSrcStorage": "", "specSrcCollectionMethod": "", "collectorId": "", "testComment": "", "expectedResultDate": "", "collectionTimezone": "", "scheduledTimezone": "", "createTimestampTimezone": "", "modifyTimestampTimezone": "", "chargeId": "", "orderingReason": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "id": { "type": "string" }, "orderId": { "type": "string" }, "enterpriseId": { "type": "string" }, "practiceId": { "type": "string" }, "personId": { "type": "string" }, "testCodeId": { "type": "string" }, "testCodeText": { "type": "string" }, "testCodeSystem": { "type": "string" }, "collectionTime": { "type": "string" }, "volumeQuantity": { "type": "string" }, "volumeUnits": { "type": "string" }, "specSrcCode": { "type": "string" }, "specSrcDesc": { "type": "string" }, "specSrcAdditives": { "type": "string" }, "scheduledTime": { "type": "string" }, "createdBy": { "type": "string" }, "generatedBy": { "type": "string" }, "createTimestamp": { "type": "string" }, "modifiedBy": { "type": "string" }, "modifyTimestamp": { "type": "string" }, "loincCode": { "type": "string" }, "snomedCode": { "type": "string" }, "specSrcBodySite": { "type": "string" }, "specSrcSiteModifier": { "type": "string" }, "specSrcRole": { "type": "string" }, "specSrcStorage": { "type": "string" }, "specSrcCollectionMethod": { "type": "string" }, "collectorId": { "type": "string" }, "testComment": { "type": "string" }, "expectedResultDate": { "type": "string" }, "collectionTimezone": { "type": "string" }, "scheduledTimezone": { "type": "string" }, "createTimestampTimezone": { "type": "string" }, "modifyTimestampTimezone": { "type": "string" }, "chargeId": { "type": "string" }, "orderingReason": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "id", "orderId", "enterpriseId", "practiceId", "personId", "testCodeId", "testCodeText", "testCodeSystem", "collectionTime", "volumeQuantity", "volumeUnits", "specSrcCode", "specSrcDesc", "specSrcAdditives", "scheduledTime", "createdBy", "generatedBy", "createTimestamp", "modifiedBy", "modifyTimestamp", "loincCode", "snomedCode", "specSrcBodySite", "specSrcSiteModifier", "specSrcRole", "specSrcStorage", "specSrcCollectionMethod", "collectorId", "testComment", "expectedResultDate", "collectionTimezone", "scheduledTimezone", "createTimestampTimezone", "modifyTimestampTimezone", "chargeId", "orderingReason", "_links" ] }, "OK60": { "title": "OK60", "example": { "Items": [ { "id": "", "enterpriseId": "", "practiceId": "", "personId": "", "orderId": "", "orderedTestId": "", "answer": "", "questionCode": "", "createdBy": "", "createTimestamp": "", "modifiedBy": "", "modifyTimestamp": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "id": "", "enterpriseId": "", "practiceId": "", "personId": "", "orderId": "", "orderedTestId": "", "answer": "", "questionCode": "", "createdBy": "", "createTimestamp": "", "modifiedBy": "", "modifyTimestamp": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" }, "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/Item25" } }, "NextPageLink": { "type": "string" }, "Count": { "type": "string" } }, "required": [ "Items", "NextPageLink", "Count" ] }, "Item25": { "title": "Item25", "example": { "id": "", "enterpriseId": "", "practiceId": "", "personId": "", "orderId": "", "orderedTestId": "", "answer": "", "questionCode": "", "createdBy": "", "createTimestamp": "", "modifiedBy": "", "modifyTimestamp": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "id": { "type": "string" }, "enterpriseId": { "type": "string" }, "practiceId": { "type": "string" }, "personId": { "type": "string" }, "orderId": { "type": "string" }, "orderedTestId": { "type": "string" }, "answer": { "type": "string" }, "questionCode": { "type": "string" }, "createdBy": { "type": "string" }, "createTimestamp": { "type": "string" }, "modifiedBy": { "type": "string" }, "modifyTimestamp": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "id", "enterpriseId", "practiceId", "personId", "orderId", "orderedTestId", "answer", "questionCode", "createdBy", "createTimestamp", "modifiedBy", "modifyTimestamp", "_links" ] }, "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/tests/:testId/order-entry-answers-Request": { "title": "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/tests/:testId/order-entry-answers-Request", "example": { "Answer": "", "QuestionCode": "" }, "type": "object", "properties": { "Answer": { "type": "string" }, "QuestionCode": { "type": "string" } }, "required": [ "Answer", "QuestionCode" ] }, "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/tests/:testId/order-entry-answers/:answerId-Request": { "title": "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/tests/:testId/order-entry-answers/:answerId-Request", "example": { "Answer": "" }, "type": "object", "properties": { "Answer": { "type": "string" } }, "required": [ "Answer" ] }, "OK61": { "title": "OK61", "example": { "Items": [ { "id": "", "orderNumber": "", "personId": "", "enterpriseId": "", "practiceId": "", "orderTestId": "", "diagnosisCodeLibraryId": "", "diagnosisCodeId": "", "description": "", "icd9cmCodeId": "", "userDescription": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "id": "", "orderNumber": "", "personId": "", "enterpriseId": "", "practiceId": "", "orderTestId": "", "diagnosisCodeLibraryId": "", "diagnosisCodeId": "", "description": "", "icd9cmCodeId": "", "userDescription": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" }, "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/Item26" } }, "NextPageLink": { "type": "string" }, "Count": { "type": "string" } }, "required": [ "Items", "NextPageLink", "Count" ] }, "Item26": { "title": "Item26", "example": { "id": "", "orderNumber": "", "personId": "", "enterpriseId": "", "practiceId": "", "orderTestId": "", "diagnosisCodeLibraryId": "", "diagnosisCodeId": "", "description": "", "icd9cmCodeId": "", "userDescription": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "id": { "type": "string" }, "orderNumber": { "type": "string" }, "personId": { "type": "string" }, "enterpriseId": { "type": "string" }, "practiceId": { "type": "string" }, "orderTestId": { "type": "string" }, "diagnosisCodeLibraryId": { "type": "string" }, "diagnosisCodeId": { "type": "string" }, "description": { "type": "string" }, "icd9cmCodeId": { "type": "string" }, "userDescription": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "id", "orderNumber", "personId", "enterpriseId", "practiceId", "orderTestId", "diagnosisCodeLibraryId", "diagnosisCodeId", "description", "icd9cmCodeId", "userDescription", "_links" ] }, "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/tests/:testId/suspected-diagnoses-Request": { "title": "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/tests/:testId/suspected-diagnoses-Request", "example": { "DiagnosisCodeLibraryId": "", "DiagnosisCodeId": "" }, "type": "object", "properties": { "DiagnosisCodeLibraryId": { "type": "string" }, "DiagnosisCodeId": { "type": "string" } }, "required": [ "DiagnosisCodeLibraryId", "DiagnosisCodeId" ] }, "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/tracking-comments-Request": { "title": "{{baseUrl}}/persons/:personId/chart/lab/orders/:orderId/tracking-comments-Request", "example": { "Comment": "" }, "type": "object", "properties": { "Comment": { "type": "string" } }, "required": [ "Comment" ] }, "OK63": { "title": "OK63", "example": { "Items": [ { "id": "", "enterpriseId": "", "practiceId": "", "personId": "", "orderId": "", "collectionDateTime": "", "collectionDateTimeTimezone": "", "orderingProviderId": "", "resultStatus": "", "testDescription": "", "isDeleted": "", "createTimestamp": "", "createTimestampTimezone": "", "locationId": "", "obrComment": "", "loincCode": "", "isConfidential": "", "orderTestId": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "id": "", "enterpriseId": "", "practiceId": "", "personId": "", "orderId": "", "collectionDateTime": "", "collectionDateTimeTimezone": "", "orderingProviderId": "", "resultStatus": "", "testDescription": "", "isDeleted": "", "createTimestamp": "", "createTimestampTimezone": "", "locationId": "", "obrComment": "", "loincCode": "", "isConfidential": "", "orderTestId": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" }, "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/Item27" } }, "NextPageLink": { "type": "string" }, "Count": { "type": "string" } }, "required": [ "Items", "NextPageLink", "Count" ] }, "Item27": { "title": "Item27", "example": { "id": "", "enterpriseId": "", "practiceId": "", "personId": "", "orderId": "", "collectionDateTime": "", "collectionDateTimeTimezone": "", "orderingProviderId": "", "resultStatus": "", "testDescription": "", "isDeleted": "", "createTimestamp": "", "createTimestampTimezone": "", "locationId": "", "obrComment": "", "loincCode": "", "isConfidential": "", "orderTestId": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "id": { "type": "string" }, "enterpriseId": { "type": "string" }, "practiceId": { "type": "string" }, "personId": { "type": "string" }, "orderId": { "type": "string" }, "collectionDateTime": { "type": "string" }, "collectionDateTimeTimezone": { "type": "string" }, "orderingProviderId": { "type": "string" }, "resultStatus": { "type": "string" }, "testDescription": { "type": "string" }, "isDeleted": { "type": "string" }, "createTimestamp": { "type": "string" }, "createTimestampTimezone": { "type": "string" }, "locationId": { "type": "string" }, "obrComment": { "type": "string" }, "loincCode": { "type": "string" }, "isConfidential": { "type": "string" }, "orderTestId": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "id", "enterpriseId", "practiceId", "personId", "orderId", "collectionDateTime", "collectionDateTimeTimezone", "orderingProviderId", "resultStatus", "testDescription", "isDeleted", "createTimestamp", "createTimestampTimezone", "locationId", "obrComment", "loincCode", "isConfidential", "orderTestId", "_links" ] }, "{{baseUrl}}/persons/:personId/chart/lab/panelsRequest": { "title": "{{baseUrl}}/persons/:personId/chart/lab/panelsRequest", "example": { "OrderId": "", "OrderedTestId": "", "CollectionDateTime": "", "Status": "", "PanelComment": "" }, "type": "object", "properties": { "OrderId": { "type": "string" }, "OrderedTestId": { "type": "string" }, "CollectionDateTime": { "type": "string" }, "Status": { "type": "string" }, "PanelComment": { "type": "string" } }, "required": [ "OrderId", "OrderedTestId", "CollectionDateTime", "Status", "PanelComment" ] }, "OK64": { "title": "OK64", "example": { "id": "", "enterpriseId": "", "practiceId": "", "personId": "", "orderId": "", "collectionDateTime": "", "collectionDateTimeTimezone": "", "orderingProviderId": "", "resultStatus": "", "testDescription": "", "isDeleted": "", "createTimestamp": "", "createTimestampTimezone": "", "locationId": "", "obrComment": "", "loincCode": "", "isConfidential": "", "orderTestId": "", "isMicrobiology": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "id": { "type": "string" }, "enterpriseId": { "type": "string" }, "practiceId": { "type": "string" }, "personId": { "type": "string" }, "orderId": { "type": "string" }, "collectionDateTime": { "type": "string" }, "collectionDateTimeTimezone": { "type": "string" }, "orderingProviderId": { "type": "string" }, "resultStatus": { "type": "string" }, "testDescription": { "type": "string" }, "isDeleted": { "type": "string" }, "createTimestamp": { "type": "string" }, "createTimestampTimezone": { "type": "string" }, "locationId": { "type": "string" }, "obrComment": { "type": "string" }, "loincCode": { "type": "string" }, "isConfidential": { "type": "string" }, "orderTestId": { "type": "string" }, "isMicrobiology": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "id", "enterpriseId", "practiceId", "personId", "orderId", "collectionDateTime", "collectionDateTimeTimezone", "orderingProviderId", "resultStatus", "testDescription", "isDeleted", "createTimestamp", "createTimestampTimezone", "locationId", "obrComment", "loincCode", "isConfidential", "orderTestId", "isMicrobiology", "_links" ] }, "{{baseUrl}}/persons/:personId/chart/lab/panels/:panelIdRequest": { "title": "{{baseUrl}}/persons/:personId/chart/lab/panels/:panelIdRequest", "example": { "OrderId": "", "OrderedTestId": "", "CollectionDateTime": "", "Status": "", "PanelComment": "" }, "type": "object", "properties": { "OrderId": { "type": "string" }, "OrderedTestId": { "type": "string" }, "CollectionDateTime": { "type": "string" }, "Status": { "type": "string" }, "PanelComment": { "type": "string" } }, "required": [ "OrderId", "OrderedTestId", "CollectionDateTime", "Status", "PanelComment" ] }, "OK65": { "title": "OK65", "example": { "panelId": "", "personId": "", "orderId": "", "observationSequenceNumber": "", "enterpriseId": "", "practiceId": "", "observationId": "", "resultCode": "", "resultDescription": "", "codeSystem": "", "observationValue": "", "abnormalityCode": "", "abnormality": "", "resultType": "", "units": "", "referenceRange": "", "observationResultStatus": "", "clinicalName": "", "observationDateTime": "", "observationDateTimeTimezone": "", "loincCode": "", "resultSequenceNumber": "", "hasComment": "", "isDeleted": "", "isSignedOff": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "panelId": { "type": "string" }, "personId": { "type": "string" }, "orderId": { "type": "string" }, "observationSequenceNumber": { "type": "string" }, "enterpriseId": { "type": "string" }, "practiceId": { "type": "string" }, "observationId": { "type": "string" }, "resultCode": { "type": "string" }, "resultDescription": { "type": "string" }, "codeSystem": { "type": "string" }, "observationValue": { "type": "string" }, "abnormalityCode": { "type": "string" }, "abnormality": { "type": "string" }, "resultType": { "type": "string" }, "units": { "type": "string" }, "referenceRange": { "type": "string" }, "observationResultStatus": { "type": "string" }, "clinicalName": { "type": "string" }, "observationDateTime": { "type": "string" }, "observationDateTimeTimezone": { "type": "string" }, "loincCode": { "type": "string" }, "resultSequenceNumber": { "type": "string" }, "hasComment": { "type": "string" }, "isDeleted": { "type": "string" }, "isSignedOff": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "panelId", "personId", "orderId", "observationSequenceNumber", "enterpriseId", "practiceId", "observationId", "resultCode", "resultDescription", "codeSystem", "observationValue", "abnormalityCode", "abnormality", "resultType", "units", "referenceRange", "observationResultStatus", "clinicalName", "observationDateTime", "observationDateTimeTimezone", "loincCode", "resultSequenceNumber", "hasComment", "isDeleted", "isSignedOff", "_links" ] }, "{{baseUrl}}/persons/:personId/chart/lab/panels/:panelId/resultsRequest": { "title": "{{baseUrl}}/persons/:personId/chart/lab/panels/:panelId/resultsRequest", "example": { "Type": "", "ComponentKey": "", "ComponentDescription": "", "Value": "", "Unit": "", "Range": "", "Comment": "", "AbnormalFlag": "", "CodeSystem": "", "ObservationDate": "", "LoincCode": "" }, "type": "object", "properties": { "Type": { "type": "string" }, "ComponentKey": { "type": "string" }, "ComponentDescription": { "type": "string" }, "Value": { "type": "string" }, "Unit": { "type": "string" }, "Range": { "type": "string" }, "Comment": { "type": "string" }, "AbnormalFlag": { "type": "string" }, "CodeSystem": { "type": "string" }, "ObservationDate": { "type": "string" }, "LoincCode": { "type": "string" } }, "required": [ "Type", "ComponentKey", "ComponentDescription", "Value", "Unit", "Range", "Comment", "AbnormalFlag", "CodeSystem", "ObservationDate", "LoincCode" ] }, "{{baseUrl}}/persons/:personId/chart/lab/panels/:panelId/results/:sequenceNumberRequest": { "title": "{{baseUrl}}/persons/:personId/chart/lab/panels/:panelId/results/:sequenceNumberRequest", "example": { "ComponentKey": "", "ComponentDescription": "", "Value": "", "Unit": "", "Range": "", "Comment": "", "AbnormalFlag": "", "CodeSystem": "", "ObservationDate": "", "LoincCode": "" }, "type": "object", "properties": { "ComponentKey": { "type": "string" }, "ComponentDescription": { "type": "string" }, "Value": { "type": "string" }, "Unit": { "type": "string" }, "Range": { "type": "string" }, "Comment": { "type": "string" }, "AbnormalFlag": { "type": "string" }, "CodeSystem": { "type": "string" }, "ObservationDate": { "type": "string" }, "LoincCode": { "type": "string" } }, "required": [ "ComponentKey", "ComponentDescription", "Value", "Unit", "Range", "Comment", "AbnormalFlag", "CodeSystem", "ObservationDate", "LoincCode" ] }, "OK66": { "title": "OK66", "example": { "Items": [ { "panelId": "", "personId": "", "orderId": "", "observationSequenceNumber": "", "enterpriseId": "", "practiceId": "", "observationId": "", "resultCode": "", "resultDescription": "", "codeSystem": "", "observationValue": "", "abnormalityCode": "", "abnormality": "", "resultType": "", "units": "", "referenceRange": "", "observationResultStatus": "", "clinicalName": "", "observationDateTime": "", "observationDateTimeTimezone": "", "loincCode": "", "resultSequenceNumber": "", "hasComment": "", "isDeleted": "", "isSignedOff": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "panelId": "", "personId": "", "orderId": "", "observationSequenceNumber": "", "enterpriseId": "", "practiceId": "", "observationId": "", "resultCode": "", "resultDescription": "", "codeSystem": "", "observationValue": "", "abnormalityCode": "", "abnormality": "", "resultType": "", "units": "", "referenceRange": "", "observationResultStatus": "", "clinicalName": "", "observationDateTime": "", "observationDateTimeTimezone": "", "loincCode": "", "resultSequenceNumber": "", "hasComment": "", "isDeleted": "", "isSignedOff": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" }, "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/Item28" } }, "NextPageLink": { "type": "string" }, "Count": { "type": "string" } }, "required": [ "Items", "NextPageLink", "Count" ] }, "Item28": { "title": "Item28", "example": { "panelId": "", "personId": "", "orderId": "", "observationSequenceNumber": "", "enterpriseId": "", "practiceId": "", "observationId": "", "resultCode": "", "resultDescription": "", "codeSystem": "", "observationValue": "", "abnormalityCode": "", "abnormality": "", "resultType": "", "units": "", "referenceRange": "", "observationResultStatus": "", "clinicalName": "", "observationDateTime": "", "observationDateTimeTimezone": "", "loincCode": "", "resultSequenceNumber": "", "hasComment": "", "isDeleted": "", "isSignedOff": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "panelId": { "type": "string" }, "personId": { "type": "string" }, "orderId": { "type": "string" }, "observationSequenceNumber": { "type": "string" }, "enterpriseId": { "type": "string" }, "practiceId": { "type": "string" }, "observationId": { "type": "string" }, "resultCode": { "type": "string" }, "resultDescription": { "type": "string" }, "codeSystem": { "type": "string" }, "observationValue": { "type": "string" }, "abnormalityCode": { "type": "string" }, "abnormality": { "type": "string" }, "resultType": { "type": "string" }, "units": { "type": "string" }, "referenceRange": { "type": "string" }, "observationResultStatus": { "type": "string" }, "clinicalName": { "type": "string" }, "observationDateTime": { "type": "string" }, "observationDateTimeTimezone": { "type": "string" }, "loincCode": { "type": "string" }, "resultSequenceNumber": { "type": "string" }, "hasComment": { "type": "string" }, "isDeleted": { "type": "string" }, "isSignedOff": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "panelId", "personId", "orderId", "observationSequenceNumber", "enterpriseId", "practiceId", "observationId", "resultCode", "resultDescription", "codeSystem", "observationValue", "abnormalityCode", "abnormality", "resultType", "units", "referenceRange", "observationResultStatus", "clinicalName", "observationDateTime", "observationDateTimeTimezone", "loincCode", "resultSequenceNumber", "hasComment", "isDeleted", "isSignedOff", "_links" ] }, "OK67": { "title": "OK67", "example": { "Items": [ { "id": "", "personId": "", "providerId": "", "fdbName": "", "medicationName": "", "genericName": "", "brandName": "", "isGenericSelected": "", "dose": "", "route": "", "doseForm": "", "originalStartDate": "", "startDate": "", "stopDate": "", "sigDescription": "", "enterpriseId": "", "practiceId": "", "encounterId": "", "sourceProductId": "", "lastAuditType": "", "representativeNdcIndicator": "", "privacyIndicator": "", "isHidden": "", "deaClassCode": "", "medicationId": "", "ndcId": "", "createTimestamp": "", "createTimestampTimezone": "", "rxNormCode": "", "status": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "id": "", "personId": "", "providerId": "", "fdbName": "", "medicationName": "", "genericName": "", "brandName": "", "isGenericSelected": "", "dose": "", "route": "", "doseForm": "", "originalStartDate": "", "startDate": "", "stopDate": "", "sigDescription": "", "enterpriseId": "", "practiceId": "", "encounterId": "", "sourceProductId": "", "lastAuditType": "", "representativeNdcIndicator": "", "privacyIndicator": "", "isHidden": "", "deaClassCode": "", "medicationId": "", "ndcId": "", "createTimestamp": "", "createTimestampTimezone": "", "rxNormCode": "", "status": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" }, "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/Item29" } }, "NextPageLink": { "type": "string" }, "Count": { "type": "string" } }, "required": [ "Items", "NextPageLink", "Count" ] }, "Item29": { "title": "Item29", "example": { "id": "", "personId": "", "providerId": "", "fdbName": "", "medicationName": "", "genericName": "", "brandName": "", "isGenericSelected": "", "dose": "", "route": "", "doseForm": "", "originalStartDate": "", "startDate": "", "stopDate": "", "sigDescription": "", "enterpriseId": "", "practiceId": "", "encounterId": "", "sourceProductId": "", "lastAuditType": "", "representativeNdcIndicator": "", "privacyIndicator": "", "isHidden": "", "deaClassCode": "", "medicationId": "", "ndcId": "", "createTimestamp": "", "createTimestampTimezone": "", "rxNormCode": "", "status": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "id": { "type": "string" }, "personId": { "type": "string" }, "providerId": { "type": "string" }, "fdbName": { "type": "string" }, "medicationName": { "type": "string" }, "genericName": { "type": "string" }, "brandName": { "type": "string" }, "isGenericSelected": { "type": "string" }, "dose": { "type": "string" }, "route": { "type": "string" }, "doseForm": { "type": "string" }, "originalStartDate": { "type": "string" }, "startDate": { "type": "string" }, "stopDate": { "type": "string" }, "sigDescription": { "type": "string" }, "enterpriseId": { "type": "string" }, "practiceId": { "type": "string" }, "encounterId": { "type": "string" }, "sourceProductId": { "type": "string" }, "lastAuditType": { "type": "string" }, "representativeNdcIndicator": { "type": "string" }, "privacyIndicator": { "type": "string" }, "isHidden": { "type": "string" }, "deaClassCode": { "type": "string" }, "medicationId": { "type": "string" }, "ndcId": { "type": "string" }, "createTimestamp": { "type": "string" }, "createTimestampTimezone": { "type": "string" }, "rxNormCode": { "type": "string" }, "status": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "id", "personId", "providerId", "fdbName", "medicationName", "genericName", "brandName", "isGenericSelected", "dose", "route", "doseForm", "originalStartDate", "startDate", "stopDate", "sigDescription", "enterpriseId", "practiceId", "encounterId", "sourceProductId", "lastAuditType", "representativeNdcIndicator", "privacyIndicator", "isHidden", "deaClassCode", "medicationId", "ndcId", "createTimestamp", "createTimestampTimezone", "rxNormCode", "status", "_links" ] }, "OK68": { "title": "OK68", "example": { "medicationHistoryId": "", "personId": "", "pbmId": "", "source": "", "drugDescription": "", "ndcId": "", "quantity": "", "daysSupply": "", "directions": "", "refills": "", "isSubstitutionAllowed": "", "lastFillDate": "", "writtenDate": "", "note": "", "priorAuthorizationStatus": "", "pharmacyName": "", "pharmacyAddressLine1": "", "pharmacyCity": "", "pharmacyState": "", "pharmacyZip": "", "pharmacyPhoneNumber": "", "prescriberName": "", "prescriberAddressLine1": "", "prescriberCity": "", "prescriberState": "", "prescriberZip": "", "prescriberPhoneNumber": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "medicationHistoryId": { "type": "string" }, "personId": { "type": "string" }, "pbmId": { "type": "string" }, "source": { "type": "string" }, "drugDescription": { "type": "string" }, "ndcId": { "type": "string" }, "quantity": { "type": "string" }, "daysSupply": { "type": "string" }, "directions": { "type": "string" }, "refills": { "type": "string" }, "isSubstitutionAllowed": { "type": "string" }, "lastFillDate": { "type": "string" }, "writtenDate": { "type": "string" }, "note": { "type": "string" }, "priorAuthorizationStatus": { "type": "string" }, "pharmacyName": { "type": "string" }, "pharmacyAddressLine1": { "type": "string" }, "pharmacyCity": { "type": "string" }, "pharmacyState": { "type": "string" }, "pharmacyZip": { "type": "string" }, "pharmacyPhoneNumber": { "type": "string" }, "prescriberName": { "type": "string" }, "prescriberAddressLine1": { "type": "string" }, "prescriberCity": { "type": "string" }, "prescriberState": { "type": "string" }, "prescriberZip": { "type": "string" }, "prescriberPhoneNumber": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "medicationHistoryId", "personId", "pbmId", "source", "drugDescription", "ndcId", "quantity", "daysSupply", "directions", "refills", "isSubstitutionAllowed", "lastFillDate", "writtenDate", "note", "priorAuthorizationStatus", "pharmacyName", "pharmacyAddressLine1", "pharmacyCity", "pharmacyState", "pharmacyZip", "pharmacyPhoneNumber", "prescriberName", "prescriberAddressLine1", "prescriberCity", "prescriberState", "prescriberZip", "prescriberPhoneNumber", "_links" ] }, "{{baseUrl}}/persons/:personId/medication-history/create-consent-Request": { "title": "{{baseUrl}}/persons/:personId/medication-history/create-consent-Request", "example": { "ExpiryDate": "", "Memo": "", "Consent": "" }, "type": "object", "properties": { "ExpiryDate": { "type": "string" }, "Memo": { "type": "string" }, "Consent": { "type": "string" } }, "required": [ "ExpiryDate", "Memo", "Consent" ] }, "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/medicationsRequest": { "title": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/medicationsRequest", "example": { "RxQuantity": "", "RxRefills": "", "DispenseAsWritten": "", "IsPrescribedElsewhere": "", "PrivacyIndicator": "", "PrescribedElsewhereLocation": "", "RxComment": "", "RxSpecialInstruction": "", "StartDate": "", "StopDate": "", "ProviderId": "", "LocationId": "", "DiagnosisCode": "", "SecondaryDiagnosisCode": "", "TertiaryDiagnosisCode": "", "IsPrn": "", "PrnReason": "", "RxUnits": "", "FdbDosageId": "", "CustomDosageId": "", "PedOrderId": "", "MedicationId": "", "IsRepresentativeNdc": "", "SigCode": "", "SigDescription": "", "AcknowledgedProblems": [ { "personId": "", "isRequired": "", "acknowledged": "", "severityLevel": "", "description": "", "entityName": "", "eventType": "", "sourceId": "", "cause": "", "warningDetail": "", "warningType": "", "warning": "", "causeText": "", "overrideText": "", "durAuditKey": "", "isSuppressed": "", "isRecordedElseWhere": "", "practiceId": "", "display": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "personId": "", "isRequired": "", "acknowledged": "", "severityLevel": "", "description": "", "entityName": "", "eventType": "", "sourceId": "", "cause": "", "warningDetail": "", "warningType": "", "warning": "", "causeText": "", "overrideText": "", "durAuditKey": "", "isSuppressed": "", "isRecordedElseWhere": "", "practiceId": "", "display": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "SupervisingProviderId": "", "PriorAuthorizationIndicator": "", "PriorAuthorizationDate": "", "PriorAuthorizationId": "", "ByPassDeaRefillLimitCheck": "", "SamplesIndicator": "", "SampleLotNumber": "", "SampleExpirationDate": "", "RefillLimit": "", "PbmId": "", "FormularyId": "", "RxFillIndicator": "" }, "type": "object", "properties": { "RxQuantity": { "type": "string" }, "RxRefills": { "type": "string" }, "DispenseAsWritten": { "type": "string" }, "IsPrescribedElsewhere": { "type": "string" }, "PrivacyIndicator": { "type": "string" }, "PrescribedElsewhereLocation": { "type": "string" }, "RxComment": { "type": "string" }, "RxSpecialInstruction": { "type": "string" }, "StartDate": { "type": "string" }, "StopDate": { "type": "string" }, "ProviderId": { "type": "string" }, "LocationId": { "type": "string" }, "DiagnosisCode": { "type": "string" }, "SecondaryDiagnosisCode": { "type": "string" }, "TertiaryDiagnosisCode": { "type": "string" }, "IsPrn": { "type": "string" }, "PrnReason": { "type": "string" }, "RxUnits": { "type": "string" }, "FdbDosageId": { "type": "string" }, "CustomDosageId": { "type": "string" }, "PedOrderId": { "type": "string" }, "MedicationId": { "type": "string" }, "IsRepresentativeNdc": { "type": "string" }, "SigCode": { "type": "string" }, "SigDescription": { "type": "string" }, "AcknowledgedProblems": { "type": "array", "items": { "$ref": "#/definitions/AcknowledgedProblem" } }, "SupervisingProviderId": { "type": "string" }, "PriorAuthorizationIndicator": { "type": "string" }, "PriorAuthorizationDate": { "type": "string" }, "PriorAuthorizationId": { "type": "string" }, "ByPassDeaRefillLimitCheck": { "type": "string" }, "SamplesIndicator": { "type": "string" }, "SampleLotNumber": { "type": "string" }, "SampleExpirationDate": { "type": "string" }, "RefillLimit": { "type": "string" }, "PbmId": { "type": "string" }, "FormularyId": { "type": "string" }, "RxFillIndicator": { "type": "string" } }, "required": [ "RxQuantity", "RxRefills", "DispenseAsWritten", "IsPrescribedElsewhere", "PrivacyIndicator", "PrescribedElsewhereLocation", "RxComment", "RxSpecialInstruction", "StartDate", "StopDate", "ProviderId", "LocationId", "DiagnosisCode", "SecondaryDiagnosisCode", "TertiaryDiagnosisCode", "IsPrn", "PrnReason", "RxUnits", "FdbDosageId", "CustomDosageId", "PedOrderId", "MedicationId", "IsRepresentativeNdc", "SigCode", "SigDescription", "AcknowledgedProblems", "SupervisingProviderId", "PriorAuthorizationIndicator", "PriorAuthorizationDate", "PriorAuthorizationId", "ByPassDeaRefillLimitCheck", "SamplesIndicator", "SampleLotNumber", "SampleExpirationDate", "RefillLimit", "PbmId", "FormularyId", "RxFillIndicator" ] }, "AcknowledgedProblem": { "title": "AcknowledgedProblem", "example": { "personId": "", "isRequired": "", "acknowledged": "", "severityLevel": "", "description": "", "entityName": "", "eventType": "", "sourceId": "", "cause": "", "warningDetail": "", "warningType": "", "warning": "", "causeText": "", "overrideText": "", "durAuditKey": "", "isSuppressed": "", "isRecordedElseWhere": "", "practiceId": "", "display": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "personId": { "type": "string" }, "isRequired": { "type": "string" }, "acknowledged": { "type": "string" }, "severityLevel": { "type": "string" }, "description": { "type": "string" }, "entityName": { "type": "string" }, "eventType": { "type": "string" }, "sourceId": { "type": "string" }, "cause": { "type": "string" }, "warningDetail": { "type": "string" }, "warningType": { "type": "string" }, "warning": { "type": "string" }, "causeText": { "type": "string" }, "overrideText": { "type": "string" }, "durAuditKey": { "type": "string" }, "isSuppressed": { "type": "string" }, "isRecordedElseWhere": { "type": "string" }, "practiceId": { "type": "string" }, "display": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "personId", "isRequired", "acknowledged", "severityLevel", "description", "entityName", "eventType", "sourceId", "cause", "warningDetail", "warningType", "warning", "causeText", "overrideText", "durAuditKey", "isSuppressed", "isRecordedElseWhere", "practiceId", "display", "_links" ] }, "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/medications/:medicationIdRequest": { "title": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/medications/:medicationIdRequest", "example": { "DeleteReason": "" }, "type": "object", "properties": { "DeleteReason": { "type": "string" } }, "required": [ "DeleteReason" ] }, "OK70": { "title": "OK70", "example": { "id": "", "fdbName": "", "medicationName": "", "genericName": "", "brandName": "", "dose": "", "doseForm": "", "ndcId": "", "gcn": "", "route": "", "hiclSequenceNumber": "", "gcnSequenceNumber": "", "deaClassCode": "", "medicationId": "", "isAvailable": "", "createdBy": "", "createTimestamp": "", "createTimestampTimezone": "", "modifiedBy": "", "modifyTimestamp": "", "modifyTimestampTimezone": "", "personId": "", "encounterId": "", "encounterProviderId": "", "encounterTimestamp": "", "encounterTimestampTimezone": "", "providerId": "", "locationId": "", "practiceId": "", "practiceName": "", "enterpriseId": "", "enterpriseName": "", "startDate": "", "originalStartDate": "", "stopDate": "", "sigCodes": "", "rxQuantity": "", "rxRefills": "", "isGenericAllowed": "", "isSample": "", "dispenseAsWritten": "", "orgRefills": "", "lastRefillDate": "", "sigDescription": "", "isPrescribedElsewhere": "", "rxUnits": "", "rxComment": "", "rxSpecialInstruction": "", "printSpanishIndicator": "", "isGenericSelected": "", "diagnosisCode": "", "secondaryDiagnosisCode": "", "tertiaryDiagnosisCode": "", "representativeNdcIndicator": "", "prnReason": "", "formularyId": "", "formulaOverrideCode": "", "formulaOverrideText": "", "originalRxNdc": "", "formulaStatus": "", "auditMask": "", "auditId": "", "sendAuditId": "", "lastAuditType": "", "lotNumber": "", "expirationDate": "", "isPrn": "", "renewParentId": "", "rxUnitCode": "", "oldId": "", "rxRenewNote": "", "FdbDosageId": "", "refillLimit": "", "refillLimitDate": "", "prescribedElsewhereLocation": "", "priorAuthorizationIndicator": "", "priorAuthorizationId": "", "priorAuthorizationDate": "", "privacyIndicator": "", "refillsRemaining": "", "customDosageId": "", "isAutoCalculated": "", "pbmId": "", "formularyDetailData": "", "formularySummaryData": "", "sourceProductId": "", "supervisingProviderId": "", "ineffectiveMedicationIndicator": "", "pedOrderId": "", "eCouponNote": "", "eCouponUrl": "", "auditTimestamp": "", "isErxDisabledByState": "", "isFaxDisabledByState": "", "isHidden": "", "isSupply": "", "rxNormCode": "", "status": "", "rxFillIndicator": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "id": { "type": "string" }, "fdbName": { "type": "string" }, "medicationName": { "type": "string" }, "genericName": { "type": "string" }, "brandName": { "type": "string" }, "dose": { "type": "string" }, "doseForm": { "type": "string" }, "ndcId": { "type": "string" }, "gcn": { "type": "string" }, "route": { "type": "string" }, "hiclSequenceNumber": { "type": "string" }, "gcnSequenceNumber": { "type": "string" }, "deaClassCode": { "type": "string" }, "medicationId": { "type": "string" }, "isAvailable": { "type": "string" }, "createdBy": { "type": "string" }, "createTimestamp": { "type": "string" }, "createTimestampTimezone": { "type": "string" }, "modifiedBy": { "type": "string" }, "modifyTimestamp": { "type": "string" }, "modifyTimestampTimezone": { "type": "string" }, "personId": { "type": "string" }, "encounterId": { "type": "string" }, "encounterProviderId": { "type": "string" }, "encounterTimestamp": { "type": "string" }, "encounterTimestampTimezone": { "type": "string" }, "providerId": { "type": "string" }, "locationId": { "type": "string" }, "practiceId": { "type": "string" }, "practiceName": { "type": "string" }, "enterpriseId": { "type": "string" }, "enterpriseName": { "type": "string" }, "startDate": { "type": "string" }, "originalStartDate": { "type": "string" }, "stopDate": { "type": "string" }, "sigCodes": { "type": "string" }, "rxQuantity": { "type": "string" }, "rxRefills": { "type": "string" }, "isGenericAllowed": { "type": "string" }, "isSample": { "type": "string" }, "dispenseAsWritten": { "type": "string" }, "orgRefills": { "type": "string" }, "lastRefillDate": { "type": "string" }, "sigDescription": { "type": "string" }, "isPrescribedElsewhere": { "type": "string" }, "rxUnits": { "type": "string" }, "rxComment": { "type": "string" }, "rxSpecialInstruction": { "type": "string" }, "printSpanishIndicator": { "type": "string" }, "isGenericSelected": { "type": "string" }, "diagnosisCode": { "type": "string" }, "secondaryDiagnosisCode": { "type": "string" }, "tertiaryDiagnosisCode": { "type": "string" }, "representativeNdcIndicator": { "type": "string" }, "prnReason": { "type": "string" }, "formularyId": { "type": "string" }, "formulaOverrideCode": { "type": "string" }, "formulaOverrideText": { "type": "string" }, "originalRxNdc": { "type": "string" }, "formulaStatus": { "type": "string" }, "auditMask": { "type": "string" }, "auditId": { "type": "string" }, "sendAuditId": { "type": "string" }, "lastAuditType": { "type": "string" }, "lotNumber": { "type": "string" }, "expirationDate": { "type": "string" }, "isPrn": { "type": "string" }, "renewParentId": { "type": "string" }, "rxUnitCode": { "type": "string" }, "oldId": { "type": "string" }, "rxRenewNote": { "type": "string" }, "FdbDosageId": { "type": "string" }, "refillLimit": { "type": "string" }, "refillLimitDate": { "type": "string" }, "prescribedElsewhereLocation": { "type": "string" }, "priorAuthorizationIndicator": { "type": "string" }, "priorAuthorizationId": { "type": "string" }, "priorAuthorizationDate": { "type": "string" }, "privacyIndicator": { "type": "string" }, "refillsRemaining": { "type": "string" }, "customDosageId": { "type": "string" }, "isAutoCalculated": { "type": "string" }, "pbmId": { "type": "string" }, "formularyDetailData": { "type": "string" }, "formularySummaryData": { "type": "string" }, "sourceProductId": { "type": "string" }, "supervisingProviderId": { "type": "string" }, "ineffectiveMedicationIndicator": { "type": "string" }, "pedOrderId": { "type": "string" }, "eCouponNote": { "type": "string" }, "eCouponUrl": { "type": "string" }, "auditTimestamp": { "type": "string" }, "isErxDisabledByState": { "type": "string" }, "isFaxDisabledByState": { "type": "string" }, "isHidden": { "type": "string" }, "isSupply": { "type": "string" }, "rxNormCode": { "type": "string" }, "status": { "type": "string" }, "rxFillIndicator": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "id", "fdbName", "medicationName", "genericName", "brandName", "dose", "doseForm", "ndcId", "gcn", "route", "hiclSequenceNumber", "gcnSequenceNumber", "deaClassCode", "medicationId", "isAvailable", "createdBy", "createTimestamp", "createTimestampTimezone", "modifiedBy", "modifyTimestamp", "modifyTimestampTimezone", "personId", "encounterId", "encounterProviderId", "encounterTimestamp", "encounterTimestampTimezone", "providerId", "locationId", "practiceId", "practiceName", "enterpriseId", "enterpriseName", "startDate", "originalStartDate", "stopDate", "sigCodes", "rxQuantity", "rxRefills", "isGenericAllowed", "isSample", "dispenseAsWritten", "orgRefills", "lastRefillDate", "sigDescription", "isPrescribedElsewhere", "rxUnits", "rxComment", "rxSpecialInstruction", "printSpanishIndicator", "isGenericSelected", "diagnosisCode", "secondaryDiagnosisCode", "tertiaryDiagnosisCode", "representativeNdcIndicator", "prnReason", "formularyId", "formulaOverrideCode", "formulaOverrideText", "originalRxNdc", "formulaStatus", "auditMask", "auditId", "sendAuditId", "lastAuditType", "lotNumber", "expirationDate", "isPrn", "renewParentId", "rxUnitCode", "oldId", "rxRenewNote", "FdbDosageId", "refillLimit", "refillLimitDate", "prescribedElsewhereLocation", "priorAuthorizationIndicator", "priorAuthorizationId", "priorAuthorizationDate", "privacyIndicator", "refillsRemaining", "customDosageId", "isAutoCalculated", "pbmId", "formularyDetailData", "formularySummaryData", "sourceProductId", "supervisingProviderId", "ineffectiveMedicationIndicator", "pedOrderId", "eCouponNote", "eCouponUrl", "auditTimestamp", "isErxDisabledByState", "isFaxDisabledByState", "isHidden", "isSupply", "rxNormCode", "status", "rxFillIndicator", "_links" ] }, "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/medications/:medicationIdRequest1": { "title": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/medications/:medicationIdRequest1", "example": { "RxQuantity": "", "RxRefills": "", "DispenseAsWritten": "", "IsPrescribedElsewhere": "", "PrivacyIndicator": "", "PrescribedElsewhereLocation": "", "RxComment": "", "RxSpecialInstruction": "", "StartDate": "", "StopDate": "", "ProviderId": "", "LocationId": "", "DiagnosisCode": "", "SecondaryDiagnosisCode": "", "TertiaryDiagnosisCode": "", "IsPrn": "", "PrnReason": "", "RxUnits": "", "FdbDosageId": "", "CustomDosageId": "", "PedOrderId": "", "MedicationId": "", "IsRepresentativeNdc": "", "SigCode": "", "SigDescription": "", "AcknowledgedProblems": [ { "personId": "", "isRequired": "", "acknowledged": "", "severityLevel": "", "description": "", "entityName": "", "eventType": "", "sourceId": "", "cause": "", "warningDetail": "", "warningType": "", "warning": "", "causeText": "", "overrideText": "", "durAuditKey": "", "isSuppressed": "", "isRecordedElseWhere": "", "practiceId": "", "display": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "personId": "", "isRequired": "", "acknowledged": "", "severityLevel": "", "description": "", "entityName": "", "eventType": "", "sourceId": "", "cause": "", "warningDetail": "", "warningType": "", "warning": "", "causeText": "", "overrideText": "", "durAuditKey": "", "isSuppressed": "", "isRecordedElseWhere": "", "practiceId": "", "display": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "SupervisingProviderId": "", "PriorAuthorizationIndicator": "", "PriorAuthorizationDate": "", "PriorAuthorizationId": "", "ByPassDeaRefillLimitCheck": "", "SamplesIndicator": "", "SampleLotNumber": "", "SampleExpirationDate": "", "RefillLimit": "", "PbmId": "", "FormularyId": "", "RxFillIndicator": "" }, "type": "object", "properties": { "RxQuantity": { "type": "string" }, "RxRefills": { "type": "string" }, "DispenseAsWritten": { "type": "string" }, "IsPrescribedElsewhere": { "type": "string" }, "PrivacyIndicator": { "type": "string" }, "PrescribedElsewhereLocation": { "type": "string" }, "RxComment": { "type": "string" }, "RxSpecialInstruction": { "type": "string" }, "StartDate": { "type": "string" }, "StopDate": { "type": "string" }, "ProviderId": { "type": "string" }, "LocationId": { "type": "string" }, "DiagnosisCode": { "type": "string" }, "SecondaryDiagnosisCode": { "type": "string" }, "TertiaryDiagnosisCode": { "type": "string" }, "IsPrn": { "type": "string" }, "PrnReason": { "type": "string" }, "RxUnits": { "type": "string" }, "FdbDosageId": { "type": "string" }, "CustomDosageId": { "type": "string" }, "PedOrderId": { "type": "string" }, "MedicationId": { "type": "string" }, "IsRepresentativeNdc": { "type": "string" }, "SigCode": { "type": "string" }, "SigDescription": { "type": "string" }, "AcknowledgedProblems": { "type": "array", "items": { "$ref": "#/definitions/AcknowledgedProblem" } }, "SupervisingProviderId": { "type": "string" }, "PriorAuthorizationIndicator": { "type": "string" }, "PriorAuthorizationDate": { "type": "string" }, "PriorAuthorizationId": { "type": "string" }, "ByPassDeaRefillLimitCheck": { "type": "string" }, "SamplesIndicator": { "type": "string" }, "SampleLotNumber": { "type": "string" }, "SampleExpirationDate": { "type": "string" }, "RefillLimit": { "type": "string" }, "PbmId": { "type": "string" }, "FormularyId": { "type": "string" }, "RxFillIndicator": { "type": "string" } }, "required": [ "RxQuantity", "RxRefills", "DispenseAsWritten", "IsPrescribedElsewhere", "PrivacyIndicator", "PrescribedElsewhereLocation", "RxComment", "RxSpecialInstruction", "StartDate", "StopDate", "ProviderId", "LocationId", "DiagnosisCode", "SecondaryDiagnosisCode", "TertiaryDiagnosisCode", "IsPrn", "PrnReason", "RxUnits", "FdbDosageId", "CustomDosageId", "PedOrderId", "MedicationId", "IsRepresentativeNdc", "SigCode", "SigDescription", "AcknowledgedProblems", "SupervisingProviderId", "PriorAuthorizationIndicator", "PriorAuthorizationDate", "PriorAuthorizationId", "ByPassDeaRefillLimitCheck", "SamplesIndicator", "SampleLotNumber", "SampleExpirationDate", "RefillLimit", "PbmId", "FormularyId", "RxFillIndicator" ] }, "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/medications/:medicationId/renewRequest": { "title": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/medications/:medicationId/renewRequest", "example": { "RxQuantity": "", "RxRefills": "", "DispenseAsWritten": "", "IsPrescribedElsewhere": "", "PrivacyIndicator": "", "PrescribedElsewhereLocation": "", "RxComment": "", "RxSpecialInstruction": "", "StartDate": "", "StopDate": "", "ProviderId": "", "LocationId": "", "DiagnosisCode": "", "SecondaryDiagnosisCode": "", "TertiaryDiagnosisCode": "", "IsPrn": "", "PrnReason": "", "RxUnits": "", "FdbDosageId": "", "CustomDosageId": "", "PedOrderId": "", "MedicationId": "", "IsRepresentativeNdc": "", "SigCode": "", "SigDescription": "", "AcknowledgedProblems": [ { "personId": "", "isRequired": "", "acknowledged": "", "severityLevel": "", "description": "", "entityName": "", "eventType": "", "sourceId": "", "cause": "", "warningDetail": "", "warningType": "", "warning": "", "causeText": "", "overrideText": "", "durAuditKey": "", "isSuppressed": "", "isRecordedElseWhere": "", "practiceId": "", "display": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "personId": "", "isRequired": "", "acknowledged": "", "severityLevel": "", "description": "", "entityName": "", "eventType": "", "sourceId": "", "cause": "", "warningDetail": "", "warningType": "", "warning": "", "causeText": "", "overrideText": "", "durAuditKey": "", "isSuppressed": "", "isRecordedElseWhere": "", "practiceId": "", "display": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "SupervisingProviderId": "", "PriorAuthorizationIndicator": "", "PriorAuthorizationDate": "", "PriorAuthorizationId": "", "ByPassDeaRefillLimitCheck": "", "SamplesIndicator": "", "SampleLotNumber": "", "SampleExpirationDate": "", "RefillLimit": "", "PbmId": "", "FormularyId": "", "RxFillIndicator": "" }, "type": "object", "properties": { "RxQuantity": { "type": "string" }, "RxRefills": { "type": "string" }, "DispenseAsWritten": { "type": "string" }, "IsPrescribedElsewhere": { "type": "string" }, "PrivacyIndicator": { "type": "string" }, "PrescribedElsewhereLocation": { "type": "string" }, "RxComment": { "type": "string" }, "RxSpecialInstruction": { "type": "string" }, "StartDate": { "type": "string" }, "StopDate": { "type": "string" }, "ProviderId": { "type": "string" }, "LocationId": { "type": "string" }, "DiagnosisCode": { "type": "string" }, "SecondaryDiagnosisCode": { "type": "string" }, "TertiaryDiagnosisCode": { "type": "string" }, "IsPrn": { "type": "string" }, "PrnReason": { "type": "string" }, "RxUnits": { "type": "string" }, "FdbDosageId": { "type": "string" }, "CustomDosageId": { "type": "string" }, "PedOrderId": { "type": "string" }, "MedicationId": { "type": "string" }, "IsRepresentativeNdc": { "type": "string" }, "SigCode": { "type": "string" }, "SigDescription": { "type": "string" }, "AcknowledgedProblems": { "type": "array", "items": { "$ref": "#/definitions/AcknowledgedProblem" } }, "SupervisingProviderId": { "type": "string" }, "PriorAuthorizationIndicator": { "type": "string" }, "PriorAuthorizationDate": { "type": "string" }, "PriorAuthorizationId": { "type": "string" }, "ByPassDeaRefillLimitCheck": { "type": "string" }, "SamplesIndicator": { "type": "string" }, "SampleLotNumber": { "type": "string" }, "SampleExpirationDate": { "type": "string" }, "RefillLimit": { "type": "string" }, "PbmId": { "type": "string" }, "FormularyId": { "type": "string" }, "RxFillIndicator": { "type": "string" } }, "required": [ "RxQuantity", "RxRefills", "DispenseAsWritten", "IsPrescribedElsewhere", "PrivacyIndicator", "PrescribedElsewhereLocation", "RxComment", "RxSpecialInstruction", "StartDate", "StopDate", "ProviderId", "LocationId", "DiagnosisCode", "SecondaryDiagnosisCode", "TertiaryDiagnosisCode", "IsPrn", "PrnReason", "RxUnits", "FdbDosageId", "CustomDosageId", "PedOrderId", "MedicationId", "IsRepresentativeNdc", "SigCode", "SigDescription", "AcknowledgedProblems", "SupervisingProviderId", "PriorAuthorizationIndicator", "PriorAuthorizationDate", "PriorAuthorizationId", "ByPassDeaRefillLimitCheck", "SamplesIndicator", "SampleLotNumber", "SampleExpirationDate", "RefillLimit", "PbmId", "FormularyId", "RxFillIndicator" ] }, "OK73": { "title": "OK73", "example": { "Items": [ { "id": "", "noteType": "", "note": "", "personId": "", "medicationId": "", "createdBy": "", "modifiedBy": "", "createTimestamp": "", "createTimestampTimezone": "", "modifyTimestamp": "", "modifyTimestampTimezone": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "id": "", "noteType": "", "note": "", "personId": "", "medicationId": "", "createdBy": "", "modifiedBy": "", "createTimestamp": "", "createTimestampTimezone": "", "modifyTimestamp": "", "modifyTimestampTimezone": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" }, "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/Item32" } }, "NextPageLink": { "type": "string" }, "Count": { "type": "string" } }, "required": [ "Items", "NextPageLink", "Count" ] }, "Item32": { "title": "Item32", "example": { "id": "", "noteType": "", "note": "", "personId": "", "medicationId": "", "createdBy": "", "modifiedBy": "", "createTimestamp": "", "createTimestampTimezone": "", "modifyTimestamp": "", "modifyTimestampTimezone": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "id": { "type": "string" }, "noteType": { "type": "string" }, "note": { "type": "string" }, "personId": { "type": "string" }, "medicationId": { "type": "string" }, "createdBy": { "type": "string" }, "modifiedBy": { "type": "string" }, "createTimestamp": { "type": "string" }, "createTimestampTimezone": { "type": "string" }, "modifyTimestamp": { "type": "string" }, "modifyTimestampTimezone": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "id", "noteType", "note", "personId", "medicationId", "createdBy", "modifiedBy", "createTimestamp", "createTimestampTimezone", "modifyTimestamp", "modifyTimestampTimezone", "_links" ] }, "{{baseUrl}}/persons/:personId/chart/medications/:medicationId/notesRequest": { "title": "{{baseUrl}}/persons/:personId/chart/medications/:medicationId/notesRequest", "example": { "Type": "", "Note": "" }, "type": "object", "properties": { "Type": { "type": "string" }, "Note": { "type": "string" } }, "required": [ "Type", "Note" ] }, "OK74": { "title": "OK74", "example": { "id": "", "noteType": "", "note": "", "personId": "", "medicationId": "", "createdBy": "", "modifiedBy": "", "createTimestamp": "", "createTimestampTimezone": "", "modifyTimestamp": "", "modifyTimestampTimezone": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "id": { "type": "string" }, "noteType": { "type": "string" }, "note": { "type": "string" }, "personId": { "type": "string" }, "medicationId": { "type": "string" }, "createdBy": { "type": "string" }, "modifiedBy": { "type": "string" }, "createTimestamp": { "type": "string" }, "createTimestampTimezone": { "type": "string" }, "modifyTimestamp": { "type": "string" }, "modifyTimestampTimezone": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "id", "noteType", "note", "personId", "medicationId", "createdBy", "modifiedBy", "createTimestamp", "createTimestampTimezone", "modifyTimestamp", "modifyTimestampTimezone", "_links" ] }, "{{baseUrl}}/persons/:personId/chart/medications/:medicationId/notes/:noteIdRequest": { "title": "{{baseUrl}}/persons/:personId/chart/medications/:medicationId/notes/:noteIdRequest", "example": { "Type": "", "Note": "" }, "type": "object", "properties": { "Type": { "type": "string" }, "Note": { "type": "string" } }, "required": [ "Type", "Note" ] }, "{{baseUrl}}/persons/:personId/chart/medications/:medicationId/send-erx-Request": { "title": "{{baseUrl}}/persons/:personId/chart/medications/:medicationId/send-erx-Request", "example": { "PharmacyId": "", "PbmId": "", "FormularyId": "" }, "type": "object", "properties": { "PharmacyId": { "type": "string" }, "PbmId": { "type": "string" }, "FormularyId": { "type": "string" } }, "required": [ "PharmacyId", "PbmId", "FormularyId" ] }, "{{baseUrl}}/persons/:personId/chart/medications/:medicationId/stopRequest": { "title": "{{baseUrl}}/persons/:personId/chart/medications/:medicationId/stopRequest", "example": { "MarkIneffective": "" }, "type": "object", "properties": { "MarkIneffective": { "type": "string" } }, "required": [ "MarkIneffective" ] }, "OK75": { "title": "OK75", "example": { "drugName": "", "medicationName": "", "gcnSequenceNumber": "", "monographCode": "", "monograph": [ "", "" ], "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "drugName": { "type": "string" }, "medicationName": { "type": "string" }, "gcnSequenceNumber": { "type": "string" }, "monographCode": { "type": "string" }, "monograph": { "type": "array", "items": { "type": "string" } }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "drugName", "medicationName", "gcnSequenceNumber", "monographCode", "monograph", "_links" ] }, "OK76": { "title": "OK76", "example": { "resourceType": "", "baseUrl": "", "resourceUrl": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "resourceType": { "type": "string" }, "baseUrl": { "type": "string" }, "resourceUrl": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "resourceType", "baseUrl", "resourceUrl", "_links" ] }, "OK78": { "title": "OK78", "example": { "Count": "", "Items": [ { "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ], "checkInDateTime": "", "checkInTimezone": "", "checkOutDateTime": "", "checkOutTimezone": "", "encounterNumber": "", "enterpriseId": "", "id": "", "isLocked": "", "isSensitive": "", "locationId": "", "locationName": "", "personId": "", "practiceId": "", "printOnStatements": "", "referringProviderId": "", "referringProviderName": "", "renderingProviderId": "", "renderingProviderName": "", "status": "", "suppressOutreach": "", "suppressPortal": "", "timestamp": "", "timestampTimezone": "" }, { "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ], "checkInDateTime": "", "checkInTimezone": "", "checkOutDateTime": "", "checkOutTimezone": "", "encounterNumber": "", "enterpriseId": "", "id": "", "isLocked": "", "isSensitive": "", "locationId": "", "locationName": "", "personId": "", "practiceId": "", "printOnStatements": "", "referringProviderId": "", "referringProviderName": "", "renderingProviderId": "", "renderingProviderName": "", "status": "", "suppressOutreach": "", "suppressPortal": "", "timestamp": "", "timestampTimezone": "" } ], "NextPageLink": "" }, "type": "object", "properties": { "Count": { "type": "string" }, "Items": { "type": "array", "items": { "$ref": "#/definitions/Item34" } }, "NextPageLink": { "type": "string" } }, "required": [ "Count", "Items", "NextPageLink" ] }, "Item34": { "title": "Item34", "example": { "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ], "checkInDateTime": "", "checkInTimezone": "", "checkOutDateTime": "", "checkOutTimezone": "", "encounterNumber": "", "enterpriseId": "", "id": "", "isLocked": "", "isSensitive": "", "locationId": "", "locationName": "", "personId": "", "practiceId": "", "printOnStatements": "", "referringProviderId": "", "referringProviderName": "", "renderingProviderId": "", "renderingProviderName": "", "status": "", "suppressOutreach": "", "suppressPortal": "", "timestamp": "", "timestampTimezone": "" }, "type": "object", "properties": { "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } }, "checkInDateTime": { "type": "string" }, "checkInTimezone": { "type": "string" }, "checkOutDateTime": { "type": "string" }, "checkOutTimezone": { "type": "string" }, "encounterNumber": { "type": "string" }, "enterpriseId": { "type": "string" }, "id": { "type": "string" }, "isLocked": { "type": "string" }, "isSensitive": { "type": "string" }, "locationId": { "type": "string" }, "locationName": { "type": "string" }, "personId": { "type": "string" }, "practiceId": { "type": "string" }, "printOnStatements": { "type": "string" }, "referringProviderId": { "type": "string" }, "referringProviderName": { "type": "string" }, "renderingProviderId": { "type": "string" }, "renderingProviderName": { "type": "string" }, "status": { "type": "string" }, "suppressOutreach": { "type": "string" }, "suppressPortal": { "type": "string" }, "timestamp": { "type": "string" }, "timestampTimezone": { "type": "string" } }, "required": [ "_links", "checkInDateTime", "checkInTimezone", "checkOutDateTime", "checkOutTimezone", "encounterNumber", "enterpriseId", "id", "isLocked", "isSensitive", "locationId", "locationName", "personId", "practiceId", "printOnStatements", "referringProviderId", "referringProviderName", "renderingProviderId", "renderingProviderName", "status", "suppressOutreach", "suppressPortal", "timestamp", "timestampTimezone" ] }, "OK79": { "title": "OK79", "example": { "id": "", "firstName": "", "lastName": "", "middleName": "", "prefix": "", "prefixId": "", "suffix": "", "suffixId": "", "addressLine1": "", "addressLine2": "", "city": "", "state": "", "zip": "", "countryId": "", "country": "", "countyId": "", "county": "", "secondaryAddressLine1": "", "secondaryAddressLine2": "", "secondaryCity": "", "secondaryState": "", "secondaryZip": "", "secondaryCountryId": "", "secondaryCountry": "", "secondaryCountyId": "", "secondaryCounty": "", "homePhone": "", "homePhoneComment": "", "secondaryHomePhone": "", "secondaryHomePhoneComment": "", "dayPhone": "", "dayPhoneExtension": "", "dayPhoneComment": "", "alternatePhone": "", "alternatePhoneDescription": "", "alternatePhoneExtension": "", "alternatePhoneComment": "", "internationalHomePhone": "", "internationalWorkPhone": "", "internationalZip": "", "cellPhone": "", "cellPhoneComment": "", "email": "", "emailAddressComment": "", "contactSequence": "", "sex": "", "dateOfBirth": "", "age": "", "socialSecurityNumber": "", "contactPreferenceId": "", "contactPreferenceDescription": "", "primaryCareProviderId": "", "primaryCareProviderFullName": "", "primaryCareProviderFirstName": "", "primaryCareProviderLastName": "", "primaryCareProviderMiddleInitial": "", "maritalStatus": "", "studentStatus": "", "isExpired": "", "isSmoker": "", "isVeteran": "", "notificationPreferenceSelected": "", "preferredLanguageId": "", "preferredLanguage": "", "religionId": "", "churchId": "", "udsHomelessStatusId": "", "udsMigrantWorkerStatusId": "", "udsLanguageBarrierId": "", "udsPrimaryMedicalCoverageId": "", "udsPublicHousingPrimaryCareId": "", "udsSchoolBasedHealthCenterId": "", "udsTribalAffiliationId": "", "udsBloodQuantumId": "", "udsVeteranStatus": "", "isSelfPayer": "", "udsHasConsentToTreat": "", "udsConsentToTreatDate": "", "udsIhsEligibilityStatusId": "", "udsTribalClassId": "", "udsDecendancyId": "", "communityCodeId": "", "currentGender": "", "previousFirstName": "", "sexualOrientation": "", "preferredPronoun": "", "patientStatusId": "", "patientStatusChangeReasonId": "", "userDefinedDemographic1Id": "", "userDefinedDemographic2Id": "", "userDefinedDemographic3Id": "", "userDefinedDemographic4Id": "", "userDefinedDemographic5Id": "", "userDefinedDemographic6Id": "", "userDefinedDemographic7Id": "", "userDefinedDemographic8Id": "", "userDefinedDemographic9Id": "", "userDefinedDemographic10Id": "", "userDefinedDemographic11Id": "", "userDefinedDemographic12Id": "", "userDefinedDemographic13Id": "", "userDefinedDemographic14Id": "", "isCurrentGenderProtected": "", "isGenderIdentityProtected": "", "isPreferredPronounProtected": "", "isSexualOrientationProtected": "", "otherIdNumber": "", "priorLastName": "", "externalId": "", "primaryDentalProviderId": "", "primaryDentalProviderName": "", "nickname": "", "showContactInfoOnAlert": "", "mothersMaidenName": "", "hasEmail": "", "hasPhoneNumber": "", "usesPortal": "", "usesSms": "", "hasVoice": "", "isOptOut": "", "isHomePhoneNotApplicable": "", "isCellPhoneNotApplicable": "", "isAlternatePhoneNotApplicable": "", "isDayPhoneNotApplicable": "", "isSecondaryHomePhoneNotApplicable": "", "isInternationalPhoneNotApplicable": "", "isEmailNotApplicable": "", "expiredDate": "", "expiredTime": "", "expiredTimeTz": "", "birthMothersLastName": "", "birthMothersFirstName": "", "birthMothersMiddleName": "", "exemptFromPersonMerge": "", "addressTypeId": "", "secondaryAddressTypeId": "", "isEnterpriseChart": "", "otherReasonSexualOrientation": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "id": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "middleName": { "type": "string" }, "prefix": { "type": "string" }, "prefixId": { "type": "string" }, "suffix": { "type": "string" }, "suffixId": { "type": "string" }, "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "countryId": { "type": "string" }, "country": { "type": "string" }, "countyId": { "type": "string" }, "county": { "type": "string" }, "secondaryAddressLine1": { "type": "string" }, "secondaryAddressLine2": { "type": "string" }, "secondaryCity": { "type": "string" }, "secondaryState": { "type": "string" }, "secondaryZip": { "type": "string" }, "secondaryCountryId": { "type": "string" }, "secondaryCountry": { "type": "string" }, "secondaryCountyId": { "type": "string" }, "secondaryCounty": { "type": "string" }, "homePhone": { "type": "string" }, "homePhoneComment": { "type": "string" }, "secondaryHomePhone": { "type": "string" }, "secondaryHomePhoneComment": { "type": "string" }, "dayPhone": { "type": "string" }, "dayPhoneExtension": { "type": "string" }, "dayPhoneComment": { "type": "string" }, "alternatePhone": { "type": "string" }, "alternatePhoneDescription": { "type": "string" }, "alternatePhoneExtension": { "type": "string" }, "alternatePhoneComment": { "type": "string" }, "internationalHomePhone": { "type": "string" }, "internationalWorkPhone": { "type": "string" }, "internationalZip": { "type": "string" }, "cellPhone": { "type": "string" }, "cellPhoneComment": { "type": "string" }, "email": { "type": "string" }, "emailAddressComment": { "type": "string" }, "contactSequence": { "type": "string" }, "sex": { "type": "string" }, "dateOfBirth": { "type": "string" }, "age": { "type": "string" }, "socialSecurityNumber": { "type": "string" }, "contactPreferenceId": { "type": "string" }, "contactPreferenceDescription": { "type": "string" }, "primaryCareProviderId": { "type": "string" }, "primaryCareProviderFullName": { "type": "string" }, "primaryCareProviderFirstName": { "type": "string" }, "primaryCareProviderLastName": { "type": "string" }, "primaryCareProviderMiddleInitial": { "type": "string" }, "maritalStatus": { "type": "string" }, "studentStatus": { "type": "string" }, "isExpired": { "type": "string" }, "isSmoker": { "type": "string" }, "isVeteran": { "type": "string" }, "notificationPreferenceSelected": { "type": "string" }, "preferredLanguageId": { "type": "string" }, "preferredLanguage": { "type": "string" }, "religionId": { "type": "string" }, "churchId": { "type": "string" }, "udsHomelessStatusId": { "type": "string" }, "udsMigrantWorkerStatusId": { "type": "string" }, "udsLanguageBarrierId": { "type": "string" }, "udsPrimaryMedicalCoverageId": { "type": "string" }, "udsPublicHousingPrimaryCareId": { "type": "string" }, "udsSchoolBasedHealthCenterId": { "type": "string" }, "udsTribalAffiliationId": { "type": "string" }, "udsBloodQuantumId": { "type": "string" }, "udsVeteranStatus": { "type": "string" }, "isSelfPayer": { "type": "string" }, "udsHasConsentToTreat": { "type": "string" }, "udsConsentToTreatDate": { "type": "string" }, "udsIhsEligibilityStatusId": { "type": "string" }, "udsTribalClassId": { "type": "string" }, "udsDecendancyId": { "type": "string" }, "communityCodeId": { "type": "string" }, "currentGender": { "type": "string" }, "previousFirstName": { "type": "string" }, "sexualOrientation": { "type": "string" }, "preferredPronoun": { "type": "string" }, "patientStatusId": { "type": "string" }, "patientStatusChangeReasonId": { "type": "string" }, "userDefinedDemographic1Id": { "type": "string" }, "userDefinedDemographic2Id": { "type": "string" }, "userDefinedDemographic3Id": { "type": "string" }, "userDefinedDemographic4Id": { "type": "string" }, "userDefinedDemographic5Id": { "type": "string" }, "userDefinedDemographic6Id": { "type": "string" }, "userDefinedDemographic7Id": { "type": "string" }, "userDefinedDemographic8Id": { "type": "string" }, "userDefinedDemographic9Id": { "type": "string" }, "userDefinedDemographic10Id": { "type": "string" }, "userDefinedDemographic11Id": { "type": "string" }, "userDefinedDemographic12Id": { "type": "string" }, "userDefinedDemographic13Id": { "type": "string" }, "userDefinedDemographic14Id": { "type": "string" }, "isCurrentGenderProtected": { "type": "string" }, "isGenderIdentityProtected": { "type": "string" }, "isPreferredPronounProtected": { "type": "string" }, "isSexualOrientationProtected": { "type": "string" }, "otherIdNumber": { "type": "string" }, "priorLastName": { "type": "string" }, "externalId": { "type": "string" }, "primaryDentalProviderId": { "type": "string" }, "primaryDentalProviderName": { "type": "string" }, "nickname": { "type": "string" }, "showContactInfoOnAlert": { "type": "string" }, "mothersMaidenName": { "type": "string" }, "hasEmail": { "type": "string" }, "hasPhoneNumber": { "type": "string" }, "usesPortal": { "type": "string" }, "usesSms": { "type": "string" }, "hasVoice": { "type": "string" }, "isOptOut": { "type": "string" }, "isHomePhoneNotApplicable": { "type": "string" }, "isCellPhoneNotApplicable": { "type": "string" }, "isAlternatePhoneNotApplicable": { "type": "string" }, "isDayPhoneNotApplicable": { "type": "string" }, "isSecondaryHomePhoneNotApplicable": { "type": "string" }, "isInternationalPhoneNotApplicable": { "type": "string" }, "isEmailNotApplicable": { "type": "string" }, "expiredDate": { "type": "string" }, "expiredTime": { "type": "string" }, "expiredTimeTz": { "type": "string" }, "birthMothersLastName": { "type": "string" }, "birthMothersFirstName": { "type": "string" }, "birthMothersMiddleName": { "type": "string" }, "exemptFromPersonMerge": { "type": "string" }, "addressTypeId": { "type": "string" }, "secondaryAddressTypeId": { "type": "string" }, "isEnterpriseChart": { "type": "string" }, "otherReasonSexualOrientation": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "id", "firstName", "lastName", "middleName", "prefix", "prefixId", "suffix", "suffixId", "addressLine1", "addressLine2", "city", "state", "zip", "countryId", "country", "countyId", "county", "secondaryAddressLine1", "secondaryAddressLine2", "secondaryCity", "secondaryState", "secondaryZip", "secondaryCountryId", "secondaryCountry", "secondaryCountyId", "secondaryCounty", "homePhone", "homePhoneComment", "secondaryHomePhone", "secondaryHomePhoneComment", "dayPhone", "dayPhoneExtension", "dayPhoneComment", "alternatePhone", "alternatePhoneDescription", "alternatePhoneExtension", "alternatePhoneComment", "internationalHomePhone", "internationalWorkPhone", "internationalZip", "cellPhone", "cellPhoneComment", "email", "emailAddressComment", "contactSequence", "sex", "dateOfBirth", "age", "socialSecurityNumber", "contactPreferenceId", "contactPreferenceDescription", "primaryCareProviderId", "primaryCareProviderFullName", "primaryCareProviderFirstName", "primaryCareProviderLastName", "primaryCareProviderMiddleInitial", "maritalStatus", "studentStatus", "isExpired", "isSmoker", "isVeteran", "notificationPreferenceSelected", "preferredLanguageId", "preferredLanguage", "religionId", "churchId", "udsHomelessStatusId", "udsMigrantWorkerStatusId", "udsLanguageBarrierId", "udsPrimaryMedicalCoverageId", "udsPublicHousingPrimaryCareId", "udsSchoolBasedHealthCenterId", "udsTribalAffiliationId", "udsBloodQuantumId", "udsVeteranStatus", "isSelfPayer", "udsHasConsentToTreat", "udsConsentToTreatDate", "udsIhsEligibilityStatusId", "udsTribalClassId", "udsDecendancyId", "communityCodeId", "currentGender", "previousFirstName", "sexualOrientation", "preferredPronoun", "patientStatusId", "patientStatusChangeReasonId", "userDefinedDemographic1Id", "userDefinedDemographic2Id", "userDefinedDemographic3Id", "userDefinedDemographic4Id", "userDefinedDemographic5Id", "userDefinedDemographic6Id", "userDefinedDemographic7Id", "userDefinedDemographic8Id", "userDefinedDemographic9Id", "userDefinedDemographic10Id", "userDefinedDemographic11Id", "userDefinedDemographic12Id", "userDefinedDemographic13Id", "userDefinedDemographic14Id", "isCurrentGenderProtected", "isGenderIdentityProtected", "isPreferredPronounProtected", "isSexualOrientationProtected", "otherIdNumber", "priorLastName", "externalId", "primaryDentalProviderId", "primaryDentalProviderName", "nickname", "showContactInfoOnAlert", "mothersMaidenName", "hasEmail", "hasPhoneNumber", "usesPortal", "usesSms", "hasVoice", "isOptOut", "isHomePhoneNotApplicable", "isCellPhoneNotApplicable", "isAlternatePhoneNotApplicable", "isDayPhoneNotApplicable", "isSecondaryHomePhoneNotApplicable", "isInternationalPhoneNotApplicable", "isEmailNotApplicable", "expiredDate", "expiredTime", "expiredTimeTz", "birthMothersLastName", "birthMothersFirstName", "birthMothersMiddleName", "exemptFromPersonMerge", "addressTypeId", "secondaryAddressTypeId", "isEnterpriseChart", "otherReasonSexualOrientation", "_links" ] }, "{{baseUrl}}/persons/:personIdRequest": { "title": "{{baseUrl}}/persons/:personIdRequest", "example": { "OtherIdNumber": "", "LastName": "", "FirstName": "", "MiddleName": "", "PriorLastName": "", "AddressLine1": "", "AddressLine2": "", "City": "", "State": "", "Zip": "", "CountryId": "", "CountyId": "", "HomePhone": "", "HomePhoneComment": "", "IsHomePhoneNotApplicable": "", "AlternatePhone": "", "AlternatePhoneComment": "", "AlternatePhoneDescription": "", "AlternatePhoneExtension": "", "IsAlternatePhoneNotApplicable": "", "SecondaryHomePhone": "", "SecondaryHomePhoneComment": "", "IsSecondaryHomePhoneNotApplicable": "", "EmailAddress": "", "EmailAddressComment": "", "IsEmailNotApplicable": "", "CellPhone": "", "CellPhoneComment": "", "IsCellPhoneNotApplicable": "", "DayPhone": "", "DayPhoneExt": "", "DayPhoneComment": "", "IsDayPhoneNotApplicable": "", "InternationalHomePhone": "", "IsInternationalPhoneNotApplicable": "", "InternationalWorkPhone": "", "InternationalZip": "", "SecondaryAddressLine1": "", "SecondaryAddressLine2": "", "SecondaryCity": "", "SecondaryState": "", "SecondaryZip": "", "SecondaryCountryId": "", "SecondaryCountyId": "", "DateOfBirth": "", "Sex": "", "SocialSecurityNumber": "", "MaritalStatus": "", "IsExpired": "", "ExpiredDate": "", "ExpiredTime": "", "ExpiredTimeTz": "", "IsSmoker": "", "IsVeteran": "", "RaceId": "", "LanguageId": "", "ReligionId": "", "ChurchId": "", "StudentStatus": "", "PrimaryCareProviderId": "", "ExternalId": "", "Nickname": "", "UdsHomelessStatusId": "", "UdsMigrantWorkerStatusId": "", "UdsLanguageBarrierId": "", "UdsPrimaryMedicalCoverageId": "", "ContactSequence": "", "ContactPreferenceId": "", "ShowContactInfoOnAlert": "", "IsEnterpriseChart": "", "UdsPublicHousingPrimaryCareId": "", "UdsSchoolBasedHealthCenterId": "", "IsSelfPayer": "", "UdsTribalAffiliationId": "", "UdsBloodQuantumId": "", "UdsVeteranStatus": "", "UdsHasConsentToTreat": "", "MothersMaidenName": "", "UdsIhsEligibilityStatusId": "", "UdsTribalClassId": "", "UdsDecendancyId": "", "UdsConsentToTreatDate": "", "CommunityCodeId": "", "EthnicityId": "", "PrimaryDentalProviderId": "", "AddressTypeId": "", "SecondaryAddressTypeId": "", "PrefixId": "", "SuffixId": "", "BirthMothersLastName": "", "BirthMothersFirstName": "", "BirthMothersMiddleName": "", "HasEmail": "", "HasPhoneNumber": "", "UsesPortal": "", "UsesSms": "", "HasVoice": "", "IsOptOut": "", "ExemptFromPersonMerge": "", "SexualOrientation": "", "PreferredPronoun": "", "GenderIdentityCode": "", "CurrentGender": "", "PreviousFirstName": "", "OtherReasonSexualOrientation": "", "OtherReasonGenderIdentity": "", "PatientStatusId": "", "PatientStatusChangeReasonId": "", "UserDefinedDemographic1Id": "", "UserDefinedDemographic2Id": "", "UserDefinedDemographic3Id": "", "UserDefinedDemographic4Id": "", "UserDefinedDemographic5Id": "", "UserDefinedDemographic6Id": "", "UserDefinedDemographic7Id": "", "UserDefinedDemographic8Id": "", "UserDefinedDemographic9Id": "", "UserDefinedDemographic10Id": "", "UserDefinedDemographic11Id": "", "UserDefinedDemographic12Id": "", "UserDefinedDemographic13Id": "", "UserDefinedDemographic14Id": "", "IgnoreDuplicatePersons": "" }, "type": "object", "properties": { "OtherIdNumber": { "type": "string" }, "LastName": { "type": "string" }, "FirstName": { "type": "string" }, "MiddleName": { "type": "string" }, "PriorLastName": { "type": "string" }, "AddressLine1": { "type": "string" }, "AddressLine2": { "type": "string" }, "City": { "type": "string" }, "State": { "type": "string" }, "Zip": { "type": "string" }, "CountryId": { "type": "string" }, "CountyId": { "type": "string" }, "HomePhone": { "type": "string" }, "HomePhoneComment": { "type": "string" }, "IsHomePhoneNotApplicable": { "type": "string" }, "AlternatePhone": { "type": "string" }, "AlternatePhoneComment": { "type": "string" }, "AlternatePhoneDescription": { "type": "string" }, "AlternatePhoneExtension": { "type": "string" }, "IsAlternatePhoneNotApplicable": { "type": "string" }, "SecondaryHomePhone": { "type": "string" }, "SecondaryHomePhoneComment": { "type": "string" }, "IsSecondaryHomePhoneNotApplicable": { "type": "string" }, "EmailAddress": { "type": "string" }, "EmailAddressComment": { "type": "string" }, "IsEmailNotApplicable": { "type": "string" }, "CellPhone": { "type": "string" }, "CellPhoneComment": { "type": "string" }, "IsCellPhoneNotApplicable": { "type": "string" }, "DayPhone": { "type": "string" }, "DayPhoneExt": { "type": "string" }, "DayPhoneComment": { "type": "string" }, "IsDayPhoneNotApplicable": { "type": "string" }, "InternationalHomePhone": { "type": "string" }, "IsInternationalPhoneNotApplicable": { "type": "string" }, "InternationalWorkPhone": { "type": "string" }, "InternationalZip": { "type": "string" }, "SecondaryAddressLine1": { "type": "string" }, "SecondaryAddressLine2": { "type": "string" }, "SecondaryCity": { "type": "string" }, "SecondaryState": { "type": "string" }, "SecondaryZip": { "type": "string" }, "SecondaryCountryId": { "type": "string" }, "SecondaryCountyId": { "type": "string" }, "DateOfBirth": { "type": "string" }, "Sex": { "type": "string" }, "SocialSecurityNumber": { "type": "string" }, "MaritalStatus": { "type": "string" }, "IsExpired": { "type": "string" }, "ExpiredDate": { "type": "string" }, "ExpiredTime": { "type": "string" }, "ExpiredTimeTz": { "type": "string" }, "IsSmoker": { "type": "string" }, "IsVeteran": { "type": "string" }, "RaceId": { "type": "string" }, "LanguageId": { "type": "string" }, "ReligionId": { "type": "string" }, "ChurchId": { "type": "string" }, "StudentStatus": { "type": "string" }, "PrimaryCareProviderId": { "type": "string" }, "ExternalId": { "type": "string" }, "Nickname": { "type": "string" }, "UdsHomelessStatusId": { "type": "string" }, "UdsMigrantWorkerStatusId": { "type": "string" }, "UdsLanguageBarrierId": { "type": "string" }, "UdsPrimaryMedicalCoverageId": { "type": "string" }, "ContactSequence": { "type": "string" }, "ContactPreferenceId": { "type": "string" }, "ShowContactInfoOnAlert": { "type": "string" }, "IsEnterpriseChart": { "type": "string" }, "UdsPublicHousingPrimaryCareId": { "type": "string" }, "UdsSchoolBasedHealthCenterId": { "type": "string" }, "IsSelfPayer": { "type": "string" }, "UdsTribalAffiliationId": { "type": "string" }, "UdsBloodQuantumId": { "type": "string" }, "UdsVeteranStatus": { "type": "string" }, "UdsHasConsentToTreat": { "type": "string" }, "MothersMaidenName": { "type": "string" }, "UdsIhsEligibilityStatusId": { "type": "string" }, "UdsTribalClassId": { "type": "string" }, "UdsDecendancyId": { "type": "string" }, "UdsConsentToTreatDate": { "type": "string" }, "CommunityCodeId": { "type": "string" }, "EthnicityId": { "type": "string" }, "PrimaryDentalProviderId": { "type": "string" }, "AddressTypeId": { "type": "string" }, "SecondaryAddressTypeId": { "type": "string" }, "PrefixId": { "type": "string" }, "SuffixId": { "type": "string" }, "BirthMothersLastName": { "type": "string" }, "BirthMothersFirstName": { "type": "string" }, "BirthMothersMiddleName": { "type": "string" }, "HasEmail": { "type": "string" }, "HasPhoneNumber": { "type": "string" }, "UsesPortal": { "type": "string" }, "UsesSms": { "type": "string" }, "HasVoice": { "type": "string" }, "IsOptOut": { "type": "string" }, "ExemptFromPersonMerge": { "type": "string" }, "SexualOrientation": { "type": "string" }, "PreferredPronoun": { "type": "string" }, "GenderIdentityCode": { "type": "string" }, "CurrentGender": { "type": "string" }, "PreviousFirstName": { "type": "string" }, "OtherReasonSexualOrientation": { "type": "string" }, "OtherReasonGenderIdentity": { "type": "string" }, "PatientStatusId": { "type": "string" }, "PatientStatusChangeReasonId": { "type": "string" }, "UserDefinedDemographic1Id": { "type": "string" }, "UserDefinedDemographic2Id": { "type": "string" }, "UserDefinedDemographic3Id": { "type": "string" }, "UserDefinedDemographic4Id": { "type": "string" }, "UserDefinedDemographic5Id": { "type": "string" }, "UserDefinedDemographic6Id": { "type": "string" }, "UserDefinedDemographic7Id": { "type": "string" }, "UserDefinedDemographic8Id": { "type": "string" }, "UserDefinedDemographic9Id": { "type": "string" }, "UserDefinedDemographic10Id": { "type": "string" }, "UserDefinedDemographic11Id": { "type": "string" }, "UserDefinedDemographic12Id": { "type": "string" }, "UserDefinedDemographic13Id": { "type": "string" }, "UserDefinedDemographic14Id": { "type": "string" }, "IgnoreDuplicatePersons": { "type": "string" } }, "required": [ "OtherIdNumber", "LastName", "FirstName", "MiddleName", "PriorLastName", "AddressLine1", "AddressLine2", "City", "State", "Zip", "CountryId", "CountyId", "HomePhone", "HomePhoneComment", "IsHomePhoneNotApplicable", "AlternatePhone", "AlternatePhoneComment", "AlternatePhoneDescription", "AlternatePhoneExtension", "IsAlternatePhoneNotApplicable", "SecondaryHomePhone", "SecondaryHomePhoneComment", "IsSecondaryHomePhoneNotApplicable", "EmailAddress", "EmailAddressComment", "IsEmailNotApplicable", "CellPhone", "CellPhoneComment", "IsCellPhoneNotApplicable", "DayPhone", "DayPhoneExt", "DayPhoneComment", "IsDayPhoneNotApplicable", "InternationalHomePhone", "IsInternationalPhoneNotApplicable", "InternationalWorkPhone", "InternationalZip", "SecondaryAddressLine1", "SecondaryAddressLine2", "SecondaryCity", "SecondaryState", "SecondaryZip", "SecondaryCountryId", "SecondaryCountyId", "DateOfBirth", "Sex", "SocialSecurityNumber", "MaritalStatus", "IsExpired", "ExpiredDate", "ExpiredTime", "ExpiredTimeTz", "IsSmoker", "IsVeteran", "RaceId", "LanguageId", "ReligionId", "ChurchId", "StudentStatus", "PrimaryCareProviderId", "ExternalId", "Nickname", "UdsHomelessStatusId", "UdsMigrantWorkerStatusId", "UdsLanguageBarrierId", "UdsPrimaryMedicalCoverageId", "ContactSequence", "ContactPreferenceId", "ShowContactInfoOnAlert", "IsEnterpriseChart", "UdsPublicHousingPrimaryCareId", "UdsSchoolBasedHealthCenterId", "IsSelfPayer", "UdsTribalAffiliationId", "UdsBloodQuantumId", "UdsVeteranStatus", "UdsHasConsentToTreat", "MothersMaidenName", "UdsIhsEligibilityStatusId", "UdsTribalClassId", "UdsDecendancyId", "UdsConsentToTreatDate", "CommunityCodeId", "EthnicityId", "PrimaryDentalProviderId", "AddressTypeId", "SecondaryAddressTypeId", "PrefixId", "SuffixId", "BirthMothersLastName", "BirthMothersFirstName", "BirthMothersMiddleName", "HasEmail", "HasPhoneNumber", "UsesPortal", "UsesSms", "HasVoice", "IsOptOut", "ExemptFromPersonMerge", "SexualOrientation", "PreferredPronoun", "GenderIdentityCode", "CurrentGender", "PreviousFirstName", "OtherReasonSexualOrientation", "OtherReasonGenderIdentity", "PatientStatusId", "PatientStatusChangeReasonId", "UserDefinedDemographic1Id", "UserDefinedDemographic2Id", "UserDefinedDemographic3Id", "UserDefinedDemographic4Id", "UserDefinedDemographic5Id", "UserDefinedDemographic6Id", "UserDefinedDemographic7Id", "UserDefinedDemographic8Id", "UserDefinedDemographic9Id", "UserDefinedDemographic10Id", "UserDefinedDemographic11Id", "UserDefinedDemographic12Id", "UserDefinedDemographic13Id", "UserDefinedDemographic14Id", "IgnoreDuplicatePersons" ] }, "{{baseUrl}}/personsRequest": { "title": "{{baseUrl}}/personsRequest", "example": { "OtherIdNumber": "", "LastName": "", "FirstName": "", "MiddleName": "", "PriorLastName": "", "AddressLine1": "", "AddressLine2": "", "City": "", "State": "", "Zip": "", "CountryId": "", "CountyId": "", "HomePhone": "", "HomePhoneComment": "", "IsHomePhoneNotApplicable": "", "AlternatePhone": "", "AlternatePhoneComment": "", "AlternatePhoneDescription": "", "AlternatePhoneExtension": "", "IsAlternatePhoneNotApplicable": "", "SecondaryHomePhone": "", "SecondaryHomePhoneComment": "", "IsSecondaryHomePhoneNotApplicable": "", "EmailAddress": "", "EmailAddressComment": "", "IsEmailNotApplicable": "", "CellPhone": "", "CellPhoneComment": "", "IsCellPhoneNotApplicable": "", "DayPhone": "", "DayPhoneExt": "", "DayPhoneComment": "", "IsDayPhoneNotApplicable": "", "InternationalHomePhone": "", "IsInternationalPhoneNotApplicable": "", "InternationalWorkPhone": "", "InternationalZip": "", "SecondaryAddressLine1": "", "SecondaryAddressLine2": "", "SecondaryCity": "", "SecondaryState": "", "SecondaryZip": "", "SecondaryCountryId": "", "SecondaryCountyId": "", "DateOfBirth": "", "Sex": "", "SocialSecurityNumber": "", "MaritalStatus": "", "IsExpired": "", "ExpiredDate": "", "ExpiredTime": "", "ExpiredTimeTz": "", "IsSmoker": "", "IsVeteran": "", "RaceId": "", "LanguageId": "", "ReligionId": "", "ChurchId": "", "StudentStatus": "", "PrimaryCareProviderId": "", "ExternalId": "", "Nickname": "", "UdsHomelessStatusId": "", "UdsMigrantWorkerStatusId": "", "UdsLanguageBarrierId": "", "UdsPrimaryMedicalCoverageId": "", "ContactSequence": "", "ContactPreferenceId": "", "ShowContactInfoOnAlert": "", "IsEnterpriseChart": "", "UdsPublicHousingPrimaryCareId": "", "UdsSchoolBasedHealthCenterId": "", "IsSelfPayer": "", "UdsTribalAffiliationId": "", "UdsBloodQuantumId": "", "UdsVeteranStatus": "", "UdsHasConsentToTreat": "", "MothersMaidenName": "", "UdsIhsEligibilityStatusId": "", "UdsTribalClassId": "", "UdsDecendancyId": "", "UdsConsentToTreatDate": "", "CommunityCodeId": "", "EthnicityId": "", "PrimaryDentalProviderId": "", "AddressTypeId": "", "SecondaryAddressTypeId": "", "PrefixId": "", "SuffixId": "", "BirthMothersLastName": "", "BirthMothersFirstName": "", "BirthMothersMiddleName": "", "HasEmail": "", "HasPhoneNumber": "", "UsesPortal": "", "UsesSms": "", "HasVoice": "", "IsOptOut": "", "ExemptFromPersonMerge": "", "SexualOrientation": "", "PreferredPronoun": "", "GenderIdentityCode": "", "CurrentGender": "", "PreviousFirstName": "", "OtherReasonSexualOrientation": "", "OtherReasonGenderIdentity": "", "PatientStatusId": "", "PatientStatusChangeReasonId": "", "UserDefinedDemographic1Id": "", "UserDefinedDemographic2Id": "", "UserDefinedDemographic3Id": "", "UserDefinedDemographic4Id": "", "UserDefinedDemographic5Id": "", "UserDefinedDemographic6Id": "", "UserDefinedDemographic7Id": "", "UserDefinedDemographic8Id": "", "UserDefinedDemographic9Id": "", "UserDefinedDemographic10Id": "", "UserDefinedDemographic11Id": "", "UserDefinedDemographic12Id": "", "UserDefinedDemographic13Id": "", "UserDefinedDemographic14Id": "", "IgnoreDuplicatePersons": "" }, "type": "object", "properties": { "OtherIdNumber": { "type": "string" }, "LastName": { "type": "string" }, "FirstName": { "type": "string" }, "MiddleName": { "type": "string" }, "PriorLastName": { "type": "string" }, "AddressLine1": { "type": "string" }, "AddressLine2": { "type": "string" }, "City": { "type": "string" }, "State": { "type": "string" }, "Zip": { "type": "string" }, "CountryId": { "type": "string" }, "CountyId": { "type": "string" }, "HomePhone": { "type": "string" }, "HomePhoneComment": { "type": "string" }, "IsHomePhoneNotApplicable": { "type": "string" }, "AlternatePhone": { "type": "string" }, "AlternatePhoneComment": { "type": "string" }, "AlternatePhoneDescription": { "type": "string" }, "AlternatePhoneExtension": { "type": "string" }, "IsAlternatePhoneNotApplicable": { "type": "string" }, "SecondaryHomePhone": { "type": "string" }, "SecondaryHomePhoneComment": { "type": "string" }, "IsSecondaryHomePhoneNotApplicable": { "type": "string" }, "EmailAddress": { "type": "string" }, "EmailAddressComment": { "type": "string" }, "IsEmailNotApplicable": { "type": "string" }, "CellPhone": { "type": "string" }, "CellPhoneComment": { "type": "string" }, "IsCellPhoneNotApplicable": { "type": "string" }, "DayPhone": { "type": "string" }, "DayPhoneExt": { "type": "string" }, "DayPhoneComment": { "type": "string" }, "IsDayPhoneNotApplicable": { "type": "string" }, "InternationalHomePhone": { "type": "string" }, "IsInternationalPhoneNotApplicable": { "type": "string" }, "InternationalWorkPhone": { "type": "string" }, "InternationalZip": { "type": "string" }, "SecondaryAddressLine1": { "type": "string" }, "SecondaryAddressLine2": { "type": "string" }, "SecondaryCity": { "type": "string" }, "SecondaryState": { "type": "string" }, "SecondaryZip": { "type": "string" }, "SecondaryCountryId": { "type": "string" }, "SecondaryCountyId": { "type": "string" }, "DateOfBirth": { "type": "string" }, "Sex": { "type": "string" }, "SocialSecurityNumber": { "type": "string" }, "MaritalStatus": { "type": "string" }, "IsExpired": { "type": "string" }, "ExpiredDate": { "type": "string" }, "ExpiredTime": { "type": "string" }, "ExpiredTimeTz": { "type": "string" }, "IsSmoker": { "type": "string" }, "IsVeteran": { "type": "string" }, "RaceId": { "type": "string" }, "LanguageId": { "type": "string" }, "ReligionId": { "type": "string" }, "ChurchId": { "type": "string" }, "StudentStatus": { "type": "string" }, "PrimaryCareProviderId": { "type": "string" }, "ExternalId": { "type": "string" }, "Nickname": { "type": "string" }, "UdsHomelessStatusId": { "type": "string" }, "UdsMigrantWorkerStatusId": { "type": "string" }, "UdsLanguageBarrierId": { "type": "string" }, "UdsPrimaryMedicalCoverageId": { "type": "string" }, "ContactSequence": { "type": "string" }, "ContactPreferenceId": { "type": "string" }, "ShowContactInfoOnAlert": { "type": "string" }, "IsEnterpriseChart": { "type": "string" }, "UdsPublicHousingPrimaryCareId": { "type": "string" }, "UdsSchoolBasedHealthCenterId": { "type": "string" }, "IsSelfPayer": { "type": "string" }, "UdsTribalAffiliationId": { "type": "string" }, "UdsBloodQuantumId": { "type": "string" }, "UdsVeteranStatus": { "type": "string" }, "UdsHasConsentToTreat": { "type": "string" }, "MothersMaidenName": { "type": "string" }, "UdsIhsEligibilityStatusId": { "type": "string" }, "UdsTribalClassId": { "type": "string" }, "UdsDecendancyId": { "type": "string" }, "UdsConsentToTreatDate": { "type": "string" }, "CommunityCodeId": { "type": "string" }, "EthnicityId": { "type": "string" }, "PrimaryDentalProviderId": { "type": "string" }, "AddressTypeId": { "type": "string" }, "SecondaryAddressTypeId": { "type": "string" }, "PrefixId": { "type": "string" }, "SuffixId": { "type": "string" }, "BirthMothersLastName": { "type": "string" }, "BirthMothersFirstName": { "type": "string" }, "BirthMothersMiddleName": { "type": "string" }, "HasEmail": { "type": "string" }, "HasPhoneNumber": { "type": "string" }, "UsesPortal": { "type": "string" }, "UsesSms": { "type": "string" }, "HasVoice": { "type": "string" }, "IsOptOut": { "type": "string" }, "ExemptFromPersonMerge": { "type": "string" }, "SexualOrientation": { "type": "string" }, "PreferredPronoun": { "type": "string" }, "GenderIdentityCode": { "type": "string" }, "CurrentGender": { "type": "string" }, "PreviousFirstName": { "type": "string" }, "OtherReasonSexualOrientation": { "type": "string" }, "OtherReasonGenderIdentity": { "type": "string" }, "PatientStatusId": { "type": "string" }, "PatientStatusChangeReasonId": { "type": "string" }, "UserDefinedDemographic1Id": { "type": "string" }, "UserDefinedDemographic2Id": { "type": "string" }, "UserDefinedDemographic3Id": { "type": "string" }, "UserDefinedDemographic4Id": { "type": "string" }, "UserDefinedDemographic5Id": { "type": "string" }, "UserDefinedDemographic6Id": { "type": "string" }, "UserDefinedDemographic7Id": { "type": "string" }, "UserDefinedDemographic8Id": { "type": "string" }, "UserDefinedDemographic9Id": { "type": "string" }, "UserDefinedDemographic10Id": { "type": "string" }, "UserDefinedDemographic11Id": { "type": "string" }, "UserDefinedDemographic12Id": { "type": "string" }, "UserDefinedDemographic13Id": { "type": "string" }, "UserDefinedDemographic14Id": { "type": "string" }, "IgnoreDuplicatePersons": { "type": "string" } }, "required": [ "OtherIdNumber", "LastName", "FirstName", "MiddleName", "PriorLastName", "AddressLine1", "AddressLine2", "City", "State", "Zip", "CountryId", "CountyId", "HomePhone", "HomePhoneComment", "IsHomePhoneNotApplicable", "AlternatePhone", "AlternatePhoneComment", "AlternatePhoneDescription", "AlternatePhoneExtension", "IsAlternatePhoneNotApplicable", "SecondaryHomePhone", "SecondaryHomePhoneComment", "IsSecondaryHomePhoneNotApplicable", "EmailAddress", "EmailAddressComment", "IsEmailNotApplicable", "CellPhone", "CellPhoneComment", "IsCellPhoneNotApplicable", "DayPhone", "DayPhoneExt", "DayPhoneComment", "IsDayPhoneNotApplicable", "InternationalHomePhone", "IsInternationalPhoneNotApplicable", "InternationalWorkPhone", "InternationalZip", "SecondaryAddressLine1", "SecondaryAddressLine2", "SecondaryCity", "SecondaryState", "SecondaryZip", "SecondaryCountryId", "SecondaryCountyId", "DateOfBirth", "Sex", "SocialSecurityNumber", "MaritalStatus", "IsExpired", "ExpiredDate", "ExpiredTime", "ExpiredTimeTz", "IsSmoker", "IsVeteran", "RaceId", "LanguageId", "ReligionId", "ChurchId", "StudentStatus", "PrimaryCareProviderId", "ExternalId", "Nickname", "UdsHomelessStatusId", "UdsMigrantWorkerStatusId", "UdsLanguageBarrierId", "UdsPrimaryMedicalCoverageId", "ContactSequence", "ContactPreferenceId", "ShowContactInfoOnAlert", "IsEnterpriseChart", "UdsPublicHousingPrimaryCareId", "UdsSchoolBasedHealthCenterId", "IsSelfPayer", "UdsTribalAffiliationId", "UdsBloodQuantumId", "UdsVeteranStatus", "UdsHasConsentToTreat", "MothersMaidenName", "UdsIhsEligibilityStatusId", "UdsTribalClassId", "UdsDecendancyId", "UdsConsentToTreatDate", "CommunityCodeId", "EthnicityId", "PrimaryDentalProviderId", "AddressTypeId", "SecondaryAddressTypeId", "PrefixId", "SuffixId", "BirthMothersLastName", "BirthMothersFirstName", "BirthMothersMiddleName", "HasEmail", "HasPhoneNumber", "UsesPortal", "UsesSms", "HasVoice", "IsOptOut", "ExemptFromPersonMerge", "SexualOrientation", "PreferredPronoun", "GenderIdentityCode", "CurrentGender", "PreviousFirstName", "OtherReasonSexualOrientation", "OtherReasonGenderIdentity", "PatientStatusId", "PatientStatusChangeReasonId", "UserDefinedDemographic1Id", "UserDefinedDemographic2Id", "UserDefinedDemographic3Id", "UserDefinedDemographic4Id", "UserDefinedDemographic5Id", "UserDefinedDemographic6Id", "UserDefinedDemographic7Id", "UserDefinedDemographic8Id", "UserDefinedDemographic9Id", "UserDefinedDemographic10Id", "UserDefinedDemographic11Id", "UserDefinedDemographic12Id", "UserDefinedDemographic13Id", "UserDefinedDemographic14Id", "IgnoreDuplicatePersons" ] }, "OK81": { "title": "OK81", "example": { "personId": "", "id": "", "description": "", "order": "", "categoryId": "", "categoryName": "", "cdcEthnicityCode": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "personId": { "type": "string" }, "id": { "type": "string" }, "description": { "type": "string" }, "order": { "type": "string" }, "categoryId": { "type": "string" }, "categoryName": { "type": "string" }, "cdcEthnicityCode": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "personId", "id", "description", "order", "categoryId", "categoryName", "cdcEthnicityCode", "_links" ] }, "OK83": { "title": "OK83", "example": { "personId": "", "id": "", "description": "", "order": "", "categoryId": "", "categoryName": "", "cdcRaceCode": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "personId": { "type": "string" }, "id": { "type": "string" }, "description": { "type": "string" }, "order": { "type": "string" }, "categoryId": { "type": "string" }, "categoryName": { "type": "string" }, "cdcRaceCode": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "personId", "id", "description", "order", "categoryId", "categoryName", "cdcRaceCode", "_links" ] }, "OK84": { "title": "OK84", "example": { "id": "", "firstName": "", "lastName": "", "middleName": "", "nickname": "", "addressLine1": "", "addressLine2": "", "city": "", "state": "", "zip": "", "country": "", "homePhone": "", "dateOfBirth": "", "sex": "", "currentGender": "", "socialSecurityNumber": "", "personNumber": "", "medicalRecordNumber": "", "otherIdNumber": "", "isEnterpriseChart": "", "isPatient": "", "canAddToInclusionList": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "id": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "middleName": { "type": "string" }, "nickname": { "type": "string" }, "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "country": { "type": "string" }, "homePhone": { "type": "string" }, "dateOfBirth": { "type": "string" }, "sex": { "type": "string" }, "currentGender": { "type": "string" }, "socialSecurityNumber": { "type": "string" }, "personNumber": { "type": "string" }, "medicalRecordNumber": { "type": "string" }, "otherIdNumber": { "type": "string" }, "isEnterpriseChart": { "type": "string" }, "isPatient": { "type": "string" }, "canAddToInclusionList": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "id", "firstName", "lastName", "middleName", "nickname", "addressLine1", "addressLine2", "city", "state", "zip", "country", "homePhone", "dateOfBirth", "sex", "currentGender", "socialSecurityNumber", "personNumber", "medicalRecordNumber", "otherIdNumber", "isEnterpriseChart", "isPatient", "canAddToInclusionList", "_links" ] }, "OK86": { "title": "OK86", "example": { "id": "", "personId": "", "description": "", "fullySpecifiedName": "", "isChronic": "", "hasSecondaryCondition": "", "problemStatusId": "", "problemStatus": "", "recentNoteId": "", "lastAddressedDate": "", "onsetDate": "", "resolvedDate": "", "resolvedReason": "", "conceptId": "", "isComorbid": "", "isDeleted": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "id": { "type": "string" }, "personId": { "type": "string" }, "description": { "type": "string" }, "fullySpecifiedName": { "type": "string" }, "isChronic": { "type": "string" }, "hasSecondaryCondition": { "type": "string" }, "problemStatusId": { "type": "string" }, "problemStatus": { "type": "string" }, "recentNoteId": { "type": "string" }, "lastAddressedDate": { "type": "string" }, "onsetDate": { "type": "string" }, "resolvedDate": { "type": "string" }, "resolvedReason": { "type": "string" }, "conceptId": { "type": "string" }, "isComorbid": { "type": "string" }, "isDeleted": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "id", "personId", "description", "fullySpecifiedName", "isChronic", "hasSecondaryCondition", "problemStatusId", "problemStatus", "recentNoteId", "lastAddressedDate", "onsetDate", "resolvedDate", "resolvedReason", "conceptId", "isComorbid", "isDeleted", "_links" ] }, "{{baseUrl}}/persons/:personId/chart/problemsRequest": { "title": "{{baseUrl}}/persons/:personId/chart/problemsRequest", "example": { "conceptId": "", "description": "", "side": "", "site": "", "onsetDate": "", "lastAddressedDate": "", "resolvedDate": "", "resolvedReason": "", "problemStatus": "", "clinicalStatusId": "", "isChronic": "", "hasSecondaryCondition": "", "locationId": "", "providerId": "", "isRecordedElsewhere": "", "recordedElsewhereSource": "", "responsibleProviderId": "", "isComorbid": "", "interactions": [ { "personId": "", "isRequired": "", "acknowledged": "", "severityLevel": "", "description": "", "entityName": "", "eventType": "", "sourceId": "", "cause": "", "warningDetail": "", "warningType": "", "warning": "", "causeText": "", "overrideText": "", "durAuditKey": "", "isSuppressed": "", "isRecordedElseWhere": "", "practiceId": "", "display": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "personId": "", "isRequired": "", "acknowledged": "", "severityLevel": "", "description": "", "entityName": "", "eventType": "", "sourceId": "", "cause": "", "warningDetail": "", "warningType": "", "warning": "", "causeText": "", "overrideText": "", "durAuditKey": "", "isSuppressed": "", "isRecordedElseWhere": "", "practiceId": "", "display": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ] }, "type": "object", "properties": { "conceptId": { "type": "string" }, "description": { "type": "string" }, "side": { "type": "string" }, "site": { "type": "string" }, "onsetDate": { "type": "string" }, "lastAddressedDate": { "type": "string" }, "resolvedDate": { "type": "string" }, "resolvedReason": { "type": "string" }, "problemStatus": { "type": "string" }, "clinicalStatusId": { "type": "string" }, "isChronic": { "type": "string" }, "hasSecondaryCondition": { "type": "string" }, "locationId": { "type": "string" }, "providerId": { "type": "string" }, "isRecordedElsewhere": { "type": "string" }, "recordedElsewhereSource": { "type": "string" }, "responsibleProviderId": { "type": "string" }, "isComorbid": { "type": "string" }, "interactions": { "type": "array", "items": { "$ref": "#/definitions/Interaction" } } }, "required": [ "conceptId", "description", "side", "site", "onsetDate", "lastAddressedDate", "resolvedDate", "resolvedReason", "problemStatus", "clinicalStatusId", "isChronic", "hasSecondaryCondition", "locationId", "providerId", "isRecordedElsewhere", "recordedElsewhereSource", "responsibleProviderId", "isComorbid", "interactions" ] }, "Interaction": { "title": "Interaction", "example": { "personId": "", "isRequired": "", "acknowledged": "", "severityLevel": "", "description": "", "entityName": "", "eventType": "", "sourceId": "", "cause": "", "warningDetail": "", "warningType": "", "warning": "", "causeText": "", "overrideText": "", "durAuditKey": "", "isSuppressed": "", "isRecordedElseWhere": "", "practiceId": "", "display": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "personId": { "type": "string" }, "isRequired": { "type": "string" }, "acknowledged": { "type": "string" }, "severityLevel": { "type": "string" }, "description": { "type": "string" }, "entityName": { "type": "string" }, "eventType": { "type": "string" }, "sourceId": { "type": "string" }, "cause": { "type": "string" }, "warningDetail": { "type": "string" }, "warningType": { "type": "string" }, "warning": { "type": "string" }, "causeText": { "type": "string" }, "overrideText": { "type": "string" }, "durAuditKey": { "type": "string" }, "isSuppressed": { "type": "string" }, "isRecordedElseWhere": { "type": "string" }, "practiceId": { "type": "string" }, "display": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "personId", "isRequired", "acknowledged", "severityLevel", "description", "entityName", "eventType", "sourceId", "cause", "warningDetail", "warningType", "warning", "causeText", "overrideText", "durAuditKey", "isSuppressed", "isRecordedElseWhere", "practiceId", "display", "_links" ] }, "OK87": { "title": "OK87", "example": { "id": "", "enterpriseId": "", "practiceId": "", "personId": "", "description": "", "fullySpecifiedName": "", "conceptId": "", "sideId": "", "site": "", "onsetDate": "", "lastAddressedDate": "", "resolvedDate": "", "resolvedReason": "", "resolvedBy": "", "problemStatusId": "", "problemStatus": "", "recentNoteId": "", "clinicalStatusId": "", "isChronic": "", "hasSecondaryCondition": "", "isDeleted": "", "locationId": "", "providerId": "", "isRecordedElsewhere": "", "recordedElsewhereSource": "", "responsibleProviderId": "", "isComorbid": "", "createdBy": "", "createTimestamp": "", "modifiedBy": "", "modifyTimestamp": "", "createTimestampTimezone": "", "modifyTimestampTimezone": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "id": { "type": "string" }, "enterpriseId": { "type": "string" }, "practiceId": { "type": "string" }, "personId": { "type": "string" }, "description": { "type": "string" }, "fullySpecifiedName": { "type": "string" }, "conceptId": { "type": "string" }, "sideId": { "type": "string" }, "site": { "type": "string" }, "onsetDate": { "type": "string" }, "lastAddressedDate": { "type": "string" }, "resolvedDate": { "type": "string" }, "resolvedReason": { "type": "string" }, "resolvedBy": { "type": "string" }, "problemStatusId": { "type": "string" }, "problemStatus": { "type": "string" }, "recentNoteId": { "type": "string" }, "clinicalStatusId": { "type": "string" }, "isChronic": { "type": "string" }, "hasSecondaryCondition": { "type": "string" }, "isDeleted": { "type": "string" }, "locationId": { "type": "string" }, "providerId": { "type": "string" }, "isRecordedElsewhere": { "type": "string" }, "recordedElsewhereSource": { "type": "string" }, "responsibleProviderId": { "type": "string" }, "isComorbid": { "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", "enterpriseId", "practiceId", "personId", "description", "fullySpecifiedName", "conceptId", "sideId", "site", "onsetDate", "lastAddressedDate", "resolvedDate", "resolvedReason", "resolvedBy", "problemStatusId", "problemStatus", "recentNoteId", "clinicalStatusId", "isChronic", "hasSecondaryCondition", "isDeleted", "locationId", "providerId", "isRecordedElsewhere", "recordedElsewhereSource", "responsibleProviderId", "isComorbid", "createdBy", "createTimestamp", "modifiedBy", "modifyTimestamp", "createTimestampTimezone", "modifyTimestampTimezone", "_links" ] }, "{{baseUrl}}/persons/:personId/chart/problems/:problemIdRequest": { "title": "{{baseUrl}}/persons/:personId/chart/problems/:problemIdRequest", "example": { "conceptId": "", "description": "", "side": "", "site": "", "onsetDate": "", "lastAddressedDate": "", "resolvedDate": "", "resolvedReason": "", "problemStatus": "", "clinicalStatusId": "", "isChronic": "", "hasSecondaryCondition": "", "locationId": "", "providerId": "", "isRecordedElsewhere": "", "recordedElsewhereSource": "", "responsibleProviderId": "", "isComorbid": "", "interactions": [ { "personId": "", "isRequired": "", "acknowledged": "", "severityLevel": "", "description": "", "entityName": "", "eventType": "", "sourceId": "", "cause": "", "warningDetail": "", "warningType": "", "warning": "", "causeText": "", "overrideText": "", "durAuditKey": "", "isSuppressed": "", "isRecordedElseWhere": "", "practiceId": "", "display": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "personId": "", "isRequired": "", "acknowledged": "", "severityLevel": "", "description": "", "entityName": "", "eventType": "", "sourceId": "", "cause": "", "warningDetail": "", "warningType": "", "warning": "", "causeText": "", "overrideText": "", "durAuditKey": "", "isSuppressed": "", "isRecordedElseWhere": "", "practiceId": "", "display": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ] }, "type": "object", "properties": { "conceptId": { "type": "string" }, "description": { "type": "string" }, "side": { "type": "string" }, "site": { "type": "string" }, "onsetDate": { "type": "string" }, "lastAddressedDate": { "type": "string" }, "resolvedDate": { "type": "string" }, "resolvedReason": { "type": "string" }, "problemStatus": { "type": "string" }, "clinicalStatusId": { "type": "string" }, "isChronic": { "type": "string" }, "hasSecondaryCondition": { "type": "string" }, "locationId": { "type": "string" }, "providerId": { "type": "string" }, "isRecordedElsewhere": { "type": "string" }, "recordedElsewhereSource": { "type": "string" }, "responsibleProviderId": { "type": "string" }, "isComorbid": { "type": "string" }, "interactions": { "type": "array", "items": { "$ref": "#/definitions/Interaction" } } }, "required": [ "conceptId", "description", "side", "site", "onsetDate", "lastAddressedDate", "resolvedDate", "resolvedReason", "problemStatus", "clinicalStatusId", "isChronic", "hasSecondaryCondition", "locationId", "providerId", "isRecordedElsewhere", "recordedElsewhereSource", "responsibleProviderId", "isComorbid", "interactions" ] }, "OK89": { "title": "OK89", "example": { "Items": [ { "id": "", "problemId": "", "personId": "", "note": "", "createdBy": "", "createTimestamp": "", "modifiedBy": "", "modifyTimestamp": "", "isDeleted": "", "createTimestampTimezone": "", "modifyTimestampTimezone": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "id": "", "problemId": "", "personId": "", "note": "", "createdBy": "", "createTimestamp": "", "modifiedBy": "", "modifyTimestamp": "", "isDeleted": "", "createTimestampTimezone": "", "modifyTimestampTimezone": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" }, "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/Item36" } }, "NextPageLink": { "type": "string" }, "Count": { "type": "string" } }, "required": [ "Items", "NextPageLink", "Count" ] }, "Item36": { "title": "Item36", "example": { "id": "", "problemId": "", "personId": "", "note": "", "createdBy": "", "createTimestamp": "", "modifiedBy": "", "modifyTimestamp": "", "isDeleted": "", "createTimestampTimezone": "", "modifyTimestampTimezone": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "id": { "type": "string" }, "problemId": { "type": "string" }, "personId": { "type": "string" }, "note": { "type": "string" }, "createdBy": { "type": "string" }, "createTimestamp": { "type": "string" }, "modifiedBy": { "type": "string" }, "modifyTimestamp": { "type": "string" }, "isDeleted": { "type": "string" }, "createTimestampTimezone": { "type": "string" }, "modifyTimestampTimezone": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "id", "problemId", "personId", "note", "createdBy", "createTimestamp", "modifiedBy", "modifyTimestamp", "isDeleted", "createTimestampTimezone", "modifyTimestampTimezone", "_links" ] }, "{{baseUrl}}/persons/:personId/chart/problems/:problemId/notesRequest": { "title": "{{baseUrl}}/persons/:personId/chart/problems/:problemId/notesRequest", "example": { "note": "" }, "type": "object", "properties": { "note": { "type": "string" } }, "required": [ "note" ] }, "OK90": { "title": "OK90", "example": { "id": "", "problemId": "", "personId": "", "note": "", "createdBy": "", "createTimestamp": "", "modifiedBy": "", "modifyTimestamp": "", "isDeleted": "", "createTimestampTimezone": "", "modifyTimestampTimezone": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "id": { "type": "string" }, "problemId": { "type": "string" }, "personId": { "type": "string" }, "note": { "type": "string" }, "createdBy": { "type": "string" }, "createTimestamp": { "type": "string" }, "modifiedBy": { "type": "string" }, "modifyTimestamp": { "type": "string" }, "isDeleted": { "type": "string" }, "createTimestampTimezone": { "type": "string" }, "modifyTimestampTimezone": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "id", "problemId", "personId", "note", "createdBy", "createTimestamp", "modifiedBy", "modifyTimestamp", "isDeleted", "createTimestampTimezone", "modifyTimestampTimezone", "_links" ] }, "{{baseUrl}}/persons/:personId/chart/problems/:problemId/notes/:noteIdRequest": { "title": "{{baseUrl}}/persons/:personId/chart/problems/:problemId/notes/:noteIdRequest", "example": { "note": "" }, "type": "object", "properties": { "note": { "type": "string" } }, "required": [ "note" ] }, "OK92": { "title": "OK92", "example": { "Items": [ { "personId": "", "enterpriseId": "", "practiceId": "", "id": "", "encounterId": "", "encounterTimestamp": "", "serviceItemId": "", "serviceItemDescription": "", "cpt4Code": "", "serviceDate": "", "isDeleted": "", "isCompleted": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "personId": "", "enterpriseId": "", "practiceId": "", "id": "", "encounterId": "", "encounterTimestamp": "", "serviceItemId": "", "serviceItemDescription": "", "cpt4Code": "", "serviceDate": "", "isDeleted": "", "isCompleted": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" }, "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/Item37" } }, "NextPageLink": { "type": "string" }, "Count": { "type": "string" } }, "required": [ "Items", "NextPageLink", "Count" ] }, "Item37": { "title": "Item37", "example": { "personId": "", "enterpriseId": "", "practiceId": "", "id": "", "encounterId": "", "encounterTimestamp": "", "serviceItemId": "", "serviceItemDescription": "", "cpt4Code": "", "serviceDate": "", "isDeleted": "", "isCompleted": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "personId": { "type": "string" }, "enterpriseId": { "type": "string" }, "practiceId": { "type": "string" }, "id": { "type": "string" }, "encounterId": { "type": "string" }, "encounterTimestamp": { "type": "string" }, "serviceItemId": { "type": "string" }, "serviceItemDescription": { "type": "string" }, "cpt4Code": { "type": "string" }, "serviceDate": { "type": "string" }, "isDeleted": { "type": "string" }, "isCompleted": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "personId", "enterpriseId", "practiceId", "id", "encounterId", "encounterTimestamp", "serviceItemId", "serviceItemDescription", "cpt4Code", "serviceDate", "isDeleted", "isCompleted", "_links" ] }, "OK93": { "title": "OK93", "example": { "id": "", "encounterId": "", "personId": "", "serviceItemLibraryId": "", "serviceItemGroupName": "", "serviceItemGroupSequenceNumber": "", "serviceItemId": "", "serviceItemDescription": "", "cpt4Code": "", "serviceDate": "", "providerId": "", "referringProviderId": "", "referringProviderName": "", "assistingProviderId": "", "dateResolved": "", "modifierId1": "", "modifierId2": "", "modifierId3": "", "modifierId4": "", "diagnosisCodeId1": "", "diagnosisCodeLibraryId1": "", "diagnosisCodeId2": "", "diagnosisCodeLibraryId2": "", "diagnosisCodeId3": "", "diagnosisCodeLibraryId3": "", "diagnosisCodeId4": "", "diagnosisCodeLibraryId4": "", "placeOfService": "", "hasAcceptedAssignment": "", "units": "", "locationId": "", "payerId": "", "amount": "", "isBillingSuppressed": "", "tooth": "", "surface": "", "quadrant": "", "note": "", "startTime": "", "stopTime": "", "totalTime": "", "baseUnit": "", "alternateCode": "", "isAnesthesiaBilling": "", "diagnosisCodeId5": "", "diagnosisCodeLibraryId5": "", "diagnosisCodeId6": "", "diagnosisCodeLibraryId6": "", "diagnosisCodeId7": "", "diagnosisCodeLibraryId7": "", "diagnosisCodeId8": "", "diagnosisCodeLibraryId8": "", "sourceProductId": "", "isRxOnFile": "", "nationalDrugCode": "", "isBehavioralBilling": "", "diagnosisCodeId9": "", "diagnosisCodeLibraryId9": "", "diagnosisCodeId10": "", "diagnosisCodeLibraryId10": "", "diagnosisCodeId11": "", "diagnosisCodeLibraryId11": "", "diagnosisCodeId12": "", "diagnosisCodeLibraryId12": "", "snomedConceptId": "", "snomedConceptId2": "", "snomedConceptId3": "", "snomedConceptId4": "", "isDental": "", "isSupernumerary": "", "surfaceDescriptor": "", "isDefective": "", "notApplicableDate": "", "approvalDate": "", "medicalDirectorId": "", "asaCrosswalkLibraryId": "", "surgicalProcedureCodeId": "", "surgicalProcedureDescription": "", "basisOfMeasure": "", "nationalDrugUnits": "", "teeth": "", "isDeleted": "", "enterpriseId": "", "practiceId": "", "createdBy": "", "createTimestamp": "", "createTimestampTimezone": "", "modifiedBy": "", "modifyTimestamp": "", "modifyTimestampTimezone": "", "isCompleted": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "id": { "type": "string" }, "encounterId": { "type": "string" }, "personId": { "type": "string" }, "serviceItemLibraryId": { "type": "string" }, "serviceItemGroupName": { "type": "string" }, "serviceItemGroupSequenceNumber": { "type": "string" }, "serviceItemId": { "type": "string" }, "serviceItemDescription": { "type": "string" }, "cpt4Code": { "type": "string" }, "serviceDate": { "type": "string" }, "providerId": { "type": "string" }, "referringProviderId": { "type": "string" }, "referringProviderName": { "type": "string" }, "assistingProviderId": { "type": "string" }, "dateResolved": { "type": "string" }, "modifierId1": { "type": "string" }, "modifierId2": { "type": "string" }, "modifierId3": { "type": "string" }, "modifierId4": { "type": "string" }, "diagnosisCodeId1": { "type": "string" }, "diagnosisCodeLibraryId1": { "type": "string" }, "diagnosisCodeId2": { "type": "string" }, "diagnosisCodeLibraryId2": { "type": "string" }, "diagnosisCodeId3": { "type": "string" }, "diagnosisCodeLibraryId3": { "type": "string" }, "diagnosisCodeId4": { "type": "string" }, "diagnosisCodeLibraryId4": { "type": "string" }, "placeOfService": { "type": "string" }, "hasAcceptedAssignment": { "type": "string" }, "units": { "type": "string" }, "locationId": { "type": "string" }, "payerId": { "type": "string" }, "amount": { "type": "string" }, "isBillingSuppressed": { "type": "string" }, "tooth": { "type": "string" }, "surface": { "type": "string" }, "quadrant": { "type": "string" }, "note": { "type": "string" }, "startTime": { "type": "string" }, "stopTime": { "type": "string" }, "totalTime": { "type": "string" }, "baseUnit": { "type": "string" }, "alternateCode": { "type": "string" }, "isAnesthesiaBilling": { "type": "string" }, "diagnosisCodeId5": { "type": "string" }, "diagnosisCodeLibraryId5": { "type": "string" }, "diagnosisCodeId6": { "type": "string" }, "diagnosisCodeLibraryId6": { "type": "string" }, "diagnosisCodeId7": { "type": "string" }, "diagnosisCodeLibraryId7": { "type": "string" }, "diagnosisCodeId8": { "type": "string" }, "diagnosisCodeLibraryId8": { "type": "string" }, "sourceProductId": { "type": "string" }, "isRxOnFile": { "type": "string" }, "nationalDrugCode": { "type": "string" }, "isBehavioralBilling": { "type": "string" }, "diagnosisCodeId9": { "type": "string" }, "diagnosisCodeLibraryId9": { "type": "string" }, "diagnosisCodeId10": { "type": "string" }, "diagnosisCodeLibraryId10": { "type": "string" }, "diagnosisCodeId11": { "type": "string" }, "diagnosisCodeLibraryId11": { "type": "string" }, "diagnosisCodeId12": { "type": "string" }, "diagnosisCodeLibraryId12": { "type": "string" }, "snomedConceptId": { "type": "string" }, "snomedConceptId2": { "type": "string" }, "snomedConceptId3": { "type": "string" }, "snomedConceptId4": { "type": "string" }, "isDental": { "type": "string" }, "isSupernumerary": { "type": "string" }, "surfaceDescriptor": { "type": "string" }, "isDefective": { "type": "string" }, "notApplicableDate": { "type": "string" }, "approvalDate": { "type": "string" }, "medicalDirectorId": { "type": "string" }, "asaCrosswalkLibraryId": { "type": "string" }, "surgicalProcedureCodeId": { "type": "string" }, "surgicalProcedureDescription": { "type": "string" }, "basisOfMeasure": { "type": "string" }, "nationalDrugUnits": { "type": "string" }, "teeth": { "type": "string" }, "isDeleted": { "type": "string" }, "enterpriseId": { "type": "string" }, "practiceId": { "type": "string" }, "createdBy": { "type": "string" }, "createTimestamp": { "type": "string" }, "createTimestampTimezone": { "type": "string" }, "modifiedBy": { "type": "string" }, "modifyTimestamp": { "type": "string" }, "modifyTimestampTimezone": { "type": "string" }, "isCompleted": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "id", "encounterId", "personId", "serviceItemLibraryId", "serviceItemGroupName", "serviceItemGroupSequenceNumber", "serviceItemId", "serviceItemDescription", "cpt4Code", "serviceDate", "providerId", "referringProviderId", "referringProviderName", "assistingProviderId", "dateResolved", "modifierId1", "modifierId2", "modifierId3", "modifierId4", "diagnosisCodeId1", "diagnosisCodeLibraryId1", "diagnosisCodeId2", "diagnosisCodeLibraryId2", "diagnosisCodeId3", "diagnosisCodeLibraryId3", "diagnosisCodeId4", "diagnosisCodeLibraryId4", "placeOfService", "hasAcceptedAssignment", "units", "locationId", "payerId", "amount", "isBillingSuppressed", "tooth", "surface", "quadrant", "note", "startTime", "stopTime", "totalTime", "baseUnit", "alternateCode", "isAnesthesiaBilling", "diagnosisCodeId5", "diagnosisCodeLibraryId5", "diagnosisCodeId6", "diagnosisCodeLibraryId6", "diagnosisCodeId7", "diagnosisCodeLibraryId7", "diagnosisCodeId8", "diagnosisCodeLibraryId8", "sourceProductId", "isRxOnFile", "nationalDrugCode", "isBehavioralBilling", "diagnosisCodeId9", "diagnosisCodeLibraryId9", "diagnosisCodeId10", "diagnosisCodeLibraryId10", "diagnosisCodeId11", "diagnosisCodeLibraryId11", "diagnosisCodeId12", "diagnosisCodeLibraryId12", "snomedConceptId", "snomedConceptId2", "snomedConceptId3", "snomedConceptId4", "isDental", "isSupernumerary", "surfaceDescriptor", "isDefective", "notApplicableDate", "approvalDate", "medicalDirectorId", "asaCrosswalkLibraryId", "surgicalProcedureCodeId", "surgicalProcedureDescription", "basisOfMeasure", "nationalDrugUnits", "teeth", "isDeleted", "enterpriseId", "practiceId", "createdBy", "createTimestamp", "createTimestampTimezone", "modifiedBy", "modifyTimestamp", "modifyTimestampTimezone", "isCompleted", "_links" ] }, "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/procedures/:procedureIdRequest": { "title": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/procedures/:procedureIdRequest", "example": { "serviceItemId": "", "serviceDate": "", "startTime": "", "stopTime": "", "amount": "", "placeOfService": "", "units": "", "rxOnFileIndicator": "", "suppressBillingIndicator": "", "nationalDrugCode": "", "locationId": "", "providerId": "", "tooth": "", "surface": "", "quadrant": "", "patientDiagnosisId1": "", "patientDiagnosisId2": "", "patientDiagnosisId3": "", "patientDiagnosisId4": "", "patientDiagnosisId5": "", "patientDiagnosisId6": "", "patientDiagnosisId7": "", "patientDiagnosisId8": "", "patientDiagnosisId9": "", "patientDiagnosisId10": "", "patientDiagnosisId11": "", "patientDiagnosisId12": "", "modifierId1": "", "modifierId2": "", "modifierId3": "", "modifierId4": "", "note": "" }, "type": "object", "properties": { "serviceItemId": { "type": "string" }, "serviceDate": { "type": "string" }, "startTime": { "type": "string" }, "stopTime": { "type": "string" }, "amount": { "type": "string" }, "placeOfService": { "type": "string" }, "units": { "type": "string" }, "rxOnFileIndicator": { "type": "string" }, "suppressBillingIndicator": { "type": "string" }, "nationalDrugCode": { "type": "string" }, "locationId": { "type": "string" }, "providerId": { "type": "string" }, "tooth": { "type": "string" }, "surface": { "type": "string" }, "quadrant": { "type": "string" }, "patientDiagnosisId1": { "type": "string" }, "patientDiagnosisId2": { "type": "string" }, "patientDiagnosisId3": { "type": "string" }, "patientDiagnosisId4": { "type": "string" }, "patientDiagnosisId5": { "type": "string" }, "patientDiagnosisId6": { "type": "string" }, "patientDiagnosisId7": { "type": "string" }, "patientDiagnosisId8": { "type": "string" }, "patientDiagnosisId9": { "type": "string" }, "patientDiagnosisId10": { "type": "string" }, "patientDiagnosisId11": { "type": "string" }, "patientDiagnosisId12": { "type": "string" }, "modifierId1": { "type": "string" }, "modifierId2": { "type": "string" }, "modifierId3": { "type": "string" }, "modifierId4": { "type": "string" }, "note": { "type": "string" } }, "required": [ "serviceItemId", "serviceDate", "startTime", "stopTime", "amount", "placeOfService", "units", "rxOnFileIndicator", "suppressBillingIndicator", "nationalDrugCode", "locationId", "providerId", "tooth", "surface", "quadrant", "patientDiagnosisId1", "patientDiagnosisId2", "patientDiagnosisId3", "patientDiagnosisId4", "patientDiagnosisId5", "patientDiagnosisId6", "patientDiagnosisId7", "patientDiagnosisId8", "patientDiagnosisId9", "patientDiagnosisId10", "patientDiagnosisId11", "patientDiagnosisId12", "modifierId1", "modifierId2", "modifierId3", "modifierId4", "note" ] }, "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/proceduresRequest": { "title": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/proceduresRequest", "example": { "serviceItemId": "", "serviceDate": "", "startTime": "", "stopTime": "", "amount": "", "placeOfService": "", "units": "", "rxOnFileIndicator": "", "suppressBillingIndicator": "", "nationalDrugCode": "", "locationId": "", "providerId": "", "tooth": "", "surface": "", "quadrant": "", "patientDiagnosisId1": "", "patientDiagnosisId2": "", "patientDiagnosisId3": "", "patientDiagnosisId4": "", "patientDiagnosisId5": "", "patientDiagnosisId6": "", "patientDiagnosisId7": "", "patientDiagnosisId8": "", "patientDiagnosisId9": "", "patientDiagnosisId10": "", "patientDiagnosisId11": "", "patientDiagnosisId12": "", "modifierId1": "", "modifierId2": "", "modifierId3": "", "modifierId4": "", "note": "" }, "type": "object", "properties": { "serviceItemId": { "type": "string" }, "serviceDate": { "type": "string" }, "startTime": { "type": "string" }, "stopTime": { "type": "string" }, "amount": { "type": "string" }, "placeOfService": { "type": "string" }, "units": { "type": "string" }, "rxOnFileIndicator": { "type": "string" }, "suppressBillingIndicator": { "type": "string" }, "nationalDrugCode": { "type": "string" }, "locationId": { "type": "string" }, "providerId": { "type": "string" }, "tooth": { "type": "string" }, "surface": { "type": "string" }, "quadrant": { "type": "string" }, "patientDiagnosisId1": { "type": "string" }, "patientDiagnosisId2": { "type": "string" }, "patientDiagnosisId3": { "type": "string" }, "patientDiagnosisId4": { "type": "string" }, "patientDiagnosisId5": { "type": "string" }, "patientDiagnosisId6": { "type": "string" }, "patientDiagnosisId7": { "type": "string" }, "patientDiagnosisId8": { "type": "string" }, "patientDiagnosisId9": { "type": "string" }, "patientDiagnosisId10": { "type": "string" }, "patientDiagnosisId11": { "type": "string" }, "patientDiagnosisId12": { "type": "string" }, "modifierId1": { "type": "string" }, "modifierId2": { "type": "string" }, "modifierId3": { "type": "string" }, "modifierId4": { "type": "string" }, "note": { "type": "string" } }, "required": [ "serviceItemId", "serviceDate", "startTime", "stopTime", "amount", "placeOfService", "units", "rxOnFileIndicator", "suppressBillingIndicator", "nationalDrugCode", "locationId", "providerId", "tooth", "surface", "quadrant", "patientDiagnosisId1", "patientDiagnosisId2", "patientDiagnosisId3", "patientDiagnosisId4", "patientDiagnosisId5", "patientDiagnosisId6", "patientDiagnosisId7", "patientDiagnosisId8", "patientDiagnosisId9", "patientDiagnosisId10", "patientDiagnosisId11", "patientDiagnosisId12", "modifierId1", "modifierId2", "modifierId3", "modifierId4", "note" ] }, "OK94": { "title": "OK94", "example": { "Items": [ { "personId": "", "enterpriseId": "", "practiceId": "", "encounterDate": "", "tobaccoType": "", "tobaccoStatus": "", "smokingStatus": "", "usagePerDay": "", "packYears": "", "dateQuit": "", "tobaccoHealthConcern": "", "tobaccoCategory": "", "smokingHealthConcern": "", "smokingCategory": "", "id": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "personId": "", "enterpriseId": "", "practiceId": "", "encounterDate": "", "tobaccoType": "", "tobaccoStatus": "", "smokingStatus": "", "usagePerDay": "", "packYears": "", "dateQuit": "", "tobaccoHealthConcern": "", "tobaccoCategory": "", "smokingHealthConcern": "", "smokingCategory": "", "id": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" }, "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/Item38" } }, "NextPageLink": { "type": "string" }, "Count": { "type": "string" } }, "required": [ "Items", "NextPageLink", "Count" ] }, "Item38": { "title": "Item38", "example": { "personId": "", "enterpriseId": "", "practiceId": "", "encounterDate": "", "tobaccoType": "", "tobaccoStatus": "", "smokingStatus": "", "usagePerDay": "", "packYears": "", "dateQuit": "", "tobaccoHealthConcern": "", "tobaccoCategory": "", "smokingHealthConcern": "", "smokingCategory": "", "id": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "personId": { "type": "string" }, "enterpriseId": { "type": "string" }, "practiceId": { "type": "string" }, "encounterDate": { "type": "string" }, "tobaccoType": { "type": "string" }, "tobaccoStatus": { "type": "string" }, "smokingStatus": { "type": "string" }, "usagePerDay": { "type": "string" }, "packYears": { "type": "string" }, "dateQuit": { "type": "string" }, "tobaccoHealthConcern": { "type": "string" }, "tobaccoCategory": { "type": "string" }, "smokingHealthConcern": { "type": "string" }, "smokingCategory": { "type": "string" }, "id": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "personId", "enterpriseId", "practiceId", "encounterDate", "tobaccoType", "tobaccoStatus", "smokingStatus", "usagePerDay", "packYears", "dateQuit", "tobaccoHealthConcern", "tobaccoCategory", "smokingHealthConcern", "smokingCategory", "id", "_links" ] }, "OK95": { "title": "OK95", "example": { "Items": [ { "createTimestamp": "", "createTimestampTimezone": "", "createdBy": "", "modifyTimestamp": "", "modifyTimestampTimezone": "", "modifiedBy": "", "enterpriseId": "", "practiceId": "", "personId": "", "encounterId": "", "homeLanguage": "", "birthCountry": "", "handDominance": "", "educationLevel": "", "educationDegree": "", "educationDegreeCountry": "", "occupationalHazard1": "", "occupationalHazard2": "", "hasMilitaryExperience": "", "militaryType": "", "militaryBranch": "", "militaryYearsServed": "", "militaryDischargeType": "", "militaryStationedOverseas": "", "militaryStationedOverseasLocation": "", "militaryNoiseExposure": "", "militaryBiohazardExposure": "", "previousWidowed": "", "previousWidowedTimes": "", "previousDivorce": "", "previousDivorceTimes": "", "hasChildren": "", "sonsCount": "", "daughtersCount": "", "supportNetworkComments": "", "supportNetwork": "", "primaryResidenceComments": "", "tobaccoUsage": "", "tobaccoType": "", "tobaccoUnitsPerDay": "", "tobaccoUnit": "", "tobaccoYearsSmoked": "", "tobaccoPackYears": "", "tobaccoCurrentOrPast": "", "tobaccoPreviousCessationAttempt": "", "tobaccoYearQuit": "", "tobaccoLongestFreePeriod": "", "tobaccoRelapseReason": "", "passiveSmokeExposure": "", "tobaccoCessationMethods": "", "alcoholUsage": "", "caffeineUsage": "", "caffeineType": "", "caffeineType2": "", "caffeinePerDay": "", "activityLevel": "", "healthClubMember": "", "exerciseFrequency": "", "exerciseHoursWeek": "", "exerciseType": "", "exercisetype2": "", "exercisetype3": "", "hobby1": "", "hobby2": "", "hobby3": "", "dietHistory1": "", "dietHistory2": "", "dietHistory3": "", "dietHistory4": "", "dietHistory5": "", "petAnimals": "", "petBirds": "", "petDogs": "", "petRodents": "", "petReptiles": "", "petOther": "", "pets": "", "cleansAnimals": "", "changesInSleepPatterns": "", "religiousAffiliation": "", "practiceReligion": "", "spiritualBeliefs": "", "importanceOfReligionSpirituality": "", "smokeDetectorsInHome": "", "carbonMonoxideDetectorsInHome": "", "radonInHome": "", "homeHeating": "", "seatBeltUsage": "", "fireArmsAtHome": "", "agreesToTransfusion": "", "travelOutOfState": "", "travelOutOfStateLocation": "", "travelOutOfCountry": "", "travelOutOfCounrtyLocation": "", "travelOutOfCountryRegion": "", "travelExposure": "", "travelExposureDetail": "", "advanceDirectivesReviewDate": "", "advanceDirectivesNone": "", "advanceDirectivesRefused": "", "advanceDirectivesDnr": "", "advanceDirectivesLivingWill": "", "advanceDirectivesDoNotPlaceOnLifeSupport": "", "advanceDirectivesDurablePowerOfAttorney": "", "advanceDirectivesHcProxy": "", "advanceDirectivesHcProxyName": "", "advanceDirectivesIncremented": "", "advanceDirectivesDiscussionsCount": "", "comments": "", "alcoholYearQuit": "", "alcoholType": "", "alcoholFrequency": "", "alcoholLastDrink": "", "alcoholAmount": "", "smokingStatus": "", "smokingStatusCode": "", "maritalStatus": "", "religion": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "createTimestamp": "", "createTimestampTimezone": "", "createdBy": "", "modifyTimestamp": "", "modifyTimestampTimezone": "", "modifiedBy": "", "enterpriseId": "", "practiceId": "", "personId": "", "encounterId": "", "homeLanguage": "", "birthCountry": "", "handDominance": "", "educationLevel": "", "educationDegree": "", "educationDegreeCountry": "", "occupationalHazard1": "", "occupationalHazard2": "", "hasMilitaryExperience": "", "militaryType": "", "militaryBranch": "", "militaryYearsServed": "", "militaryDischargeType": "", "militaryStationedOverseas": "", "militaryStationedOverseasLocation": "", "militaryNoiseExposure": "", "militaryBiohazardExposure": "", "previousWidowed": "", "previousWidowedTimes": "", "previousDivorce": "", "previousDivorceTimes": "", "hasChildren": "", "sonsCount": "", "daughtersCount": "", "supportNetworkComments": "", "supportNetwork": "", "primaryResidenceComments": "", "tobaccoUsage": "", "tobaccoType": "", "tobaccoUnitsPerDay": "", "tobaccoUnit": "", "tobaccoYearsSmoked": "", "tobaccoPackYears": "", "tobaccoCurrentOrPast": "", "tobaccoPreviousCessationAttempt": "", "tobaccoYearQuit": "", "tobaccoLongestFreePeriod": "", "tobaccoRelapseReason": "", "passiveSmokeExposure": "", "tobaccoCessationMethods": "", "alcoholUsage": "", "caffeineUsage": "", "caffeineType": "", "caffeineType2": "", "caffeinePerDay": "", "activityLevel": "", "healthClubMember": "", "exerciseFrequency": "", "exerciseHoursWeek": "", "exerciseType": "", "exercisetype2": "", "exercisetype3": "", "hobby1": "", "hobby2": "", "hobby3": "", "dietHistory1": "", "dietHistory2": "", "dietHistory3": "", "dietHistory4": "", "dietHistory5": "", "petAnimals": "", "petBirds": "", "petDogs": "", "petRodents": "", "petReptiles": "", "petOther": "", "pets": "", "cleansAnimals": "", "changesInSleepPatterns": "", "religiousAffiliation": "", "practiceReligion": "", "spiritualBeliefs": "", "importanceOfReligionSpirituality": "", "smokeDetectorsInHome": "", "carbonMonoxideDetectorsInHome": "", "radonInHome": "", "homeHeating": "", "seatBeltUsage": "", "fireArmsAtHome": "", "agreesToTransfusion": "", "travelOutOfState": "", "travelOutOfStateLocation": "", "travelOutOfCountry": "", "travelOutOfCounrtyLocation": "", "travelOutOfCountryRegion": "", "travelExposure": "", "travelExposureDetail": "", "advanceDirectivesReviewDate": "", "advanceDirectivesNone": "", "advanceDirectivesRefused": "", "advanceDirectivesDnr": "", "advanceDirectivesLivingWill": "", "advanceDirectivesDoNotPlaceOnLifeSupport": "", "advanceDirectivesDurablePowerOfAttorney": "", "advanceDirectivesHcProxy": "", "advanceDirectivesHcProxyName": "", "advanceDirectivesIncremented": "", "advanceDirectivesDiscussionsCount": "", "comments": "", "alcoholYearQuit": "", "alcoholType": "", "alcoholFrequency": "", "alcoholLastDrink": "", "alcoholAmount": "", "smokingStatus": "", "smokingStatusCode": "", "maritalStatus": "", "religion": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" }, "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/Item39" } }, "NextPageLink": { "type": "string" }, "Count": { "type": "string" } }, "required": [ "Items", "NextPageLink", "Count" ] }, "Item39": { "title": "Item39", "example": { "createTimestamp": "", "createTimestampTimezone": "", "createdBy": "", "modifyTimestamp": "", "modifyTimestampTimezone": "", "modifiedBy": "", "enterpriseId": "", "practiceId": "", "personId": "", "encounterId": "", "homeLanguage": "", "birthCountry": "", "handDominance": "", "educationLevel": "", "educationDegree": "", "educationDegreeCountry": "", "occupationalHazard1": "", "occupationalHazard2": "", "hasMilitaryExperience": "", "militaryType": "", "militaryBranch": "", "militaryYearsServed": "", "militaryDischargeType": "", "militaryStationedOverseas": "", "militaryStationedOverseasLocation": "", "militaryNoiseExposure": "", "militaryBiohazardExposure": "", "previousWidowed": "", "previousWidowedTimes": "", "previousDivorce": "", "previousDivorceTimes": "", "hasChildren": "", "sonsCount": "", "daughtersCount": "", "supportNetworkComments": "", "supportNetwork": "", "primaryResidenceComments": "", "tobaccoUsage": "", "tobaccoType": "", "tobaccoUnitsPerDay": "", "tobaccoUnit": "", "tobaccoYearsSmoked": "", "tobaccoPackYears": "", "tobaccoCurrentOrPast": "", "tobaccoPreviousCessationAttempt": "", "tobaccoYearQuit": "", "tobaccoLongestFreePeriod": "", "tobaccoRelapseReason": "", "passiveSmokeExposure": "", "tobaccoCessationMethods": "", "alcoholUsage": "", "caffeineUsage": "", "caffeineType": "", "caffeineType2": "", "caffeinePerDay": "", "activityLevel": "", "healthClubMember": "", "exerciseFrequency": "", "exerciseHoursWeek": "", "exerciseType": "", "exercisetype2": "", "exercisetype3": "", "hobby1": "", "hobby2": "", "hobby3": "", "dietHistory1": "", "dietHistory2": "", "dietHistory3": "", "dietHistory4": "", "dietHistory5": "", "petAnimals": "", "petBirds": "", "petDogs": "", "petRodents": "", "petReptiles": "", "petOther": "", "pets": "", "cleansAnimals": "", "changesInSleepPatterns": "", "religiousAffiliation": "", "practiceReligion": "", "spiritualBeliefs": "", "importanceOfReligionSpirituality": "", "smokeDetectorsInHome": "", "carbonMonoxideDetectorsInHome": "", "radonInHome": "", "homeHeating": "", "seatBeltUsage": "", "fireArmsAtHome": "", "agreesToTransfusion": "", "travelOutOfState": "", "travelOutOfStateLocation": "", "travelOutOfCountry": "", "travelOutOfCounrtyLocation": "", "travelOutOfCountryRegion": "", "travelExposure": "", "travelExposureDetail": "", "advanceDirectivesReviewDate": "", "advanceDirectivesNone": "", "advanceDirectivesRefused": "", "advanceDirectivesDnr": "", "advanceDirectivesLivingWill": "", "advanceDirectivesDoNotPlaceOnLifeSupport": "", "advanceDirectivesDurablePowerOfAttorney": "", "advanceDirectivesHcProxy": "", "advanceDirectivesHcProxyName": "", "advanceDirectivesIncremented": "", "advanceDirectivesDiscussionsCount": "", "comments": "", "alcoholYearQuit": "", "alcoholType": "", "alcoholFrequency": "", "alcoholLastDrink": "", "alcoholAmount": "", "smokingStatus": "", "smokingStatusCode": "", "maritalStatus": "", "religion": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "createTimestamp": { "type": "string" }, "createTimestampTimezone": { "type": "string" }, "createdBy": { "type": "string" }, "modifyTimestamp": { "type": "string" }, "modifyTimestampTimezone": { "type": "string" }, "modifiedBy": { "type": "string" }, "enterpriseId": { "type": "string" }, "practiceId": { "type": "string" }, "personId": { "type": "string" }, "encounterId": { "type": "string" }, "homeLanguage": { "type": "string" }, "birthCountry": { "type": "string" }, "handDominance": { "type": "string" }, "educationLevel": { "type": "string" }, "educationDegree": { "type": "string" }, "educationDegreeCountry": { "type": "string" }, "occupationalHazard1": { "type": "string" }, "occupationalHazard2": { "type": "string" }, "hasMilitaryExperience": { "type": "string" }, "militaryType": { "type": "string" }, "militaryBranch": { "type": "string" }, "militaryYearsServed": { "type": "string" }, "militaryDischargeType": { "type": "string" }, "militaryStationedOverseas": { "type": "string" }, "militaryStationedOverseasLocation": { "type": "string" }, "militaryNoiseExposure": { "type": "string" }, "militaryBiohazardExposure": { "type": "string" }, "previousWidowed": { "type": "string" }, "previousWidowedTimes": { "type": "string" }, "previousDivorce": { "type": "string" }, "previousDivorceTimes": { "type": "string" }, "hasChildren": { "type": "string" }, "sonsCount": { "type": "string" }, "daughtersCount": { "type": "string" }, "supportNetworkComments": { "type": "string" }, "supportNetwork": { "type": "string" }, "primaryResidenceComments": { "type": "string" }, "tobaccoUsage": { "type": "string" }, "tobaccoType": { "type": "string" }, "tobaccoUnitsPerDay": { "type": "string" }, "tobaccoUnit": { "type": "string" }, "tobaccoYearsSmoked": { "type": "string" }, "tobaccoPackYears": { "type": "string" }, "tobaccoCurrentOrPast": { "type": "string" }, "tobaccoPreviousCessationAttempt": { "type": "string" }, "tobaccoYearQuit": { "type": "string" }, "tobaccoLongestFreePeriod": { "type": "string" }, "tobaccoRelapseReason": { "type": "string" }, "passiveSmokeExposure": { "type": "string" }, "tobaccoCessationMethods": { "type": "string" }, "alcoholUsage": { "type": "string" }, "caffeineUsage": { "type": "string" }, "caffeineType": { "type": "string" }, "caffeineType2": { "type": "string" }, "caffeinePerDay": { "type": "string" }, "activityLevel": { "type": "string" }, "healthClubMember": { "type": "string" }, "exerciseFrequency": { "type": "string" }, "exerciseHoursWeek": { "type": "string" }, "exerciseType": { "type": "string" }, "exercisetype2": { "type": "string" }, "exercisetype3": { "type": "string" }, "hobby1": { "type": "string" }, "hobby2": { "type": "string" }, "hobby3": { "type": "string" }, "dietHistory1": { "type": "string" }, "dietHistory2": { "type": "string" }, "dietHistory3": { "type": "string" }, "dietHistory4": { "type": "string" }, "dietHistory5": { "type": "string" }, "petAnimals": { "type": "string" }, "petBirds": { "type": "string" }, "petDogs": { "type": "string" }, "petRodents": { "type": "string" }, "petReptiles": { "type": "string" }, "petOther": { "type": "string" }, "pets": { "type": "string" }, "cleansAnimals": { "type": "string" }, "changesInSleepPatterns": { "type": "string" }, "religiousAffiliation": { "type": "string" }, "practiceReligion": { "type": "string" }, "spiritualBeliefs": { "type": "string" }, "importanceOfReligionSpirituality": { "type": "string" }, "smokeDetectorsInHome": { "type": "string" }, "carbonMonoxideDetectorsInHome": { "type": "string" }, "radonInHome": { "type": "string" }, "homeHeating": { "type": "string" }, "seatBeltUsage": { "type": "string" }, "fireArmsAtHome": { "type": "string" }, "agreesToTransfusion": { "type": "string" }, "travelOutOfState": { "type": "string" }, "travelOutOfStateLocation": { "type": "string" }, "travelOutOfCountry": { "type": "string" }, "travelOutOfCounrtyLocation": { "type": "string" }, "travelOutOfCountryRegion": { "type": "string" }, "travelExposure": { "type": "string" }, "travelExposureDetail": { "type": "string" }, "advanceDirectivesReviewDate": { "type": "string" }, "advanceDirectivesNone": { "type": "string" }, "advanceDirectivesRefused": { "type": "string" }, "advanceDirectivesDnr": { "type": "string" }, "advanceDirectivesLivingWill": { "type": "string" }, "advanceDirectivesDoNotPlaceOnLifeSupport": { "type": "string" }, "advanceDirectivesDurablePowerOfAttorney": { "type": "string" }, "advanceDirectivesHcProxy": { "type": "string" }, "advanceDirectivesHcProxyName": { "type": "string" }, "advanceDirectivesIncremented": { "type": "string" }, "advanceDirectivesDiscussionsCount": { "type": "string" }, "comments": { "type": "string" }, "alcoholYearQuit": { "type": "string" }, "alcoholType": { "type": "string" }, "alcoholFrequency": { "type": "string" }, "alcoholLastDrink": { "type": "string" }, "alcoholAmount": { "type": "string" }, "smokingStatus": { "type": "string" }, "smokingStatusCode": { "type": "string" }, "maritalStatus": { "type": "string" }, "religion": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "createTimestamp", "createTimestampTimezone", "createdBy", "modifyTimestamp", "modifyTimestampTimezone", "modifiedBy", "enterpriseId", "practiceId", "personId", "encounterId", "homeLanguage", "birthCountry", "handDominance", "educationLevel", "educationDegree", "educationDegreeCountry", "occupationalHazard1", "occupationalHazard2", "hasMilitaryExperience", "militaryType", "militaryBranch", "militaryYearsServed", "militaryDischargeType", "militaryStationedOverseas", "militaryStationedOverseasLocation", "militaryNoiseExposure", "militaryBiohazardExposure", "previousWidowed", "previousWidowedTimes", "previousDivorce", "previousDivorceTimes", "hasChildren", "sonsCount", "daughtersCount", "supportNetworkComments", "supportNetwork", "primaryResidenceComments", "tobaccoUsage", "tobaccoType", "tobaccoUnitsPerDay", "tobaccoUnit", "tobaccoYearsSmoked", "tobaccoPackYears", "tobaccoCurrentOrPast", "tobaccoPreviousCessationAttempt", "tobaccoYearQuit", "tobaccoLongestFreePeriod", "tobaccoRelapseReason", "passiveSmokeExposure", "tobaccoCessationMethods", "alcoholUsage", "caffeineUsage", "caffeineType", "caffeineType2", "caffeinePerDay", "activityLevel", "healthClubMember", "exerciseFrequency", "exerciseHoursWeek", "exerciseType", "exercisetype2", "exercisetype3", "hobby1", "hobby2", "hobby3", "dietHistory1", "dietHistory2", "dietHistory3", "dietHistory4", "dietHistory5", "petAnimals", "petBirds", "petDogs", "petRodents", "petReptiles", "petOther", "pets", "cleansAnimals", "changesInSleepPatterns", "religiousAffiliation", "practiceReligion", "spiritualBeliefs", "importanceOfReligionSpirituality", "smokeDetectorsInHome", "carbonMonoxideDetectorsInHome", "radonInHome", "homeHeating", "seatBeltUsage", "fireArmsAtHome", "agreesToTransfusion", "travelOutOfState", "travelOutOfStateLocation", "travelOutOfCountry", "travelOutOfCounrtyLocation", "travelOutOfCountryRegion", "travelExposure", "travelExposureDetail", "advanceDirectivesReviewDate", "advanceDirectivesNone", "advanceDirectivesRefused", "advanceDirectivesDnr", "advanceDirectivesLivingWill", "advanceDirectivesDoNotPlaceOnLifeSupport", "advanceDirectivesDurablePowerOfAttorney", "advanceDirectivesHcProxy", "advanceDirectivesHcProxyName", "advanceDirectivesIncremented", "advanceDirectivesDiscussionsCount", "comments", "alcoholYearQuit", "alcoholType", "alcoholFrequency", "alcoholLastDrink", "alcoholAmount", "smokingStatus", "smokingStatusCode", "maritalStatus", "religion", "_links" ] }, "OK96": { "title": "OK96", "example": { "Items": [ { "encounterId": "", "personId": "", "sequenceNumber": "", "createTimestamp": "", "maximumTobaccoFreeDuration": "", "packYears": "", "passiveExposure": "", "relapseReason": "", "tobaccoType": "", "socialHistoryTobaccoType": "", "tobaccoUseStatus": "", "totalPackYears": "", "triedToQuit": "", "unitsPerDay": "", "yearQuit": "", "yearsUsed": "", "ageStarted": "", "ageStopped": "", "dateStarted": "", "dateStopped": "", "smokingStatus": "", "tobaccoStatus": "", "usagePerDay": "", "socialHistoryCreateTimestamp": "", "tobaccoUserProfileCode": "", "tobaccoUserProfile": "", "useDailyCigarette": "", "ageStartedCigarette": "", "ageStoppedCigarette": "", "usagePerDayCigarette": "", "useDailyCigarillo": "", "ageStartedCigarillo": "", "ageStoppedCigarillo": "", "usagePerDayCigarillo": "", "useDailyCigar": "", "ageStartedCigar": "", "ageStoppedCigar": "", "usagePerDayCigar": "", "useDailyPipe": "", "ageStartedPipe": "", "ageStoppedPipe": "", "usagePerDayPipe": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "encounterId": "", "personId": "", "sequenceNumber": "", "createTimestamp": "", "maximumTobaccoFreeDuration": "", "packYears": "", "passiveExposure": "", "relapseReason": "", "tobaccoType": "", "socialHistoryTobaccoType": "", "tobaccoUseStatus": "", "totalPackYears": "", "triedToQuit": "", "unitsPerDay": "", "yearQuit": "", "yearsUsed": "", "ageStarted": "", "ageStopped": "", "dateStarted": "", "dateStopped": "", "smokingStatus": "", "tobaccoStatus": "", "usagePerDay": "", "socialHistoryCreateTimestamp": "", "tobaccoUserProfileCode": "", "tobaccoUserProfile": "", "useDailyCigarette": "", "ageStartedCigarette": "", "ageStoppedCigarette": "", "usagePerDayCigarette": "", "useDailyCigarillo": "", "ageStartedCigarillo": "", "ageStoppedCigarillo": "", "usagePerDayCigarillo": "", "useDailyCigar": "", "ageStartedCigar": "", "ageStoppedCigar": "", "usagePerDayCigar": "", "useDailyPipe": "", "ageStartedPipe": "", "ageStoppedPipe": "", "usagePerDayPipe": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" }, "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/Item40" } }, "NextPageLink": { "type": "string" }, "Count": { "type": "string" } }, "required": [ "Items", "NextPageLink", "Count" ] }, "Item40": { "title": "Item40", "example": { "encounterId": "", "personId": "", "sequenceNumber": "", "createTimestamp": "", "maximumTobaccoFreeDuration": "", "packYears": "", "passiveExposure": "", "relapseReason": "", "tobaccoType": "", "socialHistoryTobaccoType": "", "tobaccoUseStatus": "", "totalPackYears": "", "triedToQuit": "", "unitsPerDay": "", "yearQuit": "", "yearsUsed": "", "ageStarted": "", "ageStopped": "", "dateStarted": "", "dateStopped": "", "smokingStatus": "", "tobaccoStatus": "", "usagePerDay": "", "socialHistoryCreateTimestamp": "", "tobaccoUserProfileCode": "", "tobaccoUserProfile": "", "useDailyCigarette": "", "ageStartedCigarette": "", "ageStoppedCigarette": "", "usagePerDayCigarette": "", "useDailyCigarillo": "", "ageStartedCigarillo": "", "ageStoppedCigarillo": "", "usagePerDayCigarillo": "", "useDailyCigar": "", "ageStartedCigar": "", "ageStoppedCigar": "", "usagePerDayCigar": "", "useDailyPipe": "", "ageStartedPipe": "", "ageStoppedPipe": "", "usagePerDayPipe": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "encounterId": { "type": "string" }, "personId": { "type": "string" }, "sequenceNumber": { "type": "string" }, "createTimestamp": { "type": "string" }, "maximumTobaccoFreeDuration": { "type": "string" }, "packYears": { "type": "string" }, "passiveExposure": { "type": "string" }, "relapseReason": { "type": "string" }, "tobaccoType": { "type": "string" }, "socialHistoryTobaccoType": { "type": "string" }, "tobaccoUseStatus": { "type": "string" }, "totalPackYears": { "type": "string" }, "triedToQuit": { "type": "string" }, "unitsPerDay": { "type": "string" }, "yearQuit": { "type": "string" }, "yearsUsed": { "type": "string" }, "ageStarted": { "type": "string" }, "ageStopped": { "type": "string" }, "dateStarted": { "type": "string" }, "dateStopped": { "type": "string" }, "smokingStatus": { "type": "string" }, "tobaccoStatus": { "type": "string" }, "usagePerDay": { "type": "string" }, "socialHistoryCreateTimestamp": { "type": "string" }, "tobaccoUserProfileCode": { "type": "string" }, "tobaccoUserProfile": { "type": "string" }, "useDailyCigarette": { "type": "string" }, "ageStartedCigarette": { "type": "string" }, "ageStoppedCigarette": { "type": "string" }, "usagePerDayCigarette": { "type": "string" }, "useDailyCigarillo": { "type": "string" }, "ageStartedCigarillo": { "type": "string" }, "ageStoppedCigarillo": { "type": "string" }, "usagePerDayCigarillo": { "type": "string" }, "useDailyCigar": { "type": "string" }, "ageStartedCigar": { "type": "string" }, "ageStoppedCigar": { "type": "string" }, "usagePerDayCigar": { "type": "string" }, "useDailyPipe": { "type": "string" }, "ageStartedPipe": { "type": "string" }, "ageStoppedPipe": { "type": "string" }, "usagePerDayPipe": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "encounterId", "personId", "sequenceNumber", "createTimestamp", "maximumTobaccoFreeDuration", "packYears", "passiveExposure", "relapseReason", "tobaccoType", "socialHistoryTobaccoType", "tobaccoUseStatus", "totalPackYears", "triedToQuit", "unitsPerDay", "yearQuit", "yearsUsed", "ageStarted", "ageStopped", "dateStarted", "dateStopped", "smokingStatus", "tobaccoStatus", "usagePerDay", "socialHistoryCreateTimestamp", "tobaccoUserProfileCode", "tobaccoUserProfile", "useDailyCigarette", "ageStartedCigarette", "ageStoppedCigarette", "usagePerDayCigarette", "useDailyCigarillo", "ageStartedCigarillo", "ageStoppedCigarillo", "usagePerDayCigarillo", "useDailyCigar", "ageStartedCigar", "ageStoppedCigar", "usagePerDayCigar", "useDailyPipe", "ageStartedPipe", "ageStoppedPipe", "usagePerDayPipe", "_links" ] }, "OK97": { "title": "OK97", "example": { "Items": [ { "id": "", "personId": "", "enterpriseId": "", "practiceId": "", "encounterId": "", "vitalSignsDate": "", "vitalSignsTime": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, { "id": "", "personId": "", "enterpriseId": "", "practiceId": "", "encounterId": "", "vitalSignsDate": "", "vitalSignsTime": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] } ], "NextPageLink": "", "Count": "" }, "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/Item41" } }, "NextPageLink": { "type": "string" }, "Count": { "type": "string" } }, "required": [ "Items", "NextPageLink", "Count" ] }, "Item41": { "title": "Item41", "example": { "id": "", "personId": "", "enterpriseId": "", "practiceId": "", "encounterId": "", "vitalSignsDate": "", "vitalSignsTime": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "id": { "type": "string" }, "personId": { "type": "string" }, "enterpriseId": { "type": "string" }, "practiceId": { "type": "string" }, "encounterId": { "type": "string" }, "vitalSignsDate": { "type": "string" }, "vitalSignsTime": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "id", "personId", "enterpriseId", "practiceId", "encounterId", "vitalSignsDate", "vitalSignsTime", "_links" ] }, "OK98": { "title": "OK98", "example": { "id": "", "personId": "", "enterpriseId": "", "practiceId": "", "encounterId": "", "bmi": "", "bloodPressure": "", "bloodPressureSystolic": "", "bloodPressureDiastolic": "", "bloodPressureMethod": "", "bloodPressureSide": "", "bloodPressureBodySite": "", "bloodPressureSite": "", "bloodPressureBodyPosition": "", "isBloodPressureCuffSizePediatric": "", "isBloodPressureCuffSizeAdult": "", "isBloodPressureCuffSizeLarge": "", "isBloodPressureCuffSizeThigh": "", "isBloodPressureCaptured": "", "measuredBy": "", "vitalSignsDate": "", "vitalSignsTime": "", "fractionOfInspiredOxygen": "", "pulsePattern": "", "pulseRate": "", "pulseOximeterOxygenSaturationRest": "", "pulseOximeterOxygenSaturationRestSite": "", "isGrowthChartCaptured": "", "isHealthAssessmentQuestionnaireCaptured": "", "isExclusionCaptured": "", "bmiPercent": "", "bodySurfaceArea": "", "isHipCircumferenceCaptured": "", "isHeadCircumferenceCaptured": "", "isHeightCaptured": "", "isNeckCircumferenceCaptured": "", "isTemperatureCaptured": "", "isWaistCircumferenceCaptured": "", "isWeightCaptured": "", "hasPatientRefused": "", "isUnobtainable": "", "comments": "", "headCircumferenceCentimeters": "", "headCircumferenceInches": "", "headCircumferencePercent": "", "heightCentimeters": "", "heightDate": "", "heightFeet": "", "heightInches": "", "heightMeters": "", "heightMethod": "", "heightPercent": "", "hipCircumferenceCentimeters": "", "hipCircumferenceInches": "", "heightBodyPosition": "", "neckCircumferenceCentimeters": "", "neckCircumferenceInches": "", "pulseOximeterOxygenSaturationSource": "", "painScoreLoinc": "", "painScoreDisplay": "", "peakFlow": "", "peakFlowMethod": "", "peakFlowTiming": "", "respirationRate": "", "pulseOximeterOxygenSaturationMeasured": "", "temperatureDegreesCelcius": "", "temperatureDegreesFahrenheit": "", "temperatureSite": "", "fractionOfInspiredOxygenLitresPerMinute": "", "currentAge": "", "fractionOfInspiredOxygenRoomAir": "", "pulseOximeterOxygenSaturationRestLitresPerMinute": "", "painMethod": "", "pulseOximeterOxygenSaturationAmbulatory": "", "reasonRefused": "", "unobtainableReason": "", "patientRefusedVitals": "", "unobtainableVitals": "", "waistCircumferenceCentimeters": "", "waistCircumferenceInches": "", "waistHipRatio": "", "weightContext": "", "weightKilograms": "", "weightPounds": "", "weightPercent": "", "bloodPressureCuffSize": "", "areOrthostaticVitalSignsCaptured": "", "menopausalStage": "", "lmp": "", "gestationalWeeks": "", "gestationalDays": "", "heightCentimetersGraph": "", "heightInchesGraph": "", "weightKilogramsGraph": "", "weightPoundsGraph": "", "_links": [ { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" }, { "href": "", "method": "", "rel": "", "description": "", "vendorExtensions": "" } ] }, "type": "object", "properties": { "id": { "type": "string" }, "personId": { "type": "string" }, "enterpriseId": { "type": "string" }, "practiceId": { "type": "string" }, "encounterId": { "type": "string" }, "bmi": { "type": "string" }, "bloodPressure": { "type": "string" }, "bloodPressureSystolic": { "type": "string" }, "bloodPressureDiastolic": { "type": "string" }, "bloodPressureMethod": { "type": "string" }, "bloodPressureSide": { "type": "string" }, "bloodPressureBodySite": { "type": "string" }, "bloodPressureSite": { "type": "string" }, "bloodPressureBodyPosition": { "type": "string" }, "isBloodPressureCuffSizePediatric": { "type": "string" }, "isBloodPressureCuffSizeAdult": { "type": "string" }, "isBloodPressureCuffSizeLarge": { "type": "string" }, "isBloodPressureCuffSizeThigh": { "type": "string" }, "isBloodPressureCaptured": { "type": "string" }, "measuredBy": { "type": "string" }, "vitalSignsDate": { "type": "string" }, "vitalSignsTime": { "type": "string" }, "fractionOfInspiredOxygen": { "type": "string" }, "pulsePattern": { "type": "string" }, "pulseRate": { "type": "string" }, "pulseOximeterOxygenSaturationRest": { "type": "string" }, "pulseOximeterOxygenSaturationRestSite": { "type": "string" }, "isGrowthChartCaptured": { "type": "string" }, "isHealthAssessmentQuestionnaireCaptured": { "type": "string" }, "isExclusionCaptured": { "type": "string" }, "bmiPercent": { "type": "string" }, "bodySurfaceArea": { "type": "string" }, "isHipCircumferenceCaptured": { "type": "string" }, "isHeadCircumferenceCaptured": { "type": "string" }, "isHeightCaptured": { "type": "string" }, "isNeckCircumferenceCaptured": { "type": "string" }, "isTemperatureCaptured": { "type": "string" }, "isWaistCircumferenceCaptured": { "type": "string" }, "isWeightCaptured": { "type": "string" }, "hasPatientRefused": { "type": "string" }, "isUnobtainable": { "type": "string" }, "comments": { "type": "string" }, "headCircumferenceCentimeters": { "type": "string" }, "headCircumferenceInches": { "type": "string" }, "headCircumferencePercent": { "type": "string" }, "heightCentimeters": { "type": "string" }, "heightDate": { "type": "string" }, "heightFeet": { "type": "string" }, "heightInches": { "type": "string" }, "heightMeters": { "type": "string" }, "heightMethod": { "type": "string" }, "heightPercent": { "type": "string" }, "hipCircumferenceCentimeters": { "type": "string" }, "hipCircumferenceInches": { "type": "string" }, "heightBodyPosition": { "type": "string" }, "neckCircumferenceCentimeters": { "type": "string" }, "neckCircumferenceInches": { "type": "string" }, "pulseOximeterOxygenSaturationSource": { "type": "string" }, "painScoreLoinc": { "type": "string" }, "painScoreDisplay": { "type": "string" }, "peakFlow": { "type": "string" }, "peakFlowMethod": { "type": "string" }, "peakFlowTiming": { "type": "string" }, "respirationRate": { "type": "string" }, "pulseOximeterOxygenSaturationMeasured": { "type": "string" }, "temperatureDegreesCelcius": { "type": "string" }, "temperatureDegreesFahrenheit": { "type": "string" }, "temperatureSite": { "type": "string" }, "fractionOfInspiredOxygenLitresPerMinute": { "type": "string" }, "currentAge": { "type": "string" }, "fractionOfInspiredOxygenRoomAir": { "type": "string" }, "pulseOximeterOxygenSaturationRestLitresPerMinute": { "type": "string" }, "painMethod": { "type": "string" }, "pulseOximeterOxygenSaturationAmbulatory": { "type": "string" }, "reasonRefused": { "type": "string" }, "unobtainableReason": { "type": "string" }, "patientRefusedVitals": { "type": "string" }, "unobtainableVitals": { "type": "string" }, "waistCircumferenceCentimeters": { "type": "string" }, "waistCircumferenceInches": { "type": "string" }, "waistHipRatio": { "type": "string" }, "weightContext": { "type": "string" }, "weightKilograms": { "type": "string" }, "weightPounds": { "type": "string" }, "weightPercent": { "type": "string" }, "bloodPressureCuffSize": { "type": "string" }, "areOrthostaticVitalSignsCaptured": { "type": "string" }, "menopausalStage": { "type": "string" }, "lmp": { "type": "string" }, "gestationalWeeks": { "type": "string" }, "gestationalDays": { "type": "string" }, "heightCentimetersGraph": { "type": "string" }, "heightInchesGraph": { "type": "string" }, "weightKilogramsGraph": { "type": "string" }, "weightPoundsGraph": { "type": "string" }, "_links": { "type": "array", "items": { "$ref": "#/definitions/Link" } } }, "required": [ "id", "personId", "enterpriseId", "practiceId", "encounterId", "bmi", "bloodPressure", "bloodPressureSystolic", "bloodPressureDiastolic", "bloodPressureMethod", "bloodPressureSide", "bloodPressureBodySite", "bloodPressureSite", "bloodPressureBodyPosition", "isBloodPressureCuffSizePediatric", "isBloodPressureCuffSizeAdult", "isBloodPressureCuffSizeLarge", "isBloodPressureCuffSizeThigh", "isBloodPressureCaptured", "measuredBy", "vitalSignsDate", "vitalSignsTime", "fractionOfInspiredOxygen", "pulsePattern", "pulseRate", "pulseOximeterOxygenSaturationRest", "pulseOximeterOxygenSaturationRestSite", "isGrowthChartCaptured", "isHealthAssessmentQuestionnaireCaptured", "isExclusionCaptured", "bmiPercent", "bodySurfaceArea", "isHipCircumferenceCaptured", "isHeadCircumferenceCaptured", "isHeightCaptured", "isNeckCircumferenceCaptured", "isTemperatureCaptured", "isWaistCircumferenceCaptured", "isWeightCaptured", "hasPatientRefused", "isUnobtainable", "comments", "headCircumferenceCentimeters", "headCircumferenceInches", "headCircumferencePercent", "heightCentimeters", "heightDate", "heightFeet", "heightInches", "heightMeters", "heightMethod", "heightPercent", "hipCircumferenceCentimeters", "hipCircumferenceInches", "heightBodyPosition", "neckCircumferenceCentimeters", "neckCircumferenceInches", "pulseOximeterOxygenSaturationSource", "painScoreLoinc", "painScoreDisplay", "peakFlow", "peakFlowMethod", "peakFlowTiming", "respirationRate", "pulseOximeterOxygenSaturationMeasured", "temperatureDegreesCelcius", "temperatureDegreesFahrenheit", "temperatureSite", "fractionOfInspiredOxygenLitresPerMinute", "currentAge", "fractionOfInspiredOxygenRoomAir", "pulseOximeterOxygenSaturationRestLitresPerMinute", "painMethod", "pulseOximeterOxygenSaturationAmbulatory", "reasonRefused", "unobtainableReason", "patientRefusedVitals", "unobtainableVitals", "waistCircumferenceCentimeters", "waistCircumferenceInches", "waistHipRatio", "weightContext", "weightKilograms", "weightPounds", "weightPercent", "bloodPressureCuffSize", "areOrthostaticVitalSignsCaptured", "menopausalStage", "lmp", "gestationalWeeks", "gestationalDays", "heightCentimetersGraph", "heightInchesGraph", "weightKilogramsGraph", "weightPoundsGraph", "_links" ] }, "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/vitals/:vitalsIdRequest": { "title": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/vitals/:vitalsIdRequest", "example": { "heightInFeet": 1.0, "heightInInches": 1.0, "heightInTotalInches": 1.0, "heightInCentimeters": 1.0, "heightBodyPosition": "string", "heightDate": "2024-05-30T19:57:43.500Z", "heightMethod": "string", "weightInPounds": 1.0, "weightInKilograms": 1.0, "weightContext": "string", "temperatureDegreesFahrenheit": 1.0, "temperatureDegreesCelcius": 1.0, "temperatureSite": "string", "bloodPressureSystolic": 1, "bloodPressureDiastolic": 1, "bloodPressureBodyPosition": "string", "bloodPressureTargetSite": "string", "bloodPressureTargetSide": "string", "bloodPressureMethod": "string", "bloodPressureCuffSize": "string", "pulseRate": 1, "pulsePattern": "string", "respirationRate": 1, "fractionOfInspiredOxygenDeliveryMethod": "string", "fractionOfInspiredOxygenRoomAir": 1, "fractionOfInspiredOxygen": 1, "fractionOfInspiredOxygenScore": "string", "pulseOxRest": 1, "pulseOxAmb": 1, "oxygenType": "string", "oxygenLiterPerMinute": 1.0, "spO2Timing": "string", "fingerProbe": "string", "peakFlow": 1, "peakFlowTiming": "string", "peakFlowMethod": "string", "painLevel": "string", "painMethod": "string", "isUnobtainable": true, "unobtainableVital": "string", "hasPatientRefused": true, "patientRefusedVital": "string", "calculateBsa": true, "vitalSignsDate": "2024-05-30T19:57:43.500Z", "comments": "string", "performedBy": "string", "provenanceInfo": "string", "isExternalData": true }, "type": "object", "properties": { "heightInFeet": { "type": "number", "format": "double" }, "heightInInches": { "type": "number", "format": "double" }, "heightInTotalInches": { "type": "number", "format": "double" }, "heightInCentimeters": { "type": "number", "format": "double" }, "heightBodyPosition": { "type": "string" }, "heightDate": { "type": "string" }, "heightMethod": { "type": "string" }, "weightInPounds": { "type": "number", "format": "double" }, "weightInKilograms": { "type": "number", "format": "double" }, "weightContext": { "type": "string" }, "temperatureDegreesFahrenheit": { "type": "number", "format": "double" }, "temperatureDegreesCelcius": { "type": "number", "format": "double" }, "temperatureSite": { "type": "string" }, "bloodPressureSystolic": { "type": "integer", "format": "int32" }, "bloodPressureDiastolic": { "type": "integer", "format": "int32" }, "bloodPressureBodyPosition": { "type": "string" }, "bloodPressureTargetSite": { "type": "string" }, "bloodPressureTargetSide": { "type": "string" }, "bloodPressureMethod": { "type": "string" }, "bloodPressureCuffSize": { "type": "string" }, "pulseRate": { "type": "integer", "format": "int32" }, "pulsePattern": { "type": "string" }, "respirationRate": { "type": "integer", "format": "int32" }, "fractionOfInspiredOxygenDeliveryMethod": { "type": "string" }, "fractionOfInspiredOxygenRoomAir": { "type": "integer", "format": "int32" }, "fractionOfInspiredOxygen": { "type": "integer", "format": "int32" }, "fractionOfInspiredOxygenScore": { "type": "string" }, "pulseOxRest": { "type": "integer", "format": "int32" }, "pulseOxAmb": { "type": "integer", "format": "int32" }, "oxygenType": { "type": "string" }, "oxygenLiterPerMinute": { "type": "number", "format": "double" }, "spO2Timing": { "type": "string" }, "fingerProbe": { "type": "string" }, "peakFlow": { "type": "integer", "format": "int32" }, "peakFlowTiming": { "type": "string" }, "peakFlowMethod": { "type": "string" }, "painLevel": { "type": "string" }, "painMethod": { "type": "string" }, "isUnobtainable": { "type": "boolean" }, "unobtainableVital": { "type": "string" }, "hasPatientRefused": { "type": "boolean" }, "patientRefusedVital": { "type": "string" }, "calculateBsa": { "type": "boolean" }, "vitalSignsDate": { "type": "string" }, "comments": { "type": "string" }, "performedBy": { "type": "string" }, "provenanceInfo": { "type": "string" }, "isExternalData": { "type": "boolean" } }, "required": [ "heightInFeet", "heightInInches", "heightInTotalInches", "heightInCentimeters", "heightBodyPosition", "heightDate", "heightMethod", "weightInPounds", "weightInKilograms", "weightContext", "temperatureDegreesFahrenheit", "temperatureDegreesCelcius", "temperatureSite", "bloodPressureSystolic", "bloodPressureDiastolic", "bloodPressureBodyPosition", "bloodPressureTargetSite", "bloodPressureTargetSide", "bloodPressureMethod", "bloodPressureCuffSize", "pulseRate", "pulsePattern", "respirationRate", "fractionOfInspiredOxygenDeliveryMethod", "fractionOfInspiredOxygenRoomAir", "fractionOfInspiredOxygen", "fractionOfInspiredOxygenScore", "pulseOxRest", "pulseOxAmb", "oxygenType", "oxygenLiterPerMinute", "spO2Timing", "fingerProbe", "peakFlow", "peakFlowTiming", "peakFlowMethod", "painLevel", "painMethod", "isUnobtainable", "unobtainableVital", "hasPatientRefused", "patientRefusedVital", "calculateBsa", "vitalSignsDate", "comments", "performedBy", "provenanceInfo", "isExternalData" ] }, "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/vitalsRequest": { "title": "{{baseUrl}}/persons/:personId/chart/encounters/:encounterId/vitalsRequest", "example": { "heightInFeet": 1.0, "heightInInches": 1.0, "heightInTotalInches": 1.0, "heightInCentimeters": 1.0, "heightBodyPosition": "string", "heightDate": "2024-05-30T19:57:43.500Z", "heightMethod": "string", "weightInPounds": 1.0, "weightInKilograms": 1.0, "weightContext": "string", "temperatureDegreesFahrenheit": 1.0, "temperatureDegreesCelcius": 1.0, "temperatureSite": "string", "bloodPressureSystolic": 1, "bloodPressureDiastolic": 1, "bloodPressureBodyPosition": "string", "bloodPressureTargetSite": "string", "bloodPressureTargetSide": "string", "bloodPressureMethod": "string", "bloodPressureCuffSize": "string", "pulseRate": 1, "pulsePattern": "string", "respirationRate": 1, "fractionOfInspiredOxygenDeliveryMethod": "string", "fractionOfInspiredOxygenRoomAir": 1, "fractionOfInspiredOxygen": 1, "fractionOfInspiredOxygenScore": "string", "pulseOxRest": 1, "pulseOxAmb": 1, "oxygenType": "string", "oxygenLiterPerMinute": 1.0, "spO2Timing": "string", "fingerProbe": "string", "peakFlow": 1, "peakFlowTiming": "string", "peakFlowMethod": "string", "painLevel": "string", "painMethod": "string", "isUnobtainable": true, "unobtainableVital": "string", "hasPatientRefused": true, "patientRefusedVital": "string", "calculateBsa": true, "vitalSignsDate": "2024-05-30T19:57:43.500Z", "comments": "string", "performedBy": "string", "provenanceInfo": "string", "isExternalData": true }, "type": "object", "properties": { "heightInFeet": { "type": "number", "format": "double" }, "heightInInches": { "type": "number", "format": "double" }, "heightInTotalInches": { "type": "number", "format": "double" }, "heightInCentimeters": { "type": "number", "format": "double" }, "heightBodyPosition": { "type": "string" }, "heightDate": { "type": "string" }, "heightMethod": { "type": "string" }, "weightInPounds": { "type": "number", "format": "double" }, "weightInKilograms": { "type": "number", "format": "double" }, "weightContext": { "type": "string" }, "temperatureDegreesFahrenheit": { "type": "number", "format": "double" }, "temperatureDegreesCelcius": { "type": "number", "format": "double" }, "temperatureSite": { "type": "string" }, "bloodPressureSystolic": { "type": "integer", "format": "int32" }, "bloodPressureDiastolic": { "type": "integer", "format": "int32" }, "bloodPressureBodyPosition": { "type": "string" }, "bloodPressureTargetSite": { "type": "string" }, "bloodPressureTargetSide": { "type": "string" }, "bloodPressureMethod": { "type": "string" }, "bloodPressureCuffSize": { "type": "string" }, "pulseRate": { "type": "integer", "format": "int32" }, "pulsePattern": { "type": "string" }, "respirationRate": { "type": "integer", "format": "int32" }, "fractionOfInspiredOxygenDeliveryMethod": { "type": "string" }, "fractionOfInspiredOxygenRoomAir": { "type": "integer", "format": "int32" }, "fractionOfInspiredOxygen": { "type": "integer", "format": "int32" }, "fractionOfInspiredOxygenScore": { "type": "string" }, "pulseOxRest": { "type": "integer", "format": "int32" }, "pulseOxAmb": { "type": "integer", "format": "int32" }, "oxygenType": { "type": "string" }, "oxygenLiterPerMinute": { "type": "number", "format": "double" }, "spO2Timing": { "type": "string" }, "fingerProbe": { "type": "string" }, "peakFlow": { "type": "integer", "format": "int32" }, "peakFlowTiming": { "type": "string" }, "peakFlowMethod": { "type": "string" }, "painLevel": { "type": "string" }, "painMethod": { "type": "string" }, "isUnobtainable": { "type": "boolean" }, "unobtainableVital": { "type": "string" }, "hasPatientRefused": { "type": "boolean" }, "patientRefusedVital": { "type": "string" }, "calculateBsa": { "type": "boolean" }, "vitalSignsDate": { "type": "string" }, "comments": { "type": "string" }, "performedBy": { "type": "string" }, "provenanceInfo": { "type": "string" }, "isExternalData": { "type": "boolean" } }, "required": [ "heightInFeet", "heightInInches", "heightInTotalInches", "heightInCentimeters", "heightBodyPosition", "heightDate", "heightMethod", "weightInPounds", "weightInKilograms", "weightContext", "temperatureDegreesFahrenheit", "temperatureDegreesCelcius", "temperatureSite", "bloodPressureSystolic", "bloodPressureDiastolic", "bloodPressureBodyPosition", "bloodPressureTargetSite", "bloodPressureTargetSide", "bloodPressureMethod", "bloodPressureCuffSize", "pulseRate", "pulsePattern", "respirationRate", "fractionOfInspiredOxygenDeliveryMethod", "fractionOfInspiredOxygenRoomAir", "fractionOfInspiredOxygen", "fractionOfInspiredOxygenScore", "pulseOxRest", "pulseOxAmb", "oxygenType", "oxygenLiterPerMinute", "spO2Timing", "fingerProbe", "peakFlow", "peakFlowTiming", "peakFlowMethod", "painLevel", "painMethod", "isUnobtainable", "unobtainableVital", "hasPatientRefused", "patientRefusedVital", "calculateBsa", "vitalSignsDate", "comments", "performedBy", "provenanceInfo", "isExternalData" ] } }, "tags": [ { "name": "Allergies and Intolerances" }, { "name": "Assessment and Plan of Treatment" }, { "name": "Care Team Members" }, { "name": "Clinical Notes" }, { "name": "Goals" }, { "name": "Health Concerns" }, { "name": "Immunizations" }, { "name": "Implantable Device Identifiers" }, { "name": "Laboratory" }, { "name": "Medications" }, { "name": "Patient Demographics" }, { "name": "Problems" }, { "name": "Procedures" }, { "name": "Smoking Status" }, { "name": "Vital Signs" } ] }