{"openapi":"3.0.0","info":{"title":"Eirly Health REST Api","description":"This swagger document details the endpoints for v1 of the api. \n\nMinor updares and patches will likely be applied to this api in future, but they will never be breaking changes.\n\nA new version of the api will be released should breaking changes be required. If you wish to pick a specific minor or patch version, please provide the preference via the accept header in the form:\n\n`Accept: application/vnd.bgt.v1.x.x+json` where the v1.x.x specifies the minor and patch versions.\n      \n\n\n\n## IMPORTANT\nIf you would like to order tests other than blood tests, you will need to pass the following Accept Header: ` Accept: application/vnd.bgt.v1.1.0+json`.\nThis change will change the behaviour of the `POST /referrals` endpoint to return a list of referrals, rather than a single referral.","contact":{"name":"Eirly Health","url":"","email":"support@eirly.health"},"termsOfService":"","version":"1.0.0"},"servers":[{"url":"https://api.eirly.health/v1","description":"base url"}],"security":[{"oauth":[]}],"components":{"securitySchemes":{"oauth":{"type":"oauth2","scheme":"oauth2","description":"This API uses OAuth 2 with the implicit grant flow.","flows":{"clientCredentials":{"tokenUrl":"https://auth.eirly.health/oauth/token","refreshUrl":"https://auth.eirly.health/oauth/token"}}}},"schemas":{"Address":{"description":"Address","required":["addressLine1","city","state","country"],"type":"object","properties":{"addressLine1":{"description":"Address line","type":"string"},"addressLine2":{"description":"Secondary address line","type":"string"},"city":{"description":"City","type":"string"},"state":{"description":"State","type":"string"},"postCode":{"description":"Postcode","type":"string"},"country":{"description":"Country","type":"string"}}},"OrderingPractitioner":{"description":"Ordering practitioner (required when ordering bulk-billed / Medicare tests)","required":["name","address","providerNumber"],"type":"object","properties":{"name":{"description":"Ordering doctor's full name","type":"string"},"address":{"description":"Ordering doctor's address","type":"string"},"providerNumber":{"description":"Medicare provider number (8 characters)","type":"string"}}},"ReferralCreateRequest":{"description":"Create Referral request body","required":["firstName","lastName","email","address","dob","gender","phone","referenceNumber"],"type":"object","properties":{"firstName":{"description":"Users first name","type":"string"},"lastName":{"description":"Users last name","type":"string"},"email":{"description":"Users email","type":"string"},"address":{"description":"Users street address","$ref":"#/components/schemas/Address"},"dob":{"description":"Users date of birth in ISO 8601 format YYYY-MM-DD (eg: 1980-01-01)","type":"string"},"gender":{"description":"Users gender","type":"string","enum":["male","female"]},"phone":{"description":"Users phone number","type":"string"},"tests":{"description":"Tests requested. One of tests, bundleId, or bulkBilledTests must be provided.","type":"array","items":{"type":"string"}},"bundleId":{"description":"Bundle to order (v1.1.0+). One of tests, bundleId, or bulkBilledTests must be provided.","type":"string"},"emailReferralToCustomer":{"description":"Whether to email the referral to the customer (default: true). If false, you are responsible for delivering the referral.","type":"boolean"},"referenceNumber":{"description":"Reference number","type":"string"},"metadata":{"description":"An object of meta data that can be stored against the referral","type":"object"},"bulkBilledTests":{"description":"Tests to order as bulk-billed (Medicare). Requires v1.1.0+ and produces a separate bulk-billed referral. When provided, orderingPractitioner and medicareCardNumber are required.","type":"array","items":{"type":"string"}},"orderingPractitioner":{"description":"The ordering doctor (required when bulkBilledTests is provided)","$ref":"#/components/schemas/OrderingPractitioner"},"medicareCardNumber":{"description":"Patient Medicare card number, 10 digits (optionally + IRN). Required when bulkBilledTests is provided.","type":"string"},"dvaNumber":{"description":"Patient DVA file number (optional)","type":"string"},"clinicalNotes":{"description":"The ordering doctor's clinical notes for the bulk-billed referral","type":"string"}}},"ReferralUpdateRequest":{"description":"Update Referral request body","type":"object","properties":{"firstName":{"description":"Users first name","type":"string"},"lastName":{"description":"Users last name","type":"string"},"email":{"description":"Users email","type":"string"},"address":{"description":"Users street address","$ref":"#/components/schemas/Address"},"dob":{"description":"Users date of birth in ISO 8601 format YYYY-MM-DD (eg: 1980-01-01)","type":"string"},"gender":{"description":"Users gender","type":"string","enum":["male","female"]},"phone":{"description":"Users phone number","type":"string"},"metadata":{"description":"Metadata to merge with existing metadata. Set a key to null to remove it.","type":"object"}}},"Referral":{"description":"Referral","type":"object","properties":{"uuid":{"description":"Referral uuid","type":"string"},"status":{"description":"Referral status","type":"string"},"object":{"description":"The type of object, will always be 'referral'","type":"string"},"person":{"description":"The person details","$ref":"#/components/schemas/Person"},"tests":{"description":"Tests requested","type":"array","items":{"type":"string"}},"bundleId":{"description":"Bundle for purchase","type":"string"},"referenceNumber":{"description":"Reference number","type":"string"},"productId":{"description":"The product ID associated with the referral","nullable":true,"type":"string"},"productName":{"description":"The product name associated with the referral","nullable":true,"type":"string"},"origin":{"description":"The origin of the referral","nullable":true,"type":"string"},"emailSentAt":{"description":"Email sent at","nullable":true,"type":"string"},"referralType":{"description":"The type of referral","type":"string"},"createdAt":{"description":"Time the referral was created","type":"string"},"resultsUuid":{"description":"Results uuid","nullable":true,"type":"string"},"metadata":{"description":"An object of meta data that can be stored against the referral","type":"object"},"bulkBilled":{"description":"Whether this referral was issued as bulk-billed (Medicare)","type":"boolean"},"orderingPractitioner":{"description":"The ordering doctor (bulk-billed referrals only)","$ref":"#/components/schemas/OrderingPractitioner"},"medicareCardNumber":{"description":"Patient Medicare card number (bulk-billed referrals only)","nullable":true,"type":"string"},"dvaNumber":{"description":"Patient DVA file number (bulk-billed referrals only)","nullable":true,"type":"string"},"orderingPractitionerClinicalNotes":{"description":"The ordering doctor's clinical notes (bulk-billed referrals only)","nullable":true,"type":"string"}}},"Person":{"description":"Person","type":"object","properties":{"firstName":{"description":"Person's first name","type":"string"},"lastName":{"description":"Person's last name","type":"string"},"email":{"description":"Person's email","type":"string"},"address":{"description":"Person's street address","$ref":"#/components/schemas/Address"},"dob":{"description":"Person's date of birth in ISO 8601 format YYYY-MM-DD (eg: 1980-01-01)","type":"string"},"gender":{"description":"Person's gender","type":"string","enum":["male","female"]},"phone":{"description":"Person's phone number","type":"string"}}},"Doctor":{"description":"Doctor","type":"object","properties":{"uuid":{"description":"Doctor uuid","type":"string"},"firstName":{"description":"Doctor's first name","type":"string"},"lastName":{"description":"Doctor's last name","type":"string"}}},"Result":{"description":"Result","type":"object","properties":{"uuid":{"description":"Result uuid","type":"string"},"referralUuid":{"description":"Referral uuid","type":"string"},"status":{"description":"status of result","type":"string","enum":["COMPLETE","IN_REVIEW","CREATED"]},"object":{"description":"The type of object, will always be 'result'","type":"string"},"person":{"description":"The person details","$ref":"#/components/schemas/Person"},"referenceNumber":{"description":"Reference number from the referral request","type":"string"},"productId":{"description":"The product ID associated with the result","nullable":true,"type":"string"},"productName":{"description":"The product name associated with the result","nullable":true,"type":"string"},"updatedAt":{"description":"Time the results were update","type":"string"},"resultDate":{"description":"Time the results were created","type":"string"},"reviewedBy":{"description":"If set, the dr who reviewed the results","nullable":true,"$ref":"#/components/schemas/Doctor"},"biomarkers":{"description":"List of biomarkers","type":"array","items":{"$ref":"#/components/schemas/Biomarker"}},"metadata":{"description":"An object of meta data that can be stored against the referral","type":"object"}}},"AdditionalRange":{"description":"AdditionalRange","type":"object","properties":{"id":{"description":"identifier for the range (e.g. cycle phase key)","type":"string"},"name":{"description":"human-readable name for the range","type":"string"},"category":{"description":"category of the range (e.g. \"female-hormone\")","type":"string"},"lowRange":{"description":"lower bound of the range","nullable":true,"type":"number"},"highRange":{"description":"upper bound of the range","nullable":true,"type":"number"}}},"Biomarker":{"description":"Biomarker","type":"object","properties":{"id":{"description":"biomarker id","type":"string"},"name":{"description":"the name of the biomarker","type":"string"},"commonName":{"description":"the more common name for the biomarker","type":"string"},"description":{"description":"info about the biomarker","type":"string"},"value":{"description":"the value of the biomarker","type":"string"},"refIntervalHigh":{"description":"the value of the upper reference interval","nullable":true,"type":"number"},"refIntervalLow":{"description":"the value of the lower reference interval","nullable":true,"type":"number"},"additionalRanges":{"description":"optional additional reference ranges (e.g. cycle-phase ranges for female hormones). Only set on numeric biomarkers that have them.","type":"array","items":{"$ref":"#/components/schemas/AdditionalRange"}},"unit":{"description":"the unit of the biomarker","type":"string"},"formattedValue":{"description":"formated version of the biomarker","type":"string"},"category":{"description":"the category for the biomarker","$ref":"#/components/schemas/BiomarkerCategory"},"isAbnormal":{"description":"if the result is abnormal","nullable":true,"type":"boolean"}}},"BiomarkerCategory":{"description":"BiomarkerCategory","type":"object","properties":{"id":{"description":"biomarker category id","type":"string"},"name":{"description":"the name of the biomarker category","type":"string"},"description":{"description":"info about the biomarker category","type":"string"}}},"TurnAroundTime":{"description":"TurnAroundTime","type":"object","properties":{"minimumDays":{"description":"minimum days the test will take","type":"string"},"maximumDays":{"description":"maximum days the test will take","type":"string"},"object":{"description":"The type of object, will always be 'turnaroundTime'","type":"string"}}},"ProviderTurnAroundTime":{"description":"ProviderTurnAroundTime","type":"object","properties":{"providerId":{"description":"the provider id","type":"string"},"providerName":{"description":"the provider name","type":"string"},"minimumDays":{"description":"minimum days the test will take","type":"string"},"maximumDays":{"description":"maximum days the test will take","type":"string"},"object":{"description":"The type of object, will always be 'providerTurnaroundTime'","type":"string"}}},"Test":{"description":"Test","type":"object","properties":{"id":{"description":"test id","type":"string"},"name":{"description":"the name of the test","type":"string"},"shortName":{"description":"short name for the test","type":"string"},"object":{"description":"The type of object, will always be 'test'","type":"string"},"turnAroundTimes":{"description":"A list of turnaround times for providers","type":"array","items":{"$ref":"#/components/schemas/ProviderTurnAroundTime"}},"turnAroundTimeAverage":{"description":"The average turnaround time given the providers","$ref":"#/components/schemas/TurnAroundTime"}}},"Bundle":{"description":"Bundle","type":"object","properties":{"id":{"description":"test id","type":"string"},"name":{"description":"the name of the test","type":"string"},"object":{"description":"The type of object, will always be 'bundle'","type":"string"},"tests":{"description":"The list of tests in the bundle","type":"array","items":{"$ref":"#/components/schemas/Test"}},"createdAt":{"description":"Time the bundle was created","type":"string"}}},"ApiError":{"description":"ApiError","type":"object","properties":{"error":{"description":"should always be true","type":"boolean"},"code":{"description":"error code","type":"string"},"message":{"description":"indication of what happened","type":"string"},"errorList":{"description":"list of additional errors that may of occured","type":"array","items":{"type":"string"}}}},"TestCalculationRequest":{"description":"Create Test calculator request body","required":["tests"],"type":"object","properties":{"tests":{"description":"The list of test ids to calculate a price for","type":"array","items":{"type":"string"}}}}}},"paths":{"/biomarkers":{"get":{"deprecated":false,"summary":"Get all biomarkers tests","security":[{"oauth":[]}],"responses":{"200":{"description":"success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Test"},"examples":{"example1":{"summary":"success response example","value":[{"id":"cortisol","name":"Cortisol","commonName":"Cortisol","object":"biomarker","valueType":"numeric","sampleType":"urine","unit":"nmol/L","description":"Biomarker description","category":{"id":"hormone","name":"Horones","object":"biomarker-category","description":"Description of the biomarker category"}}]}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"example2":{"summary":"Missing Authorization header example","value":{"error":true,"code":"MISSING_AUTHORIZATION_HEADER","message":"Missing Authorization header","errorList":[]}},"example3":{"summary":"Invalid Jwt provided example","value":{"error":true,"code":"INVALID_JWT","message":"Invalid access token","errorList":[]}},"example4":{"summary":"Invalid Jwt signature example","value":{"error":true,"code":"INVALID_JWT_SIGNATURE","message":"Invalid JWT Signature","errorList":[]}}}}}}},"parameters":[],"tags":["Biomarkers"]}},"/bundles":{"get":{"deprecated":false,"summary":"Returns all bundles for an organisation.","security":[{"oauth":[]}],"responses":{"200":{"description":"success response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Bundle"}},"examples":{"example1":{"summary":"success response example","value":{"cursor":{"cursor":"MjAyNC0wNi0wNFQxMjo1OTowMS44MDJafGNyZWF0ZWRBdHxhc2M=","count":20,"resultCount":5},"bundles":[{"id":"254fa374-6d05-4a41-bfd8-254ba2039049","name":"Bundle Name","object":"bundle","tests":[{"id":"tft","name":"Thyroid Function Test","object":"test"}],"createdAt":"2024-06-04T05:29:06.508Z"}]}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"example2":{"summary":"Missing Authorization header example","value":{"error":true,"code":"MISSING_AUTHORIZATION_HEADER","message":"Missing Authorization header","errorList":[]}},"example3":{"summary":"Invalid Jwt provided example","value":{"error":true,"code":"INVALID_JWT","message":"Invalid access token","errorList":[]}},"example4":{"summary":"Invalid Jwt signature example","value":{"error":true,"code":"INVALID_JWT_SIGNATURE","message":"Invalid JWT Signature","errorList":[]}}}}}}},"parameters":[{"name":"count","in":"query","description":"number of rows to return, default: 20","required":false,"deprecated":false,"schema":{"type":"integer"}},{"name":"cursor","in":"query","description":"starting point","required":false,"deprecated":false,"schema":{"type":"string"}},{"name":"sort","in":"query","description":"time based sort","required":false,"deprecated":false,"schema":{"type":"string","enum":["asc","desc"]}}],"tags":["Bundles"]}},"/calculate":{"post":{"deprecated":false,"summary":"Get the price for a set of tests in cents","security":[{"oauth":[]}],"responses":{"200":{"description":"success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Referral"},"examples":{"example1":{"summary":"success response example","value":{"calculatePrice":{"testsTotal":6857,"tests":[{"name":"Testosterone","price":3203},{"name":"Thyroid Function Test","price":3654}],"discounts":[],"fees":[{"amount":686,"reason":"BGT Service Fee"},{"amount":909,"reason":"Collection fee"}],"tax":[{"amount":846,"reason":"10% GST"}],"subTotal":8452,"totalWithoutMarkup":8452,"grandTotal":8452,"grandTotalIncTax":9297,"grandTotalIncTaxWithoutBulkDiscounts":9297,"grandTotalWithoutBulkDiscounts":8452}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"example2":{"summary":"Missing Authorization header example","value":{"error":true,"code":"MISSING_AUTHORIZATION_HEADER","message":"Missing Authorization header","errorList":[]}},"example3":{"summary":"Invalid Jwt provided example","value":{"error":true,"code":"INVALID_JWT","message":"Invalid access token","errorList":[]}},"example4":{"summary":"Invalid Jwt signature example","value":{"error":true,"code":"INVALID_JWT_SIGNATURE","message":"Invalid JWT Signature","errorList":[]}}}}}}},"parameters":[],"tags":["Calculator"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestCalculationRequest"},"examples":{"example1":{"summary":"get price for a set of tests","value":"{\n    \"tests\": [\n      \"testosterone\",\n      \"tft\"\n    ]\n}"},"example2":{"summary":"get price for a set of tests and bundle","value":"{\n    \"tests\": [\n      \"testosterone\",\n      \"tft\"\n    ],\n    \"bundleId\": \"2c41c35d-0cfd-423e-b0ef-927513456f2b\"\n}"},"example3":{"summary":"get price for a bundle","value":"{\n    \"bundleId\": \"2c41c35d-0cfd-423e-b0ef-927513456f2b\"\n}"}}}},"description":"Body payload","required":true}}},"/referrals/{uuid}":{"delete":{"deprecated":false,"summary":"Deletes a specific referral","security":[{"oauth":[]}],"responses":{"200":{"description":"success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Referral"},"examples":{"example1":{"summary":"success response example","value":{"uuid":"254fa374-6d05-4a41-bfd8-254ba2039049","status":"COMPLETE","object":"referral","tests":["tft","free-testosterone"],"metadata":{"internalId":"1234"},"productId":"prod_abc123","productName":"Comprehensive Health Check","origin":"API","person":{"firstName":"John","lastName":"Vein","email":"john.vein@bloodygoodtests.com.au","address":{"addressLine1":"123 Example Way","addressLine2":null,"postCode":"4000","city":"Brisbane","country":"Australia","state":"QLD"},"phone":"0412345678","dob":"1980-01-01","gender":"male"},"referralType":"blood","referenceNumber":"12345678","referralAttachment":null,"emailSentAt":"2024-06-04T05:29:09.385Z","createdAt":"2024-06-04T05:29:06.508Z","updatedAt":"2024-06-04T05:29:09.385Z","deletedAt":"2024-06-04T05:29:06.508Z","resultsUuid":"d9d820a4-72e1-41bc-9fac-ffb23f18dfb4","bulkBilled":false,"orderingPractitioner":null,"medicareCardNumber":null,"dvaNumber":null,"orderingPractitionerClinicalNotes":null}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"example7":{"summary":"Invalid url parameter example","value":{"error":true,"message":"The parameter provided is invalid","code":"INVALID_PARAMETER","errorList":["Parameter provided is not a valid uuid: abc"]}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"example4":{"summary":"Missing Authorization header example","value":{"error":true,"code":"MISSING_AUTHORIZATION_HEADER","message":"Missing Authorization header","errorList":[]}},"example5":{"summary":"Invalid Jwt provided example","value":{"error":true,"code":"INVALID_JWT","message":"Invalid access token","errorList":[]}},"example6":{"summary":"Invalid Jwt signature example","value":{"error":true,"code":"INVALID_JWT_SIGNATURE","message":"Invalid JWT Signature","errorList":[]}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"example2":{"summary":"Result not found example","value":{"error":true,"code":"RESULT_NOT_FOUND","message":"Unable to find the specified result","errorList":[]}},"example3":{"summary":"Referral not found example","value":{"error":true,"code":"REFERRAL_NOT_FOUND","message":"Unable to find the specified referral","errorList":[]}}}}}}},"parameters":[{"name":"uuid","in":"path","description":"referral uuid","required":false,"deprecated":false,"schema":{"type":"string"}}],"tags":["Referrals"]},"put":{"deprecated":false,"summary":"Auto fills out a specific referral [STAGING ONLY]","description":"This endpoint only works in staging, and is designed to simulate results being created. The data provided is random dummy data.","security":[{"oauth":[]}],"responses":{"200":{"description":"success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Referral"},"examples":{"example1":{"summary":"success response example","value":{"uuid":"254fa374-6d05-4a41-bfd8-254ba2039049","status":"COMPLETE","object":"referral","tests":["tft","free-testosterone"],"metadata":{"internalId":"1234"},"productId":"prod_abc123","productName":"Comprehensive Health Check","origin":"BUNDLE_PURCHASE","person":{"firstName":"John","lastName":"Vein","email":"john.vein@bloodygoodtests.com.au","address":{"addressLine1":"123 Example Way","addressLine2":null,"postCode":"4000","city":"Brisbane","country":"Australia","state":"QLD"},"phone":"0412345678","dob":"1980-01-01","gender":"male"},"referralType":"blood","referenceNumber":"12345678","referralAttachment":null,"emailSentAt":"2024-06-04T05:29:09.385Z","createdAt":"2024-06-04T05:29:06.508Z","updatedAt":"2024-06-04T05:29:09.385Z","deletedAt":"2024-06-04T05:29:06.508Z","resultsUuid":"d9d820a4-72e1-41bc-9fac-ffb23f18dfb4","bulkBilled":false,"orderingPractitioner":null,"medicareCardNumber":null,"dvaNumber":null,"orderingPractitionerClinicalNotes":null}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"example7":{"summary":"Invalid url parameter example","value":{"error":true,"message":"The parameter provided is invalid","code":"INVALID_PARAMETER","errorList":["Parameter provided is not a valid uuid: abc"]}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"example4":{"summary":"Missing Authorization header example","value":{"error":true,"code":"MISSING_AUTHORIZATION_HEADER","message":"Missing Authorization header","errorList":[]}},"example5":{"summary":"Invalid Jwt provided example","value":{"error":true,"code":"INVALID_JWT","message":"Invalid access token","errorList":[]}},"example6":{"summary":"Invalid Jwt signature example","value":{"error":true,"code":"INVALID_JWT_SIGNATURE","message":"Invalid JWT Signature","errorList":[]}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"example2":{"summary":"Result not found example","value":{"error":true,"code":"RESULT_NOT_FOUND","message":"Unable to find the specified result","errorList":[]}},"example3":{"summary":"Referral not found example","value":{"error":true,"code":"REFERRAL_NOT_FOUND","message":"Unable to find the specified referral","errorList":[]}}}}}}},"parameters":[{"name":"uuid","in":"path","description":"referral uuid","required":false,"deprecated":false,"schema":{"type":"string"}}],"tags":["Referrals"]},"get":{"deprecated":false,"summary":"Returns a specific referral","security":[{"oauth":[]}],"responses":{"200":{"description":"success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Referral"},"examples":{"example1":{"summary":"success response example","value":{"uuid":"254fa374-6d05-4a41-bfd8-254ba2039049","status":"COMPLETE","object":"referral","tests":["tft","free-testosterone"],"metadata":{"internalId":"1234"},"productId":"prod_abc123","productName":"Comprehensive Health Check","origin":"API","person":{"firstName":"John","lastName":"Vein","email":"john.vein@bloodygoodtests.com.au","address":{"addressLine1":"123 Example Way","addressLine2":null,"postCode":"4000","city":"Brisbane","country":"Australia","state":"QLD"},"phone":"0412345678","dob":"1980-01-01","gender":"male"},"referralType":"blood","referenceNumber":"12345678","referralAttachment":"https://api.bloodygoodtests.com.au/download/eyJhbGciOiJIUzI1NiJ9...","emailSentAt":"2024-06-04T05:29:09.385Z","createdAt":"2024-06-04T05:29:06.508Z","updatedAt":"2024-06-04T05:29:09.385Z","deletedAt":null,"resultsUuid":"d9d820a4-72e1-41bc-9fac-ffb23f18dfb4","bulkBilled":false,"orderingPractitioner":null,"medicareCardNumber":null,"dvaNumber":null,"orderingPractitionerClinicalNotes":null}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"example7":{"summary":"Invalid url parameter example","value":{"error":true,"message":"The parameter provided is invalid","code":"INVALID_PARAMETER","errorList":["Parameter provided is not a valid uuid: abc"]}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"example4":{"summary":"Missing Authorization header example","value":{"error":true,"code":"MISSING_AUTHORIZATION_HEADER","message":"Missing Authorization header","errorList":[]}},"example5":{"summary":"Invalid Jwt provided example","value":{"error":true,"code":"INVALID_JWT","message":"Invalid access token","errorList":[]}},"example6":{"summary":"Invalid Jwt signature example","value":{"error":true,"code":"INVALID_JWT_SIGNATURE","message":"Invalid JWT Signature","errorList":[]}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"example2":{"summary":"Result not found example","value":{"error":true,"code":"RESULT_NOT_FOUND","message":"Unable to find the specified result","errorList":[]}},"example3":{"summary":"Referral not found example","value":{"error":true,"code":"REFERRAL_NOT_FOUND","message":"Unable to find the specified referral","errorList":[]}}}}}}},"parameters":[{"name":"uuid","in":"path","description":"referral uuid","required":false,"deprecated":false,"schema":{"type":"string"}}],"tags":["Referrals"]},"patch":{"deprecated":false,"summary":"Updates a specific referral","description":"Updates person details and/or metadata on a referral. Only referrals with status CREATED or ISSUED can be updated. A new referral PDF will be generated after the update. All fields are optional - only provided fields will be updated.","security":[{"oauth":[]}],"responses":{"200":{"description":"success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Referral"},"examples":{"example1":{"summary":"success response example","value":{"uuid":"254fa374-6d05-4a41-bfd8-254ba2039049","status":"SCHEDULED_REISSUE","object":"referral","tests":["tft","free-testosterone"],"metadata":{"internalId":"5678"},"productId":"prod_abc123","productName":"Comprehensive Health Check","origin":"API","person":{"firstName":"Jane","lastName":"Doe","email":"jane.doe@example.com","address":{"addressLine1":"123 Example Way","addressLine2":null,"postCode":"4000","city":"Brisbane","country":"Australia","state":"QLD"},"phone":"0412345678","dob":"1980-01-01","gender":"male"},"referralType":"blood","referenceNumber":"12345678","referralAttachment":null,"emailSentAt":"2024-06-04T05:29:09.385Z","createdAt":"2024-06-04T05:29:06.508Z","updatedAt":"2024-06-04T06:15:00.000Z","deletedAt":null,"resultsUuid":null,"bulkBilled":false,"orderingPractitioner":null,"medicareCardNumber":null,"dvaNumber":null,"orderingPractitionerClinicalNotes":null}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"example6":{"summary":"Invalid url parameter example","value":{"error":true,"message":"The parameter provided is invalid","code":"INVALID_PARAMETER","errorList":["Parameter provided is not a valid uuid: abc"]}},"example7":{"summary":"Invalid payload example","value":{"error":true,"message":"The payload provided is invalid","code":"INVALID_PAYLOAD","errorList":["Must be 2 or more characters long. [field: firstName]"]}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"example3":{"summary":"Missing Authorization header example","value":{"error":true,"code":"MISSING_AUTHORIZATION_HEADER","message":"Missing Authorization header","errorList":[]}},"example4":{"summary":"Invalid Jwt provided example","value":{"error":true,"code":"INVALID_JWT","message":"Invalid access token","errorList":[]}},"example5":{"summary":"Invalid Jwt signature example","value":{"error":true,"code":"INVALID_JWT_SIGNATURE","message":"Invalid JWT Signature","errorList":[]}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"example2":{"summary":"Referral not found example","value":{"error":true,"code":"REFERRAL_NOT_FOUND","message":"Unable to find the specified referral","errorList":[]}}}}}}},"parameters":[{"name":"uuid","in":"path","description":"referral uuid","required":false,"deprecated":false,"schema":{"type":"string"}}],"tags":["Referrals"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReferralUpdateRequest"},"examples":{"example1":{"summary":"update name and email","value":"{\n    \"firstName\": \"Jane\",\n    \"lastName\": \"Doe\",\n    \"email\": \"jane.doe@example.com\"\n}"},"example2":{"summary":"update address","value":"{\n    \"address\": {\n        \"addressLine1\": \"456 New Street\",\n        \"addressLine2\": \"Unit 3\",\n        \"postCode\": \"2000\",\n        \"city\": \"Sydney\",\n        \"country\": \"Australia\",\n        \"state\": \"NSW\"\n    }\n}"},"example3":{"summary":"update metadata","value":"{\n    \"metadata\": {\n      \"internalId\": \"5678\",\n      \"removeThisKey\": null\n    }\n}"}}}},"description":"Body payload","required":true}}},"/referrals":{"get":{"deprecated":false,"summary":"Returns all referrals for an organisation.","security":[{"oauth":[]}],"responses":{"200":{"description":"success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Referral"},"examples":{"example1":{"summary":"success response example","value":{"cursor":{"cursor":"MjAyNC0wNi0wNFQxMjo1OTowMS44MDJafGNyZWF0ZWRBdHxhc2M=","count":20,"resultCount":5},"referrals":[{"uuid":"254fa374-6d05-4a41-bfd8-254ba2039049","status":"COMPLETE","object":"referral","tests":["tft","free-testosterone"],"metadata":{"internalId":"1234"},"productId":"prod_abc123","productName":"Comprehensive Health Check","origin":"API","person":{"firstName":"John","lastName":"Vein","email":"john.vein@bloodygoodtests.com.au","address":{"addressLine1":"123 Example Way","addressLine2":null,"postCode":"4000","city":"Brisbane","country":"Australia","state":"QLD"},"phone":"0412345678","dob":"1980-01-01","gender":"male"},"referralType":"blood","referenceNumber":"12345678","referralAttachment":"https://api.bloodygoodtests.com.au/download/eyJhbGciOiJIUzI1NiJ9...","emailSentAt":"2024-06-04T05:29:09.385Z","createdAt":"2024-06-04T05:29:06.508Z","updatedAt":"2024-06-04T05:29:09.385Z","deletedAt":null,"resultsUuid":"d9d820a4-72e1-41bc-9fac-ffb23f18dfb4","bulkBilled":false,"orderingPractitioner":null,"medicareCardNumber":null,"dvaNumber":null,"orderingPractitionerClinicalNotes":null}]}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"example2":{"summary":"Missing Authorization header example","value":{"error":true,"code":"MISSING_AUTHORIZATION_HEADER","message":"Missing Authorization header","errorList":[]}},"example3":{"summary":"Invalid Jwt provided example","value":{"error":true,"code":"INVALID_JWT","message":"Invalid access token","errorList":[]}},"example4":{"summary":"Invalid Jwt signature example","value":{"error":true,"code":"INVALID_JWT_SIGNATURE","message":"Invalid JWT Signature","errorList":[]}}}}}}},"parameters":[{"name":"count","in":"query","description":"number of rows to return, default: 20","required":false,"deprecated":false,"schema":{"type":"integer"}},{"name":"cursor","in":"query","description":"starting point","required":false,"deprecated":false,"schema":{"type":"string"}},{"name":"sort","in":"query","description":"time based sort","required":false,"deprecated":false,"schema":{"type":"string","enum":["asc","desc"]}}],"tags":["Referrals"]},"post":{"deprecated":false,"summary":"Create a new referral","description":"Creates one or more referrals for a patient.\n\nNote: If `emailReferralToCustomer` is set to `false`, we will not send the referral email to your customer. You are responsible for delivering the referral to the customer yourself.\n\nBulk-billed (Medicare) ordering: pass `bulkBilledTests` (with `orderingPractitioner` and `medicareCardNumber`) to order bulk-billed tests. This produces a second, bulk-billed referral alongside any commercial referral, so the response is an array of referrals. Bulk-billed ordering requires API version `1.1.0` or higher — sending `bulkBilledTests` on `1.0.0` returns a `400`. Bulk-billed tests are not billed to your organisation.","security":[{"oauth":[]}],"responses":{"200":{"description":"success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Referral"},"examples":{"example1":{"summary":"success response example","value":{"uuid":"254fa374-6d05-4a41-bfd8-254ba2039049","status":"COMPLETE","object":"referral","tests":["tft","free-testosterone"],"metadata":{"internalId":"1234"},"productId":null,"productName":null,"origin":"API","person":{"firstName":"John","lastName":"Vein","email":"john.vein@bloodygoodtests.com.au","address":{"addressLine1":"123 Example Way","addressLine2":null,"postCode":"4000","city":"Brisbane","country":"Australia","state":"QLD"},"phone":"0412345678","dob":"1980-01-01","gender":"male"},"referralType":"blood","referenceNumber":"12345678","referralAttachment":null,"emailSentAt":"2024-06-04T05:29:09.385Z","createdAt":"2024-06-04T05:29:06.508Z","updatedAt":"2024-06-04T05:29:06.508Z","deletedAt":null,"resultsUuid":null,"bulkBilled":false,"orderingPractitioner":null,"medicareCardNumber":null,"dvaNumber":null,"orderingPractitionerClinicalNotes":null}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"example5":{"summary":"Invalid payload example","value":{"error":true,"message":"The payload provided is invalid","code":"INVALID_PAYLOAD","errorList":["Must be 5 or more characters long. [field: firstName]"]}},"example6":{"summary":"bulkBilledTests on v1.0.0 example","value":{"error":true,"message":"Ordering bulk-billed (Medicare) tests via this version of the API is not supported. Please use 1.1.0.","code":"INVALID_PAYLOAD","errorList":[]}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"example2":{"summary":"Missing Authorization header example","value":{"error":true,"code":"MISSING_AUTHORIZATION_HEADER","message":"Missing Authorization header","errorList":[]}},"example3":{"summary":"Invalid Jwt provided example","value":{"error":true,"code":"INVALID_JWT","message":"Invalid access token","errorList":[]}},"example4":{"summary":"Invalid Jwt signature example","value":{"error":true,"code":"INVALID_JWT_SIGNATURE","message":"Invalid JWT Signature","errorList":[]}}}}}}},"parameters":[],"tags":["Referrals"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReferralCreateRequest"},"examples":{"example1":{"summary":"create referral with specific tests","value":"{\n    \"firstName\": \"John\",\n    \"lastName\": \"Vein\",\n    \"email\": \"john.vein@bloodygoodtests.com.au\",\n    \"address\": {\n        \"addressLine1\": \"123 Example Way\",\n        \"addressLine2\": null,\n        \"postCode\": \"4000\",\n        \"city\": \"Brisbane\",\n        \"country\": \"Australia\",\n        \"state\": \"QLD\"\n    },\n    \"dob\": \"1980-01-01\",\n    \"gender\": \"male\",\n    \"phone\": \"0412345678\",\n    \"tests\": [\n        \"tft\",\n        \"free-testosterone\"\n    ],\n    \"referenceNumber\": \"12345678\",\n    \"emailReferralToCustomer\": true,\n    \"metadata\": {\n      \"internalId\": \"1234\"\n    }\n}"},"example2":{"summary":"create referral with a bundle (v1.1.0)","value":"{\n    \"firstName\": \"Jane\",\n    \"lastName\": \"Doe\",\n    \"email\": \"jane.doe@example.com\",\n    \"address\": {\n        \"addressLine1\": \"456 Sample Street\",\n        \"addressLine2\": \"Unit 2\",\n        \"postCode\": \"2000\",\n        \"city\": \"Sydney\",\n        \"country\": \"Australia\",\n        \"state\": \"NSW\"\n    },\n    \"dob\": \"1992-05-15\",\n    \"gender\": \"female\",\n    \"phone\": \"0498765432\",\n    \"bundleId\": \"56ce2120-5480-4657-9e47-7ae4ecf9229b\",\n    \"referenceNumber\": \"87654321\",\n    \"emailReferralToCustomer\": false,\n    \"metadata\": null\n}"},"example3":{"summary":"create referral with a bundle and additional tests (v1.1.0)","value":"{\n    \"firstName\": \"John\",\n    \"lastName\": \"Vein\",\n    \"email\": \"john.vein@bloodygoodtests.com.au\",\n    \"address\": {\n        \"addressLine1\": \"123 Example Way\",\n        \"addressLine2\": null,\n        \"postCode\": \"4000\",\n        \"city\": \"Brisbane\",\n        \"country\": \"Australia\",\n        \"state\": \"QLD\"\n    },\n    \"dob\": \"1980-01-01\",\n    \"gender\": \"male\",\n    \"phone\": \"0412345678\",\n    \"bundleId\": \"56ce2120-5480-4657-9e47-7ae4ecf9229b\",\n    \"tests\": [\n        \"free-testosterone\",\n        \"vitamin-d\"\n    ],\n    \"referenceNumber\": \"11223344\",\n    \"emailReferralToCustomer\": true,\n    \"metadata\": {\n      \"internalId\": \"5678\"\n    }\n}"},"example4":{"summary":"create commercial + bulk-billed (Medicare) referrals (v1.1.0)","value":"{\n    \"firstName\": \"Jane\",\n    \"lastName\": \"Doe\",\n    \"email\": \"jane.doe@example.com\",\n    \"address\": {\n        \"addressLine1\": \"456 Sample Street\",\n        \"addressLine2\": null,\n        \"postCode\": \"2000\",\n        \"city\": \"Sydney\",\n        \"country\": \"Australia\",\n        \"state\": \"NSW\"\n    },\n    \"dob\": \"1992-05-15\",\n    \"gender\": \"female\",\n    \"phone\": \"0498765432\",\n    \"tests\": [\n        \"free-testosterone\"\n    ],\n    \"bulkBilledTests\": [\n        \"vitamin-d\",\n        \"iron-studies\"\n    ],\n    \"orderingPractitioner\": {\n        \"name\": \"Dr Bill Smith\",\n        \"address\": \"123 Example St, Sydney NSW 2000\",\n        \"providerNumber\": \"2426621B\"\n    },\n    \"medicareCardNumber\": \"1234567890\",\n    \"dvaNumber\": \"QX123456\",\n    \"clinicalNotes\": \"Fatigue, ?anaemia\",\n    \"referenceNumber\": \"55667788\",\n    \"emailReferralToCustomer\": true\n}"}}}},"description":"Body payload","required":true}}},"/results":{"get":{"deprecated":false,"summary":"Returns all results for an organisation.","security":[{"oauth":[]}],"responses":{"200":{"description":"success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Referral"},"examples":{"example1":{"summary":"success response example","value":{"cursor":{"cursor":"MjAyNC0wNi0wNFQxMjo1OTowMS44MDJafGNyZWF0ZWRBdHxhc2M=","count":20,"resultCount":5},"results":[{"uuid":"d9d820a4-72e1-41bc-9fac-ffb23f18dfb4","status":"COMPLETE","object":"result","referenceNumber":"12345678","productId":"prod_abc123","productName":"Comprehensive Health Check","updatedAt":"2024-06-04T05:30:08.699Z","resultDate":"2024-05-29T15:29:00.000Z","reviewedBy":null,"person":{"firstName":"John","lastName":"Vein","email":"john.vein@bloodygoodtests.com.au","address":{"addressLine1":"123 Example Way","addressLine2":null,"postCode":"4000","city":"Brisbane","country":"Australia","state":"QLD"},"phone":"0412345678","dob":"1980-01-01","gender":"male"},"metadata":{"internalId":"1234"},"biomarkers":[{"commonName":"ABO","description":"The Blood Group and Rh Factor Test identifies your blood type within the ABO blood group system (A, B, AB, or O) and determines the presence or absence of the Rh factor (positive or negative). This test is critical for blood transfusions, organ transplantation, pregnancy care, and understanding compatibility in medical emergencies.","formattedValue":"A+","id":"blood-group-abo","isAbnormal":null,"name":"ABO Blood Group System","object":"biomarker","unit":null,"category":{"id":"autoimmune","name":"Autoimmune","description":"Autoimmune Disorders encompass tests designed to detect and monitor conditions where the body's immune system mistakenly attacks its own tissues. These tests evaluate the presence of specific antibodies and markers that signal an autoimmune response, helping to identify diseases like rheumatoid arthritis, lupus, and pernicious anaemia. Regular monitoring is essential for early detection and effective management of these conditions, allowing for timely interventions that can alleviate symptoms and prevent complications. By focusing on autoimmune health, you can gain a deeper understanding of your body's immune function, enabling you to take proactive steps towards maintaining balance and well-being through personalized care strategies.","object":"biomarker-category"},"valueType":"string","value":"A+","subValueType":null,"refIntervalHigh":null,"refIntervalLow":null,"notes":null},{"commonName":"Active Vitamin B12","description":"Active Vitamin B12 (Holotranscobalamin) is the bioavailable portion of vitamin B12 that the body can immediately use. Unlike total vitamin B12, which includes forms of B12 stored in the liver but not actively used by the body, active B12 is bound to the transport protein transcobalamin, delivering it directly to cells. This bioactive form is crucial for several vital processes, such as DNA synthesis, the formation of red blood cells, and maintaining neurological health. Think of it as the courier that delivers vitamin B12 right to where it’s needed, helping the body perform essential functions to keep you healthy and energetic. By measuring active B12, healthcare professionals can assess whether the body has sufficient levels of this vital nutrient for immediate use, even if total B12 appears normal.","formattedValue":"2 pmol/L","id":"active-vitamin-b12","isAbnormal":false,"name":"Active Vitamin B12","object":"biomarker","unit":"pmol/L","category":{"id":"vitamins-and-minerals","name":"Vitamins & Minerals","description":"Vitamins and minerals are important for the body to function properly and prevent disease. These are substances that must be supplied through the diet and although they are only needed in small amounts, they play a major role in maintaining good health and preventing disease.","object":"biomarker-category"},"valueType":"numeric","value":"2","subValueType":null,"refIntervalHigh":4,"refIntervalLow":1,"notes":"Sample was collected fasting. Serum separator tube used."}]}]}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"example2":{"summary":"Missing Authorization header example","value":{"error":true,"code":"MISSING_AUTHORIZATION_HEADER","message":"Missing Authorization header","errorList":[]}},"example3":{"summary":"Invalid Jwt provided example","value":{"error":true,"code":"INVALID_JWT","message":"Invalid access token","errorList":[]}},"example4":{"summary":"Invalid Jwt signature example","value":{"error":true,"code":"INVALID_JWT_SIGNATURE","message":"Invalid JWT Signature","errorList":[]}}}}}}},"parameters":[{"name":"count","in":"query","description":"number of rows to return, default: 20","required":false,"deprecated":false,"schema":{"type":"integer"}},{"name":"cursor","in":"query","description":"starting point","required":false,"deprecated":false,"schema":{"type":"string"}},{"name":"sort","in":"query","description":"time based sort","required":false,"deprecated":false,"schema":{"type":"string","enum":["asc","desc"]}}],"tags":["Results"]}},"/results/{uuid}":{"get":{"deprecated":false,"summary":"Get results for uuid","security":[{"oauth":[]}],"responses":{"200":{"description":"success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"},"examples":{"example1":{"summary":"success response example","value":{"uuid":"d9d820a4-72e1-41bc-9fac-ffb23f18dfb4","status":"COMPLETE","object":"result","referenceNumber":"12345678","productId":"prod_abc123","productName":"Comprehensive Health Check","updatedAt":"2024-06-04T05:30:08.699Z","resultDate":"2024-05-29T15:29:00.000Z","reviewedBy":null,"person":{"firstName":"John","lastName":"Vein","email":"john.vein@bloodygoodtests.com.au","address":{"addressLine1":"123 Example Way","addressLine2":null,"postCode":"4000","city":"Brisbane","country":"Australia","state":"QLD"},"phone":"0412345678","dob":"1980-01-01","gender":"male"},"metadata":{"internalId":"1234"},"biomarkers":[{"commonName":"ABO","description":"The Blood Group and Rh Factor Test identifies your blood type within the ABO blood group system (A, B, AB, or O) and determines the presence or absence of the Rh factor (positive or negative). This test is critical for blood transfusions, organ transplantation, pregnancy care, and understanding compatibility in medical emergencies.","formattedValue":"A+","id":"blood-group-abo","isAbnormal":null,"name":"ABO Blood Group System","object":"biomarker","unit":null,"category":{"id":"autoimmune","name":"Autoimmune","description":"Autoimmune Disorders encompass tests designed to detect and monitor conditions where the body's immune system mistakenly attacks its own tissues. These tests evaluate the presence of specific antibodies and markers that signal an autoimmune response, helping to identify diseases like rheumatoid arthritis, lupus, and pernicious anaemia. Regular monitoring is essential for early detection and effective management of these conditions, allowing for timely interventions that can alleviate symptoms and prevent complications. By focusing on autoimmune health, you can gain a deeper understanding of your body's immune function, enabling you to take proactive steps towards maintaining balance and well-being through personalized care strategies.","object":"biomarker-category"},"valueType":"string","value":"A+","subValueType":null,"refIntervalHigh":null,"refIntervalLow":null},{"commonName":"Active Vitamin B12","description":"Active Vitamin B12 (Holotranscobalamin) is the bioavailable portion of vitamin B12 that the body can immediately use. Unlike total vitamin B12, which includes forms of B12 stored in the liver but not actively used by the body, active B12 is bound to the transport protein transcobalamin, delivering it directly to cells. This bioactive form is crucial for several vital processes, such as DNA synthesis, the formation of red blood cells, and maintaining neurological health. Think of it as the courier that delivers vitamin B12 right to where it’s needed, helping the body perform essential functions to keep you healthy and energetic. By measuring active B12, healthcare professionals can assess whether the body has sufficient levels of this vital nutrient for immediate use, even if total B12 appears normal.","formattedValue":"2 pmol/L","id":"active-vitamin-b12","isAbnormal":false,"name":"Active Vitamin B12","object":"biomarker","unit":"pmol/L","category":{"id":"vitamins-and-minerals","name":"Vitamins & Minerals","description":"Vitamins and minerals are important for the body to function properly and prevent disease. These are substances that must be supplied through the diet and although they are only needed in small amounts, they play a major role in maintaining good health and preventing disease.","object":"biomarker-category"},"valueType":"numeric","value":"2","subValueType":null,"refIntervalHigh":4,"refIntervalLow":1}]}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"example7":{"summary":"Invalid url parameter example","value":{"error":true,"message":"The parameter provided is invalid","code":"INVALID_PARAMETER","errorList":["Parameter provided is not a valid uuid: abc"]}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"example4":{"summary":"Missing Authorization header example","value":{"error":true,"code":"MISSING_AUTHORIZATION_HEADER","message":"Missing Authorization header","errorList":[]}},"example5":{"summary":"Invalid Jwt provided example","value":{"error":true,"code":"INVALID_JWT","message":"Invalid access token","errorList":[]}},"example6":{"summary":"Invalid Jwt signature example","value":{"error":true,"code":"INVALID_JWT_SIGNATURE","message":"Invalid JWT Signature","errorList":[]}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"example2":{"summary":"Result not found example","value":{"error":true,"code":"RESULT_NOT_FOUND","message":"Unable to find the specified result","errorList":[]}},"example3":{"summary":"Referral not found example","value":{"error":true,"code":"REFERRAL_NOT_FOUND","message":"Unable to find the specified referral","errorList":[]}}}}}}},"parameters":[{"name":"uuid","in":"path","description":"result uuid","required":false,"deprecated":false,"schema":{"type":"string"}}],"tags":["Results"]}},"/tests":{"get":{"deprecated":false,"summary":"Get all supported tests","security":[{"oauth":[]}],"responses":{"200":{"description":"success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Test"},"examples":{"example1":{"summary":"success response example","value":[{"id":"cortisol","name":"Cortisol","shortName":"Cortisol","price":356,"object":"test","turnAroundTimes":[{"maximumDays":null,"minimumDays":null,"providerId":"4cyte","providerName":"4Cyte Pathology","object":"providerTurnaroundTime"},{"maximumDays":null,"minimumDays":null,"providerId":"abbott","providerName":"Abbott Pathology","object":"providerTurnaroundTime"}],"turnAroundTimeAverage":{"maximumDays":7,"minimumDays":7,"object":"turnaroundTime"}}]}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"examples":{"example2":{"summary":"Missing Authorization header example","value":{"error":true,"code":"MISSING_AUTHORIZATION_HEADER","message":"Missing Authorization header","errorList":[]}},"example3":{"summary":"Invalid Jwt provided example","value":{"error":true,"code":"INVALID_JWT","message":"Invalid access token","errorList":[]}},"example4":{"summary":"Invalid Jwt signature example","value":{"error":true,"code":"INVALID_JWT_SIGNATURE","message":"Invalid JWT Signature","errorList":[]}}}}}}},"parameters":[],"tags":["Tests"]}}},"tags":[{"name":"Biomarkers","description":""},{"name":"Bundles","description":""},{"name":"Calculator","description":""},{"name":"Referrals","description":""},{"name":"Results","description":""},{"name":"Tests","description":""}]}