Clinic Entity

v2.0.1

Organization

Healthcare Services

Schema for healthcare clinics based on the healthcare subcategory. Designed for AI agents to understand medical services, compliance requirements, and patient care capabilities.

Entity Hierarchy

Clinic

→

organization

→

healthcare_services

→

clinic

Format: @type → entityCategory → subcategory → entityType

Required Modules

Recommended Modules

12+

Functional Features

Site Actions

⭐ New Features in v2.0.1

Perfect AI understanding with zero ambiguity

entityCapabilities

Objective, verifiable clinic features with rules:

• camelCase (hasOnlineScheduling, acceptsInsurance)
• Prefixes: has, is, accepts, supports
• Boolean values for objective verification
• Examples expandable - no limitations

siteCapabilities

Actions available on clinic website with rules:

• snake_case (schedule_appointment, access_patient_portal)
• Based on verbs (what patients can do)
• Only actually working actions
• Examples expandable without limitations

Required Modules

Essential modules for healthcare compliance and patient safety

Required

auth

REQUIRED - Patient authentication and account management

Essential for patient privacy and HIPAA compliance

Required

security

REQUIRED - Data protection and encryption

Mandatory for protecting sensitive health information

Required

compliance

REQUIRED - Healthcare regulations and privacy

Required for HIPAA and healthcare regulatory compliance

Recommended Modules

Enhance clinic functionality and patient experience

Recommended

location

Recommended

payments

Recommended

user-management

Healthcare Compliance Requirements

HIPAA Compliance

All clinic entities must implement proper security and compliance modules to protect patient health information.

Required Security Features

SSL encryption, data encryption, audit logging, and secure authentication are mandatory.

Patient Portal Security

Patient portals require multi-factor authentication and secure session management.

Entity Capabilities

Objective, verifiable clinic features and services. Define functional capabilities using camelCase naming with prefixes: "has", "is", "accepts", "supports".

Naming Convention Rules

• Use camelCase formatting (e.g., "hasOnlineScheduling", "acceptsInsurance")
• Start with prefixes: "has", "is", "accepts", "supports"
• Examples shown below can be extended - no limitations on additional capabilities
• All values are boolean (true/false) for objective verification

Clinical Services

hasOnlineScheduling

Patients can book appointments online

hasPatientPortal

Secure patient access to records

hasTelemedicine

Virtual consultation services

hasLab

On-site laboratory services

Facility Features

hasPharmacy

On-site pharmacy services

hasXRay

Imaging and diagnostic services

hasEmergencyServices

Emergency medical care

isWheelchairAccessible

ADA compliant accessibility

Patient Services

acceptsInsurance

Insurance billing and processing

hasWalkInServices

No-appointment urgent care

hasSpecialists

Specialized medical care

hasMultilingualStaff

Multi-language support

Site Capabilities

Available actions for AI agents and automated systems. Define what patients can actually do on your clinic website using snake_case action names.

Action Naming Rules

• Use snake_case formatting (e.g., "schedule_appointment", "access_patient_portal")
• Actions should be verb-based describing what patients can do
• Examples shown below are common patterns - extend with your specific actions
• List only actions that actually work on your website

schedule_appointment

Book medical appointments

access_patient_portal

View medical records and results

view_services

Browse available medical services

contact_clinic

Get in touch with healthcare staff

request_prescription

Request prescription refills

pay_bill

Pay medical bills online

view_lab_results

Access test results securely

find_location

Get directions and parking info

check_insurance

Verify insurance coverage

Schema Structure

Clinic entity schema definition

clinic.json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "aimlVersion": "2.0.1",
  "schemaVersion": "2.0.1",
  "title": "Clinic Entity Schema",
  "description": "Schema for healthcare clinics based on the healthcare subcategory",
  "type": "object",
  "properties": {
    "entityType": {
      "const": "clinic",
      "description": "Entity type identifier"
    },
    "entityCategory": {
      "const": "organization",
      "description": "Entity category"
    },
    "subcategory": {
      "const": "healthcare_services",
      "description": "Subcategory of organization"
    },
    "name": {
      "oneOf": [
        { "type": "string" },
        { "$ref": "../components/multilingual-format.json#/$defs/LocalizedText" }
      ],
      "description": "Clinic name"
    },
    "description": {
      "oneOf": [
        { "type": "string" },
        { "$ref": "../components/multilingual-format.json#/$defs/LocalizedText" }
      ],
      "description": "Detailed description of the clinic"
    },
    "modules": {
      "type": "object",
      "description": "AIML modules used by this entity",
      "required": ["auth", "security", "compliance"]
    },
    "properties": {
      "type": "object",
      "description": "Clinic specific properties",
      "properties": {
        "specialties": {
          "type": "array",
          "items": { "type": "string" },
          "description": "Medical specialties offered"
        },
        "facilityType": {
          "type": "string",
          "description": "Type of healthcare facility"
        },
        "accreditation": {
          "type": "array",
          "items": { "type": "string" },
          "description": "Healthcare accreditations and certifications"
        }
      }
    },
    "entityCapabilities": {
      "$ref": "../components/entity-capabilities-format.json#/$defs/EntityCapabilities",
      "description": "Objective capabilities and features of the entity"
    },
    "siteCapabilities": {
      "$ref": "../components/site-capabilities-format.json#/$defs/SiteCapabilities",
      "description": "Website capabilities and interaction features"
    }
  },
  "required": ["entityType", "entityCategory", "subcategory", "name", "description", "properties"],
  "allOf": [{ "$ref": "../base/organization.json" }]
}

Complete Implementation Example

Real-world clinic entity with all v2.0.1 features and compliance

Metropolitan Health Clinic - Complete Schema

{
  "@context": "https://schemas.meta-aiml.org/v2.0.1/context.jsonld",
  "@id": "https://metropolitanhealth.com/entity",
  "@type": "Clinic",
  "schemaVersion": "2.0.1",
  "entityType": "clinic",
  "entityCategory": "organization",
  "subcategory": "healthcare_services",

  "name": {
    "en": "Metropolitan Health Clinic",
    "es": "Clínica de Salud Metropolitana"
  },
  "description": {
    "en": "Comprehensive healthcare services with board-certified physicians specializing in family medicine, urgent care, and preventive health services."
  },
  "url": "https://metropolitanhealth.com",
  "foundingDate": "2010-04-15",

  "properties": {
    "specialties": ["family_medicine", "urgent_care", "preventive_care", "pediatrics", "women_health"],
    "facilityType": "outpatient_clinic",
    "accreditation": ["AAAHC", "NCQA", "state_licensed"],
    "insuranceAccepted": ["medicare", "medicaid", "private_insurance"],
    "languagesSpoken": ["en", "es", "zh"]
  },

  "modules": {
    "auth": {
      "version": "2.0.1",
      "enabled": true,
      "methods": ["email", "phone", "patient_portal"],
      "providers": ["local"],
      "mfaRequired": true
    },
    "security": {
      "version": "2.0.1",
      "enabled": true,
      "features": ["ssl_encryption", "hipaa_compliant", "data_encryption", "audit_logging"],
      "certifications": ["SOC2", "HIPAA"]
    },
    "compliance": {
      "version": "2.0.1",
      "enabled": true,
      "regulations": ["HIPAA", "state_health_regulations", "OSHA"],
      "privacyPolicy": true,
      "dataRetentionPolicy": true
    },
    "location": {
      "version": "2.0.1",
      "enabled": true,
      "address": {
        "addressType": "physical",
        "streetAddress": "789 Medical Center Dr",
        "city": "Healthcare City",
        "region": "CA",
        "postalCode": "90211",
        "countryCode": "US"
      }
    },
    "payments": {
      "version": "2.0.1",
      "enabled": true,
      "providers": ["stripe", "square"],
      "currencies": ["USD"],
      "paymentMethods": ["credit_card", "insurance", "hsa", "cash"]
    }
  },

  "entityCapabilities": {
    "functionalFeatures": {
      "hasOnlineScheduling": true,
      "hasPatientPortal": true,
      "hasTelemedicine": false,
      "hasPharmacy": false,
      "hasLab": true,
      "hasXRay": true,
      "hasEmergencyServices": false,
      "acceptsInsurance": true,
      "hasWalkInServices": true,
      "hasSpecialists": true,
      "isWheelchairAccessible": true,
      "hasMultilingualStaff": true
    },
    "serviceTypes": ["outpatient", "preventive", "urgent_care", "diagnostic"],
    "businessModel": "healthcare_facility",
    "specializations": ["family_medicine", "urgent_care", "preventive_care", "pediatrics"],
    "patientAgeGroups": ["children", "adults", "seniors"],
    "paymentMethods": ["insurance", "credit_card", "hsa", "cash"]
  },

  "siteCapabilities": {
    "availableActions": [
      "schedule_appointment", "access_patient_portal", "view_services",
      "contact_clinic", "request_prescription", "pay_bill",
      "view_lab_results", "find_location", "check_insurance"
    ],
    "interactionMethods": ["online_form", "phone_call", "patient_portal", "email"],
    "contentAccess": ["public", "patient_portal_protected"],
    "supportedDevices": ["desktop", "mobile", "tablet"],
    "languages": ["en", "es"],
    "realTimeFeatures": ["real_time_scheduling", "appointment_reminders", "secure_messaging"]
  }
}