Heidi Health · Capability

Heidi Health — Patient Profiles

Heidi Health Patient Profiles API. Manage longitudinal patient records, link sessions to a profile, and batch-delete. Lead operation: Create Patient Profile.

Heidi Health — Patient Profiles is a Naftiko capability published by Heidi Health, one of 10 capabilities the APIs.io network indexes for this provider. It bundles 4 operations across the GET, POST, and PATCH methods rooted at /v1/patient-profiles.

The capability includes 2 read-only operations and 4 state-changing operations. Lead operation: Create a patient profile. Can be deployed as a REST endpoint, MCP tool, or Agent Skill via Naftiko.

Tagged areas include Heidi Health, Patient Profiles, and Patients.

Run with Naftiko Heidi HealthPatient ProfilesPatients

What You Can Do

POST
Createpatientprofile —
/v1/patient-profiles
GET
Listpatientprofiles —
/v1/patient-profiles
GET
Getpatientprofile —
/v1/patient-profiles/{patient_profile_id}
PATCH
Updatepatientprofile —
/v1/patient-profiles/{patient_profile_id}

MCP Tools

heidi-create-patient-profile

Create a patient profile.

heidi-list-patient-profiles

List patient profiles.

read-only idempotent
heidi-get-patient-profile

Retrieve a patient profile.

read-only idempotent
heidi-update-patient-profile

Update a patient profile.

heidi-batch-delete-patient-profiles

Batch delete patient profiles.

heidi-link-session-to-patient-profile

Link a session to a patient profile.

Capability Spec

patient-profiles.yaml Raw ↑ 
naftiko: 1.0.0-alpha2
info:
  label: Heidi Health — Patient Profiles
  description: 'Heidi Health Patient Profiles API. Manage longitudinal patient records, link sessions to a profile, and batch-delete. Lead operation: Create Patient Profile.'
  tags:
    - Heidi Health
    - Patient Profiles
    - Patients
  created: '2026-05-24'
  modified: '2026-05-24'
binds:
  - namespace: env
    keys:
      HEIDI_BEARER_TOKEN: HEIDI_BEARER_TOKEN
capability:
  consumes:
    - type: http
      namespace: heidi-patient-profiles
      baseUri: https://registrar.api.heidihealth.com/api/v2/ml-scribe/open-api
      description: Heidi Health patient profiles surface.
      resources:
        - name: patientProfiles
          path: /patient-profiles
          operations:
            - name: createPatientProfile
              method: POST
              description: Create a patient profile.
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
              inputParameters:
                - name: body
                  in: body
                  type: object
                  required: true
            - name: listPatientProfiles
              method: GET
              description: List patient profiles.
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
              inputParameters:
                - name: ehr_patient_id
                  in: query
                  type: string
                  required: false
                - name: provider
                  in: query
                  type: string
                  required: false
        - name: patientProfile
          path: /patient-profiles/{patient_profile_id}
          operations:
            - name: getPatientProfile
              method: GET
              description: Retrieve a patient profile.
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
              inputParameters:
                - name: patient_profile_id
                  in: path
                  type: string
                  required: true
            - name: updatePatientProfile
              method: PATCH
              description: Update a patient profile.
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
              inputParameters:
                - name: patient_profile_id
                  in: path
                  type: string
                  required: true
                - name: body
                  in: body
                  type: object
                  required: true
        - name: batchDelete
          path: /patient-profiles:batch-delete
          operations:
            - name: batchDeletePatientProfiles
              method: POST
              description: Batch delete patient profiles.
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
              inputParameters:
                - name: body
                  in: body
                  type: object
                  required: true
        - name: linkSession
          path: /patient-profiles/{patient_profile_id}/sessions
          operations:
            - name: linkSessionToPatientProfile
              method: POST
              description: Link a session to a patient profile.
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
              inputParameters:
                - name: patient_profile_id
                  in: path
                  type: string
                  required: true
                - name: body
                  in: body
                  type: object
                  required: true
      authentication:
        type: bearer
        value: '{{env.HEIDI_BEARER_TOKEN}}'
  exposes:
    - type: rest
      namespace: heidi-patient-profiles-rest
      port: 8080
      description: REST adapter for Heidi Patient Profiles.
      resources:
        - path: /v1/patient-profiles
          name: patientProfiles
          operations:
            - method: POST
              name: createPatientProfile
              call: heidi-patient-profiles.createPatientProfile
              with:
                body: rest.body
              outputParameters:
                - type: object
                  mapping: $.
            - method: GET
              name: listPatientProfiles
              call: heidi-patient-profiles.listPatientProfiles
              with:
                ehr_patient_id: rest.query.ehr_patient_id
                provider: rest.query.provider
              outputParameters:
                - type: object
                  mapping: $.
        - path: /v1/patient-profiles/{patient_profile_id}
          name: patientProfile
          operations:
            - method: GET
              name: getPatientProfile
              call: heidi-patient-profiles.getPatientProfile
              with:
                patient_profile_id: rest.path.patient_profile_id
              outputParameters:
                - type: object
                  mapping: $.
            - method: PATCH
              name: updatePatientProfile
              call: heidi-patient-profiles.updatePatientProfile
              with:
                patient_profile_id: rest.path.patient_profile_id
                body: rest.body
              outputParameters:
                - type: object
                  mapping: $.
    - type: mcp
      namespace: heidi-patient-profiles-mcp
      port: 9090
      transport: http
      description: MCP adapter for Heidi Patient Profiles.
      tools:
        - name: heidi-create-patient-profile
          description: Create a patient profile.
          hints:
            readOnly: false
            destructive: false
            idempotent: false
          call: heidi-patient-profiles.createPatientProfile
          with:
            body: tools.body
          outputParameters:
            - type: object
              mapping: $.
        - name: heidi-list-patient-profiles
          description: List patient profiles.
          hints:
            readOnly: true
            destructive: false
            idempotent: true
          call: heidi-patient-profiles.listPatientProfiles
          with:
            ehr_patient_id: tools.ehr_patient_id
            provider: tools.provider
          outputParameters:
            - type: object
              mapping: $.
        - name: heidi-get-patient-profile
          description: Retrieve a patient profile.
          hints:
            readOnly: true
            destructive: false
            idempotent: true
          call: heidi-patient-profiles.getPatientProfile
          with:
            patient_profile_id: tools.patient_profile_id
          outputParameters:
            - type: object
              mapping: $.
        - name: heidi-update-patient-profile
          description: Update a patient profile.
          hints:
            readOnly: false
            destructive: false
            idempotent: false
          call: heidi-patient-profiles.updatePatientProfile
          with:
            patient_profile_id: tools.patient_profile_id
            body: tools.body
          outputParameters:
            - type: object
              mapping: $.
        - name: heidi-batch-delete-patient-profiles
          description: Batch delete patient profiles.
          hints:
            readOnly: false
            destructive: true
            idempotent: false
          call: heidi-patient-profiles.batchDeletePatientProfiles
          with:
            body: tools.body
          outputParameters:
            - type: object
              mapping: $.
        - name: heidi-link-session-to-patient-profile
          description: Link a session to a patient profile.
          hints:
            readOnly: false
            destructive: false
            idempotent: false
          call: heidi-patient-profiles.linkSessionToPatientProfile
          with:
            patient_profile_id: tools.patient_profile_id
            body: tools.body
          outputParameters:
            - type: object
              mapping: $.