{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["partial","admonition","tabs","tab","code-snippet"]},"type":"markdown"},"seo":{"title":"Create an authorization"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"create-an-authorization","__idx":0},"children":["Create an authorization"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This playbook is for integrators who receive authorization (prior approval) requests in another system, such as a utilization management or intake tool, and need to record them in VBA. You end up with an authorization that has its procedure and diagnosis codes attached and a status, ready for claims to be matched against it."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"This changes production data"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["VBAPI clients connect to production, so the write calls on this page create or change real records in the database you name in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["vbasoftware-database"]},". Try the steps in a non-production database first if VBA has given you one, use clearly fake values while you test, and keep the \"Check it worked\" calls, which only read data. \"Try it\" in the API reference also calls production."]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Who this is for"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Utilization management and care management integrators"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Time to run"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["About 10 minutes"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Writes data?"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes. Every step except the read-back creates or changes a record. Try it in a non-production database first if you have one; \"Try it\" in the API reference also calls production."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Endpoints used"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["8"]}]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Before you start"},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You have completed the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/developer-portal/get-started/quick-start"},"children":["quick start"]}," and can get an ID token."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The member already exists. You need their ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subscriber_ID"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["member_Seq"]}," (see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/developer-portal/concepts/ids-and-conventions"},"children":["IDs, keys and field names"]},"). Check it with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /subscribers/{subscriberID}/members/{memberSeq}"]}," first: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /auths"]}," does not reject a member that does not exist."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The provider already exists. You need VBA's internal ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["provider_ID"]},", not the provider's NPI."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The procedure code, diagnosis code, and auth code you plan to use are configured in your database. The lookups in step 1 show you how to check."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Your API user has rights to the authorization screens. Which security areas that requires needs confirmation with VBA."]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"how-it-fits-together","__idx":1},"children":["How it fits together"]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"sequenceDiagram\n participant App as Your system\n participant API as VBAPI\n App->>API: POST /auths\n API-->>App: Auth with generated auth_Number\n App->>API: POST /auths/{authNumber}/procedure-codes\n App->>API: POST /auths/{authNumber}/diagnostic-codes\n App->>API: GET /auths/{authNumber} (plus code lists)\n API-->>App: The saved authorization\n App->>API: POST /auths/{authNumber}/process-status/{newAuthCode}\n API-->>App: Auth with new auth_Code and status\n","diagramHtml":"VBAPIYour systemVBAPIYour systemPOST /authsAuth with generated auth_NumberPOST /auths/{authNumber}/procedure-codesPOST /auths/{authNumber}/diagnostic-codesGET /auths/{authNumber} (plus code lists)The saved authorizationPOST /auths/{authNumber}/process-status/{newAuthCode}Auth with new auth_Code and status","diagramHtmlDark":"VBAPIYour systemVBAPIYour systemPOST /authsAuth with generated auth_NumberPOST /auths/{authNumber}/procedure-codesPOST /auths/{authNumber}/diagnostic-codesGET /auths/{authNumber} (plus code lists)The saved authorizationPOST /auths/{authNumber}/process-status/{newAuthCode}Auth with new auth_Code and status"},"children":["sequenceDiagram\n participant App as Your system\n participant API as VBAPI\n App->>API: POST /auths\n API-->>App: Auth with generated auth_Number\n App->>API: POST /auths/{authNumber}/procedure-codes\n App->>API: POST /auths/{authNumber}/diagnostic-codes\n App->>API: GET /auths/{authNumber} (plus code lists)\n API-->>App: The saved authorization\n App->>API: POST /auths/{authNumber}/process-status/{newAuthCode}\n API-->>App: Auth with new auth_Code and status\n"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The samples read your credentials from environment variables:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The samples read your credentials from environment variables, so nothing secret is written into code. Set them in the terminal you run the samples from:"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"PowerShell","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"powershell","header":{"controls":{"copy":{}}},"source":"$env:VBAPI_BASE_URL = \"https://vbapi.vbasoftware.com/vbasoftware\"\n$env:VBAPI_API_KEY = \"your-api-key\"\n$env:VBAPI_CLIENT_ID = \"your-client-id\"\n$env:VBAPI_CLIENT_CODE = \"your-client-code\"\n$env:VBAPI_DATABASE = \"YOUR_DATABASE\"\n$env:VBAPI_USERNAME = \"your-api-username\"\n$env:VBAPI_PASSWORD = \"your-api-password\"\n$env:VBAPI_USER_AGENT = \"YourCompany-Integration/1.0\"\n","lang":"powershell"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"bash","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"export VBAPI_BASE_URL=\"https://vbapi.vbasoftware.com/vbasoftware\"\nexport VBAPI_API_KEY=\"your-api-key\"\nexport VBAPI_CLIENT_ID=\"your-client-id\"\nexport VBAPI_CLIENT_CODE=\"your-client-code\"\nexport VBAPI_DATABASE=\"YOUR_DATABASE\"\nexport VBAPI_USERNAME=\"your-api-username\"\nexport VBAPI_PASSWORD=\"your-api-password\"\nexport VBAPI_USER_AGENT=\"YourCompany-Integration/1.0\"\n","lang":"bash"},"children":[]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In production code, load these from your secrets manager instead."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"steps","__idx":2},"children":["Steps"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"1-check-your-codes","__idx":3},"children":["1. Check your codes"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The authorization refers to codes that must already exist in your database. Look them up before you build the request:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Procedure codes: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/procedure-codes/listprocedurecode"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /procedure-codes"]}]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Diagnosis codes: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/diagnostic-codes/listdiagnosticcode"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /diagnostic-codes"]}]},", and the code types (the ICD version) with ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/diagnostic-code-types/listdiagnosticcodetype"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /diagnostic-code-types"]}]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Authorization types, if you set ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["auth_Type"]},": ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/auth-types/listauthtype"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /auth-types"]}]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The auth code you will apply in step 6: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/auth-code/getauthcode"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /auth-codes/{authCode}"]}]},". There is no list operation for auth codes, so get the codes your database uses from your VBA administrator."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The samples keep these values in constants at the top of the file. The codes shown (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["99213"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Z0000"]},", diagnosis code type ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["0"]},", auth code ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DOCS-A"]},") are placeholders; replace them with codes from your own database."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"2-create-the-authorization","__idx":4},"children":["2. Create the authorization"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/auth/createauth"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /auths"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Send the six required fields plus the member, provider, and requested dates and units. Five of the required fields are booleans that the database defaults to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},"; send ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]}," unless you know otherwise. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tPlan_Printed"]}," is a one-character string, not a boolean; the database default is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"0\""]},". Do not send ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["auth_Number"]},": the API generates it."]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"C#","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/create-authorization/CreateAuthorization.cs","language":"csharp","header":{"controls":{"copy":{}}},"lang":"csharp","source":" var auth = new Dictionary\n {\n // Required by the Auth schema. The server generates auth_Number, so do not send it.\n [\"closed\"] = false,\n [\"new_Or_Extended\"] = false,\n [\"previous_Treatment\"] = false,\n [\"tPlan_DownLoaded\"] = false,\n [\"tPlan_Printed\"] = \"0\", // a one-character string, not a boolean\n [\"urgent\"] = false,\n // The member and provider the request is for.\n [\"subscriber_ID\"] = SubscriberId,\n [\"member_Seq\"] = MemberSeq,\n [\"provider_ID\"] = ProviderId,\n [\"requested_From\"] = \"2030-01-15T00:00:00\",\n [\"requested_Thru\"] = \"2030-03-15T00:00:00\",\n [\"units_Requested\"] = 6,\n [\"notes\"] = \"DOCS sample authorization\",\n };\n var created = await api.PostAsync(\"/auths\", auth);\n var authNumber = created.Data![\"auth_Number\"]!.GetValue();\n Console.WriteLine($\"Created auth {authNumber}\");\n "},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Python","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/create-authorization/create_authorization.py","language":"python","header":{"controls":{"copy":{}}},"lang":"python","source":" auth = {\n # Required by the Auth schema. The server generates auth_Number, so do not send it.\n \"closed\": False,\n \"new_Or_Extended\": False,\n \"previous_Treatment\": False,\n \"tPlan_DownLoaded\": False,\n \"tPlan_Printed\": \"0\", # a one-character string, not a boolean\n \"urgent\": False,\n # The member and provider the request is for.\n \"subscriber_ID\": SUBSCRIBER_ID,\n \"member_Seq\": MEMBER_SEQ,\n \"provider_ID\": PROVIDER_ID,\n \"requested_From\": \"2030-01-15T00:00:00\",\n \"requested_Thru\": \"2030-03-15T00:00:00\",\n \"units_Requested\": 6,\n \"notes\": \"DOCS sample authorization\",\n }\n created = api.post(\"/auths\", auth)\n auth_number = created.data[\"auth_Number\"]\n print(f\"Created auth {auth_number}\")\n "},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"TypeScript","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/create-authorization/createAuthorization.ts","language":"typescript","header":{"controls":{"copy":{}}},"lang":"typescript","source":" const auth = {\n // Required by the Auth schema. The server generates auth_Number, so do not send it.\n closed: false,\n new_Or_Extended: false,\n previous_Treatment: false,\n tPlan_DownLoaded: false,\n tPlan_Printed: \"0\", // a one-character string, not a boolean\n urgent: false,\n // The member and provider the request is for.\n subscriber_ID: SUBSCRIBER_ID,\n member_Seq: MEMBER_SEQ,\n provider_ID: PROVIDER_ID,\n requested_From: \"2030-01-15T00:00:00\",\n requested_Thru: \"2030-03-15T00:00:00\",\n units_Requested: 6,\n notes: \"DOCS sample authorization\",\n };\n const created = await api.post(\"/auths\", auth);\n const authNumber: string = created.data.auth_Number;\n console.log(`Created auth ${authNumber}`);\n "},"children":[]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The request body, as JSON:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"closed\": false,\n \"new_Or_Extended\": false,\n \"previous_Treatment\": false,\n \"tPlan_DownLoaded\": false,\n \"tPlan_Printed\": \"0\",\n \"urgent\": false,\n \"subscriber_ID\": \"DOCS-0001\",\n \"member_Seq\": \"02\",\n \"provider_ID\": \"DOCS-PRV1\",\n \"requested_From\": \"2030-01-15T00:00:00\",\n \"requested_Thru\": \"2030-03-15T00:00:00\",\n \"units_Requested\": 6,\n \"notes\": \"DOCS sample authorization\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The full field list is in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Auth"]}," schema on the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/auth/createauth"},"children":["reference page"]},". Which other fields a simple outpatient request needs (for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["auth_Type"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["service_Type"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["treatment_Type"]},") depends on how your authorization screens are configured; check with your VBA administrator."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Save from the response:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.auth_Number"]}," (used as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["authNumber"]}," in every later step)."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Check it worked:"]}," the response is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," with the new authorization in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]},". Creates return ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]},", not ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["201"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"3-add-the-requested-procedures","__idx":5},"children":["3. Add the requested procedures"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/auth-procedure-codes/createauthproccode"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /auths/{authNumber}/procedure-codes"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Add one procedure line per call. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["auth_Number"]}," in the body must match the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["authNumber"]}," in the path, or the API rejects the request. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["authProcCodes_Key"]}," is required by the schema but is assigned by the database, so send ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["0"]},"."]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"C#","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/create-authorization/CreateAuthorization.cs","language":"csharp","header":{"controls":{"copy":{}}},"lang":"csharp","source":" var procedure = new Dictionary\n {\n [\"authProcCodes_Key\"] = 0, // identity column; the server assigns the key\n [\"auth_Number\"] = authNumber, // must match the path\n [\"exclude_Modifier_Match\"] = false,\n [\"procedure_Code\"] = ProcedureCode,\n [\"units_Requested\"] = 6,\n };\n var addedProcedure = await api.PostAsync($\"/auths/{authNumber}/procedure-codes\", procedure);\n Console.WriteLine($\"Added procedure line {addedProcedure.Data?[\"authProcCodes_Key\"]}\");\n "},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Python","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/create-authorization/create_authorization.py","language":"python","header":{"controls":{"copy":{}}},"lang":"python","source":" procedure = {\n \"authProcCodes_Key\": 0, # identity column; the server assigns the key\n \"auth_Number\": auth_number, # must match the path\n \"exclude_Modifier_Match\": False,\n \"procedure_Code\": PROCEDURE_CODE,\n \"units_Requested\": 6,\n }\n added_procedure = api.post(f\"/auths/{auth_number}/procedure-codes\", procedure)\n print(f\"Added procedure line {added_procedure.data['authProcCodes_Key']}\")\n "},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"TypeScript","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/create-authorization/createAuthorization.ts","language":"typescript","header":{"controls":{"copy":{}}},"lang":"typescript","source":" const procedure = {\n authProcCodes_Key: 0, // identity column; the server assigns the key\n auth_Number: authNumber, // must match the path\n exclude_Modifier_Match: false,\n procedure_Code: PROCEDURE_CODE,\n units_Requested: 6,\n };\n const addedProcedure = await api.post(`/auths/${authNumber}/procedure-codes`, procedure);\n console.log(`Added procedure line ${addedProcedure.data.authProcCodes_Key}`);\n "},"children":[]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["exclude_Modifier_Match"]}," controls claim matching: when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},", adjudication does not require the claim's procedure modifiers to match ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["modifier1"]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["modifier4"]}," on this line."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Save from the response:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.authProcCodes_Key"]},", if you will update or delete the line later."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"4-add-the-diagnoses","__idx":6},"children":["4. Add the diagnoses"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/auth-diagnostic-codes/createauthdiagcode"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /auths/{authNumber}/diagnostic-codes"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Add one diagnosis per call. The required fields are ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["auth_Number"]}," (matching the path), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["diagnostic_Code"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["diagnostic_Code_Type"]}," (the ICD version, from step 1), and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["disable_Provider_Match"]},"."]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"C#","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/create-authorization/CreateAuthorization.cs","language":"csharp","header":{"controls":{"copy":{}}},"lang":"csharp","source":" var diagnosis = new Dictionary\n {\n [\"auth_Number\"] = authNumber, // must match the path\n [\"diagnostic_Code\"] = DiagnosticCode,\n [\"diagnostic_Code_Type\"] = DiagnosticCodeType,\n [\"disable_Provider_Match\"] = false,\n [\"primary_Diag\"] = \"Y\",\n };\n await api.PostAsync($\"/auths/{authNumber}/diagnostic-codes\", diagnosis);\n "},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Python","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/create-authorization/create_authorization.py","language":"python","header":{"controls":{"copy":{}}},"lang":"python","source":" diagnosis = {\n \"auth_Number\": auth_number, # must match the path\n \"diagnostic_Code\": DIAGNOSTIC_CODE,\n \"diagnostic_Code_Type\": DIAGNOSTIC_CODE_TYPE,\n \"disable_Provider_Match\": False,\n \"primary_Diag\": \"Y\",\n }\n api.post(f\"/auths/{auth_number}/diagnostic-codes\", diagnosis)\n "},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"TypeScript","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/create-authorization/createAuthorization.ts","language":"typescript","header":{"controls":{"copy":{}}},"lang":"typescript","source":" const diagnosis = {\n auth_Number: authNumber, // must match the path\n diagnostic_Code: DIAGNOSTIC_CODE,\n diagnostic_Code_Type: DIAGNOSTIC_CODE_TYPE,\n disable_Provider_Match: false,\n primary_Diag: \"Y\",\n };\n await api.post(`/auths/${authNumber}/diagnostic-codes`, diagnosis);\n "},"children":[]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The diagnosis key is the combination of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["auth_Number"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["diagnostic_Code"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["diagnostic_Code_Type"]},", so adding the same code and type twice to one authorization fails."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"5-read-it-back","__idx":7},"children":["5. Read it back"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/auth/getauth"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /auths/{authNumber}"]}]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/auth-procedure-codes/listauthproccodebyauth"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /auths/{authNumber}/procedure-codes"]}]},", and ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/auth-diagnostic-codes/getauthdiagcodelist"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /auths/{authNumber}/diagnostic-codes"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These calls only read data. Use them to confirm what was saved before you change the status."]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"C#","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/create-authorization/CreateAuthorization.cs","language":"csharp","header":{"controls":{"copy":{}}},"lang":"csharp","source":" var saved = (await api.GetAsync($\"/auths/{authNumber}\")).Data!;\n var procedures = (await api.GetAsync($\"/auths/{authNumber}/procedure-codes\")).Data?.AsArray().Count ?? 0;\n var diagnoses = (await api.GetAsync($\"/auths/{authNumber}/diagnostic-codes\")).Data?.AsArray().Count ?? 0;\n Console.WriteLine($\"Auth {saved[\"auth_Number\"]}: status={saved[\"status\"]} procedures={procedures} diagnoses={diagnoses}\");\n "},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Python","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/create-authorization/create_authorization.py","language":"python","header":{"controls":{"copy":{}}},"lang":"python","source":" saved = api.get(f\"/auths/{auth_number}\").data\n procedures = api.get(f\"/auths/{auth_number}/procedure-codes\").data or []\n diagnoses = api.get(f\"/auths/{auth_number}/diagnostic-codes\").data or []\n print(f\"Auth {saved['auth_Number']}: status={saved.get('status')} \"\n f\"procedures={len(procedures)} diagnoses={len(diagnoses)}\")\n "},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"TypeScript","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/create-authorization/createAuthorization.ts","language":"typescript","header":{"controls":{"copy":{}}},"lang":"typescript","source":" const saved = (await api.get(`/auths/${authNumber}`)).data;\n const procedures = (await api.get(`/auths/${authNumber}/procedure-codes`)).data ?? [];\n const diagnoses = (await api.get(`/auths/${authNumber}/diagnostic-codes`)).data ?? [];\n console.log(`Auth ${saved.auth_Number}: status=${saved.status} procedures=${procedures.length} diagnoses=${diagnoses.length}`);\n "},"children":[]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example response from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /auths/{authNumber}"]}," (illustrative; field values are fake, and most of the 94 fields are omitted):"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"data\": {\n \"auth_Number\": \"DOCS-0000001\",\n \"subscriber_ID\": \"DOCS-0001\",\n \"member_Seq\": \"02\",\n \"provider_ID\": \"DOCS-PRV1\",\n \"requested_From\": \"2030-01-15T00:00:00\",\n \"requested_Thru\": \"2030-03-15T00:00:00\",\n \"units_Requested\": 6,\n \"auth_Code\": null,\n \"status\": null,\n \"closed\": false,\n \"new_Or_Extended\": false,\n \"previous_Treatment\": false,\n \"tPlan_DownLoaded\": false,\n \"tPlan_Printed\": \"0\",\n \"urgent\": false\n },\n \"error\": null,\n \"debug\": { \"activityID\": \"00000000-0000-0000-0000-000000000000\" }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"6-change-the-status","__idx":8},"children":["6. Change the status"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/adv.-auth/authprocessstatus"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /auths/{authNumber}/process-status/{newAuthCode}"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This call has no body. The API looks up ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["newAuthCode"]}," in your database's auth codes and then updates the authorization:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["auth_Code"]}," is set to the code, and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}," to that code's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["auth_Action"]}," (for example approved, denied, pended, or voided)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["approved_By"]}," is set to your API user and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["approved_Date"]}," to the current time."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If the code's action is denied or voided, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["units_Approved"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["amount_Approved"]}," are reset to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["0"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An unknown code fails, so the samples check it with ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/auth-code/getauthcode"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /auth-codes/{authCode}"]}]}," first."]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"C#","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/create-authorization/CreateAuthorization.cs","language":"csharp","header":{"controls":{"copy":{}}},"lang":"csharp","source":" System.Text.Json.Nodes.JsonNode code;\n try\n {\n code = (await api.GetAsync($\"/auth-codes/{NewAuthCode}\")).Data!;\n }\n catch (VbapiException ex)\n {\n Console.WriteLine($\"Auth code {NewAuthCode} is not configured: {ex.Message}\");\n return;\n }\n Console.WriteLine($\"Applying {code[\"auth_Code\"]} (action {code[\"auth_Action\"]}: {code[\"description\"]})\");\n var updated = (await api.PostAsync($\"/auths/{authNumber}/process-status/{NewAuthCode}\")).Data!;\n Console.WriteLine($\"Auth {authNumber}: auth_Code={updated[\"auth_Code\"]} status={updated[\"status\"]} approved_By={updated[\"approved_By\"]}\");\n "},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Python","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/create-authorization/create_authorization.py","language":"python","header":{"controls":{"copy":{}}},"lang":"python","source":" try:\n code = api.get(f\"/auth-codes/{NEW_AUTH_CODE}\").data\n except VbapiError as error:\n print(f\"Auth code {NEW_AUTH_CODE} is not configured: {error}\")\n return\n print(f\"Applying {code['auth_Code']} (action {code.get('auth_Action')}: {code.get('description')})\")\n updated = api.post(f\"/auths/{auth_number}/process-status/{NEW_AUTH_CODE}\").data\n print(f\"Auth {auth_number}: auth_Code={updated.get('auth_Code')} status={updated.get('status')} \"\n f\"approved_By={updated.get('approved_By')}\")\n "},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"TypeScript","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/create-authorization/createAuthorization.ts","language":"typescript","header":{"controls":{"copy":{}}},"lang":"typescript","source":" let code;\n try {\n code = (await api.get(`/auth-codes/${NEW_AUTH_CODE}`)).data;\n } catch (error) {\n if (!(error instanceof VbapiError)) throw error;\n console.log(`Auth code ${NEW_AUTH_CODE} is not configured: ${error.message}`);\n return;\n }\n console.log(`Applying ${code.auth_Code} (action ${code.auth_Action}: ${code.description})`);\n const updated = (await api.post(`/auths/${authNumber}/process-status/${NEW_AUTH_CODE}`)).data;\n console.log(`Auth ${authNumber}: auth_Code=${updated.auth_Code} status=${updated.status} approved_By=${updated.approved_By}`);\n "},"children":[]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The status change does not set the approved dates or approved units. If your process records them (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["approved_From"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["approved_Thru"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["units_Approved"]},"), set them with ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/auth/updateauth"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT /auths/{authNumber}"]}]},". Whether they are required for your workflow needs confirmation with an SME."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Check it worked:"]}," the response ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.auth_Code"]}," equals the code you sent."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"verify-the-result","__idx":9},"children":["Verify the result"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Call ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/auth/getauth"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /auths/{authNumber}"]}]}," again. You should see your ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["auth_Code"]},", the matching ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]},", your API user in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["approved_By"]},", and today's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["approved_Date"]},". The procedure and diagnosis lists from step 5 should each contain the lines you added."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"how-a-claim-finds-this-authorization","__idx":10},"children":["How a claim finds this authorization"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["VBA scores candidate authorizations for each claim line in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CLAIMBATCHAUTHMATCH"]}," view (also available as a ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/developer-portal/reference/search-config-reference"},"children":["SearchConfig"]},"). For the claim's member, each authorization gets a point for each of these matches:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Provider:"]}," the authorization's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["provider_ID"]}," is the claim's provider."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Diagnosis:"]}," one of the claim's diagnosis codes, with the same code type, is on the authorization, or the authorization has no diagnoses."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Procedure:"]}," the claim line's procedure code and modifiers match a procedure line, or the authorization has no procedure lines."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Date:"]}," the service date falls between ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["approved_From"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["approved_Thru"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Separately, two flags tell adjudication what it may ignore when it assigns an authorization automatically: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["exclude_Modifier_Match"]}," on a procedure line (do not require the modifiers to match) and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["disable_Provider_Match"]}," on a diagnosis line (do not require the diagnosis to match). How adjudication combines these to choose an authorization needs confirmation with an SME."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"common-errors","__idx":11},"children":["Common errors"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Symptom"},"children":["Symptom"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Likely cause"},"children":["Likely cause"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Fix"},"children":["Fix"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]}," or validation error naming a required field on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /auths"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["One of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["closed"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["new_Or_Extended"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["previous_Treatment"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tPlan_DownLoaded"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tPlan_Printed"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["urgent"]}," is missing, or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tPlan_Printed"]}," was sent as a boolean."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Send all six; send ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tPlan_Printed"]}," as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"0\""]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Error that ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["auth_Number"]}," does not match ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["authNumber"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The body's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["auth_Number"]}," differs from the path on a procedure or diagnosis call."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["auth_Number"]}," from step 2 in both places."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404"]}," from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["process-status"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The auth code is not configured in your database, or the auth number is wrong."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Check the code with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /auth-codes/{authCode}"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Error adding a diagnosis"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The same ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["diagnostic_Code"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["diagnostic_Code_Type"]}," are already on this authorization."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read the list first with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /auths/{authNumber}/diagnostic-codes"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Contacting support"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Send VBA support:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["debug.activityID"]}," from the response"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["the date and time of the call, with time zone"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["the method and path, for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /claim-batches"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["the full ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["error"]}," object from the response"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["the request body, with passwords, tokens, and personal data removed"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Never send your password, API key, or tokens. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/developer-portal/help/support"},"children":["Support and escalation"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"variations","__idx":12},"children":["Variations"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Many authorizations at once:"]}," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/auth/createorupdateauthbatch"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT /auths"]}]}," takes an array of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Auth"]}," objects. Items without ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["auth_Number"]}," are created and items with one are updated. It returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["207"]}," with one result per item, so check each item's status. For codes, use ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/auth-procedure-codes/createauthproccodebatch"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /auths/{authNumber}/procedure-codes-batch"]}]}," and ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/auth-diagnostic-codes/updateauthdiagcodebatch"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT /auths/{authNumber}/diagnostic-codes-batch"]}]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Adjust an approved authorization:"]}," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/adv.-auth/authadjustment"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /auths/{authNumber}/adjust"]}]}," creates a new authorization from the original with new approved dates, can copy its procedure and diagnosis codes, shortens the original's approval if the dates overlap, and links the two with an adjustment reference. It returns the new authorization."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Link related authorizations:"]}," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/auth-reference/createauthreference"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /auths/{originalAuthNumber}/references"]}]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Safe to re-run?"]}," No. Each run of step 2 creates a new authorization with a new ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["auth_Number"]},". To avoid duplicates, store the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["auth_Number"]}," against your own request ID, and check for it before creating. To remove a test authorization, use ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/auth/deleteauth"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE /auths/{authNumber}"]}]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"download","__idx":13},"children":["Download"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The full runnable samples are in the portal repository under ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["_samples/playbooks/create-authorization/"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CreateAuthorization.cs"]}," (run with the shared C# runner as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CreateAuthorizationPlaybook"]},"), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["create_authorization.py"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["createAuthorization.ts"]},". Each uses the shared client helper for its language."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"related","__idx":14},"children":["Related"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Concepts: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/developer-portal/concepts/data-model"},"children":["Data model"]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/developer-portal/concepts/ids-and-conventions"},"children":["IDs, keys and field names"]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/developer-portal/concepts/errors"},"children":["Errors and troubleshooting"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Next playbook: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/developer-portal/playbooks/claims-intake-and-adjudication"},"children":["Enter claims and adjudicate them"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Terms: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/developer-portal/reference/glossary"},"children":["Glossary"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Ask the AI: \"Using the Create an authorization playbook, write a Python function that creates an authorization with one procedure code and one diagnosis code.\""]}]}]},"headings":[{"value":"Create an authorization","id":"create-an-authorization","depth":1},{"value":"How it fits together","id":"how-it-fits-together","depth":2},{"value":"Steps","id":"steps","depth":2},{"value":"1. Check your codes","id":"1-check-your-codes","depth":3},{"value":"2. Create the authorization","id":"2-create-the-authorization","depth":3},{"value":"3. Add the requested procedures","id":"3-add-the-requested-procedures","depth":3},{"value":"4. Add the diagnoses","id":"4-add-the-diagnoses","depth":3},{"value":"5. Read it back","id":"5-read-it-back","depth":3},{"value":"6. Change the status","id":"6-change-the-status","depth":3},{"value":"Verify the result","id":"verify-the-result","depth":2},{"value":"How a claim finds this authorization","id":"how-a-claim-finds-this-authorization","depth":2},{"value":"Common errors","id":"common-errors","depth":2},{"value":"Variations","id":"variations","depth":2},{"value":"Download","id":"download","depth":2},{"value":"Related","id":"related","depth":2}],"frontmatter":{"title":"Create an authorization","description":"Create a prior authorization for a member, attach its procedure and diagnosis codes, read it back, and set its status with VBAPI.","seo":{"title":"Create an authorization"}},"lastModified":"2026-10-26T21:09:33.693Z","pagePropGetterError":{"message":"","name":""}},"slug":"/developer-portal/playbooks/create-authorization","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}