Endpoint Information

• Endpoint: https://services.hank.ai/autocoding/v1/tasks/
• API Key: x-api-key
• API Key Value: to be provided

Note: In the schedule section of the following request there is a field called surgeonNPI. This is an optional field that, if provided, can further enhance the system’s ability to predict the correct codes.

API Body Request

{
  “Name”: “some_blank_name”,
  "request": {
    “service”:<reference to service>
    "job": {
   “id” : “value” //optional internal id
   "input": {
        "entities": [
            {
                "inputType": "text", 
                "lastModifiedTime": "Mon Nov 02 12:56:49 EST 2020",
                "noteType": "SurgeonProcedureNote/AnesthesiaProcedureNote/AnesthesiaPreoperativeNote/DiagnosisDescription/SurgeryDescription/AnesthesiaProcedureNote_AirwayPlacement/AnesthesiaProcedureNote_LaborEpidural/AnesthesiaProcedureNote_ArterialLine/AnesthesiaProcedureNote_NerveBlock/AnesthesiaProcedureNote_EpiduralCatheterNonOB/AnesthesiaProcedureNote_CentralLine",
                "content": "Content representing type specified in inputType"
            }......<more documents in the list>
        ]
    },
 "patient_info": {
        "guarantor": [
            {
                "address": [
                    {
                        "city": "City",
                        "state": "State",
                        "street1": "Street",
                        "street2": "",
                        "zip": "Zip"
                    }
                ],
                "first": "First",
                "fullName": "Full",
                "last": "Last",
                "middle": "Middle",
                "phone": [
                    {
                        "number": "number"
                    }
                ],
                "relationship": "relationship to patient"
            }
        ],
        "insurance": [
            {
                "address": {
                    "city": "City",
                    "state": "State",
                    "street1": "Street",
                    "street2": "",
                    "zip": "Zip"
                },
                "company": "company",
                "groupId": "group",
                "phone": "phone",
                "phoneExt": "",
                "policyId": "policy",
                "priority": "priority"
            }
        ],
        "patient": {
            "accn": "account number",
            "address": [
                {
                    "city": "city",
                    "state": "state",
                    "street1": "street",
                    "street2": "",
                    "zip": "zip"
                }
            ],
            "dob": "dob",
            "encn": "encounter",
            "first": "first",
            "fullName": "full",
            "last": "last",
            "middle": "middle",
            "mrn": "mrn#",
            "phone": [
                {
                    "number": "phone number",
                    "type": "home"
                }...can be more
            ],
            "sex": "M/F"
        }
    },
    "provider": {
        "correlation_id": "internal ID",
        "facility": "facility name",
        "name": "HBS"
    },
    "schedule": {
        "anType": "anesthesia type",
        "anesthesiaStaff": "staff",
        "anesthesiologist": "anesthesiologist",
        "asa": "number between 1 and 6",
        "date": "date",
        "difficultIntubation": "Yes/No",
        "emergent": "0 or 1",
        "endTime": "end time",
        "postNote": "number",
        "preNote": "number",
        "recSigned": "number",
        "room": "room number",
        "startTime": "star time",
        "surgeon": "name",
        "surgeonNPI": "NPI Number"
    }
    "meta": {
         "squash_icd": false,
         "note_classification":true << perform note classification or not
    }
  }
}

Where squash_icd, when set to true, asks the api to return the minimal set of ICD code (used billing claims for example). When not set, or set to the default of false, the behavior is to return the maximal set of valid OCD codes (might be used for audits, or other things where the client wants to have them all available).

API Response

Focus is on 200OK

{
       "id": <id>,  <<< poll this id via GET request discussed later in the document
       "metadata": {
       "apiVersion": "1.0",
       "timeStamp": "timestamp",
       "apiKey": "apiKayValue"
        }
}