CapabilityStatement

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/halaxy/main/json-schema/halaxy-capability-statement-schema.json",
  "title": "CapabilityStatement",
  "description": "A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.",
  "x-generated": "2026-10-22",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/halaxy-api-openapi.yml#/components/schemas/CapabilityStatement",
  "type": "object",
  "deprecated": false,
  "properties": {
    "url": {
      "description": "Canonical identifier for this capability statement, represented as a URI (globally unique)",
      "type": "string"
    },
    "version": {
      "description": "Business version of the capability statement",
      "type": "string"
    },
    "name": {
      "description": "Name for this capability statement (computer friendly)    ",
      "type": "string"
    },
    "title": {
      "description": "Name for this capability statement (human friendly)",
      "type": "string"
    },
    "status": {
      "description": "Capability Statement Status: draft | active | retired | unknown",
      "type": "string",
      "enum": [
        "draft",
        "active",
        "retired",
        "unknown"
      ]
    },
    "experimental": {
      "description": "For testing purposes, not real usage",
      "type": "boolean"
    },
    "date": {
      "description": "Date last changed",
      "type": "string",
      "format": "date-time"
    },
    "publisher": {
      "description": "Name of the publisher (organization or individual)",
      "type": "string"
    },
    "contact": {
      "description": "Contact details for the publisher",
      "type": "array",
      "items": {
        "$ref": "#/$defs/FhirContactDetail"
      }
    },
    "description": {
      "description": "Natural language description of the capability statement",
      "type": "string"
    },
    "jurisdiction": {
      "description": "Intended jurisdiction for capability statement (if applicable)",
      "type": "array",
      "items": {
        "$ref": "#/$defs/FhirCodeableConcept"
      }
    },
    "purpose": {
      "description": "Why this capability statement is defined",
      "type": "string"
    },
    "copyright": {
      "description": "Use and/or publishing restrictions",
      "type": "string"
    },
    "kind": {
      "description": "instance | capability | requirements",
      "type": "string",
      "enum": [
        "instance",
        "capability",
        "requirements"
      ]
    },
    "instantiates": {
      "description": "Canonical URL of another capability statement this implements",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "software": {
      "description": "Software that is covered by this capability statement",
      "$ref": "#/$defs/FhirCapabilityStatementSoftware"
    },
    "implementation": {
      "description": "If this describes a specific instance",
      "$ref": "#/$defs/FhirCapabilityStatementImplementation"
    },
    "fhirVersion": {
      "description": "FHIR Version the system supports",
      "type": "string"
    },
    "format": {
      "description": "formats supported (xml | json | ttl | mime type)",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "patchFormat": {
      "description": "Patch formats supported",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "rest": {
      "description": "Business version of the capability statement",
      "type": "array",
      "items": {
        "$ref": "#/$defs/FhirCapabilityStatementRest"
      }
    },
    "text": {
      "readOnly": true,
      "description": "Text summary of the resource, for human interpretation",
      "anyOf": [
        {
          "$ref": "#/$defs/FhirNarrative"
        },
        {
          "type": "null"
        }
      ]
    },
    "contained": {
      "readOnly": true,
      "description": "Contained, inline Resources",
      "type": "array",
      "items": {
        "$ref": "#/$defs/FhirResourceInterface"
      }
    },
    "id": {
      "readOnly": true,
      "description": "Logical id of this artifact",
      "type": [
        "string",
        "null"
      ]
    },
    "meta": {
      "description": "Metadata about the resource",
      "anyOf": [
        {
          "$ref": "#/$defs/FhirResourceMeta"
        },
        {
          "type": "null"
        }
      ]
    },
    "resourceType": {
      "description": "Resource Type",
      "type": [
        "string",
        "null"
      ]
    }
  },
  "$defs": {
    "FhirCapabilityStatementImplementation": {
      "type": "object",
      "description": "",
      "deprecated": false,
      "properties": {
        "description": {
          "type": "string"
        },
        "url": {
          "type": "string"
        },
        "custodian": {
          "$ref": "#/$defs/FhirReference"
        },
        "id": {
          "readOnly": true,
          "description": "ID of the FHIR element (optional)",
          "type": [
            "string",
            "null"
          ]
        }
      }
    },
    "FhirCapabilityStatementInteraction": {
      "type": "object",
      "description": "",
      "deprecated": false,
      "properties": {
        "code": {
          "type": "string",
          "enum": [
            "read",
            "vread",
            "update",
            "patch",
            "delete",
            "history-instance",
            "history-type",
            "create",
            "search-type"
          ]
        },
        "documentation": {
          "type": "string"
        },
        "id": {
          "readOnly": true,
          "description": "ID of the FHIR element (optional)",
          "type": [
            "string",
            "null"
          ]
        }
      }
    },
    "FhirCapabilityStatementOperation": {
      "type": "object",
      "description": "",
      "deprecated": false,
      "properties": {
        "name": {
          "description": "Name by which the operation/query is invoked",
          "type": "string"
        },
        "definition": {
          "description": "The defined operation/query",
          "type": [
            "string",
            "null"
          ]
        },
        "documentation": {
          "description": "Specific details about operation behavior",
          "type": [
            "string",
            "null"
          ]
        },
        "id": {
          "readOnly": true,
          "description": "ID of the FHIR element (optional)",
          "type": [
            "string",
            "null"
          ]
        }
      }
    },
    "FhirCapabilityStatementResource": {
      "type": "object",
      "description": "",
      "deprecated": false,
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "Organization",
            "Patient",
            "Practitioner",
            "PractitionerRole",
            "Appointment",
            "Coverage",
            "Invoice",
            "Communication",
            "Group",
            "DocumentReference",
            "InvoiceLine",
            "PaymentTransaction",
            "Referral",
            "ReferralDefinition",
            "Schedule",
            "Slot",
            "HealthcareService",
            "AllergyIntolerance",
            "Condition",
            "Immunization",
            "Subscription",
            "SubscriptionTopic",
            "ChargeItemDefinition",
            "ServiceRequest",
            "Medication",
            "MedicationRequest",
            "Questionnaire",
            "QuestionnaireResponse",
            "ValueSet",
            "ValueSetConcept",
            "Observation",
            "Binary",
            "Bundle",
            "OperationOutcome",
            "Parameters",
            "List"
          ]
        },
        "profile": {
          "type": "string"
        },
        "supportedProfile": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "documentation": {
          "type": [
            "string",
            "null"
          ]
        },
        "interaction": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/FhirCapabilityStatementInteraction"
          }
        },
        "versioning": {
          "type": "string",
          "enum": [
            "no-version",
            "versioned",
            "versioned-update"
          ]
        },
        "readHistory": {
          "type": "boolean"
        },
        "updateCreate": {
          "type": "boolean"
        },
        "conditionalCreate": {
          "type": "boolean"
        },
        "conditionalRead": {
          "type": "boolean"
        },
        "conditionalUpdate": {
          "type": "boolean"
        },
        "conditionalDelete": {
          "type": "boolean"
        },
        "referencePolicy": {
          "default": [
            {
              "name": "local",
              "value": "local"
            }
          ],
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "literal",
              "logical",
              "resolves",
              "enforced",
              "local"
            ]
          }
        },
        "searchInclude": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "revInclude": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "searchParam": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/FhirCapabilityStatementSearchParam"
          }
        },
        "operation": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/FhirCapabilityStatementOperation"
          }
        },
        "id": {
          "readOnly": true,
          "description": "ID of the FHIR element (optional)",
          "type": [
            "string",
            "null"
          ]
        }
      }
    },
    "FhirCapabilityStatementRest": {
      "type": "object",
      "description": "",
      "deprecated": false,
      "properties": {
        "mode": {
          "type": "string",
          "enum": [
            "client",
            "server"
          ]
        },
        "documentation": {
          "type": [
            "string",
            "null"
          ]
        },
        "security": {
          "$ref": "#/$defs/FhirCapabilityStatementSecurity"
        },
        "resource": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/FhirCapabilityStatementResource"
          }
        },
        "interaction": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/FhirCapabilityStatementInteraction"
          }
        },
        "searchParam": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/FhirCapabilityStatementSearchParam"
          }
        },
        "operation": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/FhirCapabilityStatementOperation"
          }
        },
        "compartment": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "id": {
          "readOnly": true,
          "description": "ID of the FHIR element (optional)",
          "type": [
            "string",
            "null"
          ]
        }
      }
    },
    "FhirCapabilityStatementSearchParam": {
      "type": "object",
      "description": "",
      "deprecated": false,
      "properties": {
        "name": {
          "type": "string"
        },
        "definition": {
          "type": "string"
        },
        "type": {
          "type": "string",
          "enum": [
            "number",
            "date",
            "string",
            "token",
            "reference",
            "composite",
            "quantity",
            "uri",
            "special"
          ]
        },
        "documentation": {
          "type": [
            "string",
            "null"
          ]
        },
        "id": {
          "readOnly": true,
          "description": "ID of the FHIR element (optional)",
          "type": [
            "string",
            "null"
          ]
        }
      }
    },
    "FhirCapabilityStatementSecurity": {
      "type": "object",
      "description": "",
      "deprecated": false,
      "properties": {
        "cors": {
          "description": "Whether Cors is required",
          "default": true,
          "type": "boolean"
        },
        "service": {
          "description": "Which security services are available",
          "type": "array",
          "items": {
            "$ref": "#/$defs/FhirCodeableConcept"
          }
        },
        "description": {
          "description": "General description of how security works",
          "type": "string"
        },
        "id": {
          "readOnly": true,
          "description": "ID of the FHIR element (optional)",
          "type": [
            "string",
            "null"
          ]
        }
      }
    },
    "FhirCapabilityStatementSoftware": {
      "type": "object",
      "description": "",
      "deprecated": false,
      "properties": {
        "name": {
          "type": "string"
        },
        "version": {
          "type": "string"
        },
        "releaseDate": {
          "type": "string",
          "format": "date-time"
        },
        "id": {
          "readOnly": true,
          "description": "ID of the FHIR element (optional)",
          "type": [
            "string",
            "null"
          ]
        }
      }
    },
    "FhirCodeableConcept": {
      "type": "object",
      "description": "",
      "deprecated": false,
      "properties": {
        "coding": {
          "description": "defined by a terminology system",
          "type": "array",
          "items": {
            "$ref": "#/$defs/FhirCoding"
          }
        },
        "text": {
          "description": "Plain text representation of the concept",
          "type": [
            "string",
            "null"
          ]
        },
        "id": {
          "readOnly": true,
          "description": "ID of the FHIR element (optional)",
          "type": [
            "string",
            "null"
          ]
        }
      }
    },
    "FhirCoding": {
      "type": "object",
      "description": "",
      "deprecated": false,
      "properties": {
        "system": {
          "format": "uri",
          "description": "Identity of the terminology system",
          "type": [
            "string",
            "null"
          ]
        },
        "code": {
          "description": "Symbol in syntax defined by the system",
          "type": [
            "string",
            "null"
          ]
        },
        "display": {
          "description": "Representation defined by the system",
          "type": [
            "string",
            "null"
          ]
        },
        "userSelected": {
          "readOnly": true,
          "description": "If this coding was chosen directly by the user",
          "type": [
            "boolean",
            "null"
          ]
        },
        "id": {
          "readOnly": true,
          "description": "ID of the FHIR element (optional)",
          "type": [
            "string",
            "null"
          ]
        }
      }
    },
    "FhirContactDetail": {
      "type": "object",
      "description": "",
      "deprecated": false,
      "properties": {
        "name": {
          "description": "Name of an individual to contact",
          "type": "string"
        },
        "telecom": {
          "description": "Contact details for individual or organization",
          "type": "array",
          "items": {
            "$ref": "#/$defs/FhirContactPoint"
          }
        },
        "id": {
          "readOnly": true,
          "description": "ID of the FHIR element (optional)",
          "type": [
            "string",
            "null"
          ]
        }
      }
    },
    "FhirContactPoint": {
      "type": "object",
      "description": "",
      "deprecated": false,
      "properties": {
        "system": {
          "description": "Type of contact detail",
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "phone",
            "fax",
            "email",
            "sms",
            null
          ]
        },
        "value": {
          "description": "The actual phone number or email address",
          "type": [
            "string",
            "null"
          ]
        },
        "use": {
          "description": "Purpose of the contact detail",
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "home",
            "work",
            "mobile",
            null
          ]
        },
        "id": {
          "readOnly": true,
          "description": "ID of the FHIR element (optional)",
          "type": [
            "string",
            "null"
          ]
        }
      }
    },
    "FhirNarrative": {
      "type": "object",
      "description": "",
      "deprecated": false,
      "properties": {
        "status": {
          "readOnly": true,
          "description": "Describes how the narrative was generated",
          "type": "string",
          "enum": [
            "generated",
            "extensions",
            "additional",
            "empty"
          ]
        },
        "div": {
          "readOnly": true,
          "description": "Limited xhtml content",
          "type": "string"
        },
        "id": {
          "readOnly": true,
          "description": "ID of the FHIR element (optional)",
          "type": [
            "string",
            "null"
          ]
        }
      }
    },
    "FhirReference": {
      "type": "object",
      "description": "",
      "deprecated": false,
      "required": [
        "reference"
      ],
      "properties": {
        "reference": {
          "description": "The URL (relative or absolute) to the resource being referenced",
          "type": "string"
        },
        "type": {
          "description": "The type of resource being referenced",
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "Organization",
            "Patient",
            "Practitioner",
            "PractitionerRole",
            "Appointment",
            "Coverage",
            "Invoice",
            "Communication",
            "Group",
            "DocumentReference",
            "InvoiceLine",
            "PaymentTransaction",
            "Referral",
            "ReferralDefinition",
            "Schedule",
            "Slot",
            "HealthcareService",
            "AllergyIntolerance",
            "Condition",
            "Immunization",
            "Subscription",
            "SubscriptionTopic",
            "ChargeItemDefinition",
            "ServiceRequest",
            "Medication",
            "MedicationRequest",
            "Questionnaire",
            "QuestionnaireResponse",
            "ValueSet",
            "ValueSetConcept",
            "Observation",
            "Binary",
            "Bundle",
            "OperationOutcome",
            "Parameters",
            "List",
            null
          ]
        },
        "id": {
          "readOnly": true,
          "description": "ID of the FHIR element (optional)",
          "type": [
            "string",
            "null"
          ]
        }
      }
    },
    "FhirResourceInterface": {
      "type": "object",
      "description": "",
      "deprecated": false
    },
    "FhirResourceMeta": {
      "type": "object",
      "description": "",
      "deprecated": false,
      "properties": {
        "lastUpdated": {
          "readOnly": true,
          "description": "When the resource version last changed",
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "profile": {
          "description": "Profiles this resource claims to conform to",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    }
  }
}