{
  "opencollection": "1.0.0",
  "info": {
    "name": "Heidi Health API",
    "version": "v2"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Authentication",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Exchange API Key For JWT",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://registrar.api.heidihealth.com/api/v2/ml-scribe/open-api/jwt",
            "params": [
              {
                "name": "email",
                "value": "",
                "type": "query"
              },
              {
                "name": "third_party_internal_id",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Heidi-Api-Key",
              "value": "{{Heidi-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "Exchange a tenant Heidi API key for a short-lived bearer JWT bound to an EHR user."
        }
      ]
    },
    {
      "info": {
        "name": "Templates",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Consult Note Templates",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://registrar.api.heidihealth.com/api/v2/ml-scribe/open-api/templates/document-templates"
          },
          "docs": "List Consult Note Templates"
        }
      ]
    },
    {
      "info": {
        "name": "Patient Profiles",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Patient Profiles",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://registrar.api.heidihealth.com/api/v2/ml-scribe/open-api/patient-profiles",
            "params": [
              {
                "name": "ehr_patient_id",
                "value": "",
                "type": "query"
              },
              {
                "name": "provider",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "List Patient Profiles"
        },
        {
          "info": {
            "name": "Create Patient Profile",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://registrar.api.heidihealth.com/api/v2/ml-scribe/open-api/patient-profiles",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create Patient Profile"
        },
        {
          "info": {
            "name": "Get Patient Profile",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://registrar.api.heidihealth.com/api/v2/ml-scribe/open-api/patient-profiles/:patient_profile_id",
            "params": [
              {
                "name": "patient_profile_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Get Patient Profile"
        },
        {
          "info": {
            "name": "Update Patient Profile",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://registrar.api.heidihealth.com/api/v2/ml-scribe/open-api/patient-profiles/:patient_profile_id",
            "params": [
              {
                "name": "patient_profile_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update Patient Profile"
        },
        {
          "info": {
            "name": "Batch Delete Patient Profiles",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://registrar.api.heidihealth.com/api/v2/ml-scribe/open-api/patient-profiles:batch-delete",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Batch Delete Patient Profiles"
        },
        {
          "info": {
            "name": "Link Session To Patient Profile",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://registrar.api.heidihealth.com/api/v2/ml-scribe/open-api/patient-profiles/:patient_profile_id/sessions",
            "params": [
              {
                "name": "patient_profile_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Link Session To Patient Profile"
        }
      ]
    },
    {
      "info": {
        "name": "Sessions",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Create Session",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://registrar.api.heidihealth.com/api/v2/ml-scribe/open-api/sessions",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create Session"
        },
        {
          "info": {
            "name": "Get Session",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://registrar.api.heidihealth.com/api/v2/ml-scribe/open-api/sessions/:session_id",
            "params": [
              {
                "name": "session_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Get Session"
        },
        {
          "info": {
            "name": "Update Session",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://registrar.api.heidihealth.com/api/v2/ml-scribe/open-api/sessions/:session_id",
            "params": [
              {
                "name": "session_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update Session"
        },
        {
          "info": {
            "name": "List Linked User Sessions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://registrar.api.heidihealth.com/api/v2/ml-scribe/open-api/sessions/linked-user",
            "params": [
              {
                "name": "page_size",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "List Linked User Sessions"
        }
      ]
    },
    {
      "info": {
        "name": "Session Context",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Context Documents",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://registrar.api.heidihealth.com/api/v2/ml-scribe/open-api/sessions/:session_id/context-documents",
            "params": [
              {
                "name": "session_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "List Context Documents"
        },
        {
          "info": {
            "name": "Upload Context Document",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://registrar.api.heidihealth.com/api/v2/ml-scribe/open-api/sessions/:session_id/context-documents",
            "params": [
              {
                "name": "session_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "file",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "unstructured",
                  "type": "text",
                  "value": ""
                }
              ]
            }
          },
          "docs": "Upload Context Document"
        },
        {
          "info": {
            "name": "Delete Context Documents",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://registrar.api.heidihealth.com/api/v2/ml-scribe/open-api/sessions/:session_id/context-documents",
            "params": [
              {
                "name": "session_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "ids",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Delete Context Documents"
        }
      ]
    },
    {
      "info": {
        "name": "Transcription",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Upload Session Audio",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://registrar.api.heidihealth.com/api/v2/ml-scribe/open-api/sessions/:session_id/upload-audio",
            "params": [
              {
                "name": "session_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "file",
                  "type": "text",
                  "value": ""
                }
              ]
            }
          },
          "docs": "Upload a full audio file (MP3 or OGG recommended) for lazy transcription."
        },
        {
          "info": {
            "name": "Get Session Transcript",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://registrar.api.heidihealth.com/api/v2/ml-scribe/open-api/sessions/:session_id/transcript",
            "params": [
              {
                "name": "session_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Get Session Transcript"
        },
        {
          "info": {
            "name": "Get Live Session Transcript",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://registrar.api.heidihealth.com/api/v2/ml-scribe/open-api/sessions/:session_id/transcript/live",
            "params": [
              {
                "name": "session_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Chunked live transcript with per-chunk status and source."
        }
      ]
    },
    {
      "info": {
        "name": "Consult Notes",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Generate Consult Note",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://registrar.api.heidihealth.com/api/v2/ml-scribe/open-api/sessions/:session_id/consult-note",
            "params": [
              {
                "name": "session_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Stream a consult note generated from the session's transcript and context."
        },
        {
          "info": {
            "name": "Generate Custom Template Consult Note",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://registrar.api.heidihealth.com/api/v2/ml-scribe/open-api/sessions/:session_id/client-customised-template/response",
            "params": [
              {
                "name": "session_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Generate a consult note against a client-supplied JSON template."
        }
      ]
    },
    {
      "info": {
        "name": "Documents",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Session Documents",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://registrar.api.heidihealth.com/api/v2/ml-scribe/open-api/sessions/:session_id/documents",
            "params": [
              {
                "name": "session_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "List Session Documents"
        },
        {
          "info": {
            "name": "Generate Document",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://registrar.api.heidihealth.com/api/v2/ml-scribe/open-api/sessions/:session_id/documents",
            "params": [
              {
                "name": "session_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Generate Document"
        }
      ]
    },
    {
      "info": {
        "name": "Clinical Coding",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get Clinical Codes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://registrar.api.heidihealth.com/api/v2/ml-scribe/open-api/sessions/:session_id/clinical-codes",
            "params": [
              {
                "name": "session_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "coding_system",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Generate clinical codes for the session across the requested coding system."
        }
      ]
    },
    {
      "info": {
        "name": "Ask Heidi",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Ask Heidi",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://registrar.api.heidihealth.com/api/v2/ml-scribe/open-api/sessions/:session_id/ask-ai",
            "params": [
              {
                "name": "session_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Stream an AI-assistant response scoped to the session."
        }
      ]
    }
  ],
  "bundled": true
}