---
title: "Get Capability Statement"
method: GET
path: "/main/metadata"
tags: ["CapabilityStatement"]
---

# Get Capability Statement

`GET /main/metadata`

Retrieves a CapabilityStatement resource

## Response `200`

CapabilityStatement resource

- CapabilityStatement — 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.
  - `url` string — Canonical identifier for this capability statement, represented as a URI (globally unique)
  - `version` string — Business version of the capability statement
  - `name` string — Name for this capability statement (computer friendly)
  - `title` string — Name for this capability statement (human friendly)
  - `status` 'draft' | 'active' | 'retired' | 'unknown' — Capability Statement Status: draft | active | retired | unknown
  - `experimental` boolean — For testing purposes, not real usage
  - `date` string, date-time — Date last changed
  - `publisher` string — Name of the publisher (organization or individual)
  - `contact` FhirContactDetail[] — Contact details for the publisher
    - `name` string — Name of an individual to contact
    - `telecom` FhirContactPoint[] — Contact details for individual or organization
      - `system` 'phone' | 'fax' | 'email' | 'sms' | 'null', nullable — Type of contact detail
      - `value` string, nullable — The actual phone number or email address
      - `use` 'home' | 'work' | 'mobile' | 'null', nullable — Purpose of the contact detail
      - `id` string, nullable — ID of the FHIR element (optional)
    - `id` string, nullable — ID of the FHIR element (optional)
  - `description` string — Natural language description of the capability statement
  - `jurisdiction` FhirCodeableConcept[] — Intended jurisdiction for capability statement (if applicable)
    - `coding` FhirCoding[] — defined by a terminology system
      - `system` string, uri, nullable — Identity of the terminology system
      - `code` string, nullable — Symbol in syntax defined by the system
      - `display` string, nullable — Representation defined by the system
      - `userSelected` boolean, nullable — If this coding was chosen directly by the user
      - `id` string, nullable — ID of the FHIR element (optional)
    - `text` string, nullable — Plain text representation of the concept
    - `id` string, nullable — ID of the FHIR element (optional)
  - `purpose` string — Why this capability statement is defined
  - `copyright` string — Use and/or publishing restrictions
  - `kind` 'instance' | 'capability' | 'requirements' — instance | capability | requirements
  - `instantiates` string[] — Canonical URL of another capability statement this implements
  - `software` FhirCapabilityStatementSoftware
    - `name` string
    - `version` string
    - `releaseDate` string, date-time
    - `id` string, nullable — ID of the FHIR element (optional)
  - `implementation` FhirCapabilityStatementImplementation
    - `description` string
    - `url` string
    - `custodian` FhirReference
      - `reference` string, required — The URL (relative or absolute) to the resource being referenced
      - `type` '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' | 'Observation' | 'Binary' | 'Bundle' | 'OperationOutcome' | 'Parameters' | 'List' | 'null', nullable — The type of resource being referenced
      - `id` string, nullable — ID of the FHIR element (optional)
    - `id` string, nullable — ID of the FHIR element (optional)
  - `fhirVersion` string — FHIR Version the system supports
  - `format` string[] — formats supported (xml | json | ttl | mime type)
  - `patchFormat` string[] — Patch formats supported
  - `rest` FhirCapabilityStatementRest[] — Business version of the capability statement
    - `mode` 'client' | 'server'
    - `documentation` string, nullable
    - `security` FhirCapabilityStatementSecurity
      - `cors` boolean — Whether Cors is required
      - `service` FhirCodeableConcept[] — Which security services are available
        - `coding` FhirCoding[] — defined by a terminology system
          - `system` string, uri, nullable — Identity of the terminology system
          - `code` string, nullable — Symbol in syntax defined by the system
          - `display` string, nullable — Representation defined by the system
          - `userSelected` boolean, nullable — If this coding was chosen directly by the user
          - `id` string, nullable — ID of the FHIR element (optional)
        - `text` string, nullable — Plain text representation of the concept
        - `id` string, nullable — ID of the FHIR element (optional)
      - `description` string — General description of how security works
      - `id` string, nullable — ID of the FHIR element (optional)
    - `resource` FhirCapabilityStatementResource[]
      - `type` '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' | 'Observation' | 'Binary' | 'Bundle' | 'OperationOutcome' | 'Parameters' | 'List'
      - `profile` string
      - `supportedProfile` string[]
      - `documentation` string, nullable
      - `interaction` FhirCapabilityStatementInteraction[]
        - `code` 'read' | 'vread' | 'update' | 'patch' | 'delete' | 'history-instance' | 'history-type' | 'create' | 'search-type'
        - `documentation` string
        - `id` string, nullable — ID of the FHIR element (optional)
      - `versioning` 'no-version' | 'versioned' | 'versioned-update'
      - `readHistory` boolean
      - `updateCreate` boolean
      - `conditionalCreate` boolean
      - `conditionalRead` boolean
      - `conditionalUpdate` boolean
      - `conditionalDelete` boolean
      - `referencePolicy` string[]
      - `searchInclude` string[]
      - `revInclude` string[]
      - `searchParam` FhirCapabilityStatementSearchParam[]
        - `name` string
        - `definition` string
        - `type` 'number' | 'date' | 'string' | 'token' | 'reference' | 'composite' | 'quantity' | 'uri' | 'special'
        - `documentation` string, nullable
        - `id` string, nullable — ID of the FHIR element (optional)
      - `operation` FhirCapabilityStatementOperation[]
        - `name` string — Name by which the operation/query is invoked
        - `definition` string, nullable — The defined operation/query
        - `documentation` string, nullable — Specific details about operation behavior
        - `id` string, nullable — ID of the FHIR element (optional)
      - `id` string, nullable — ID of the FHIR element (optional)
    - `interaction` FhirCapabilityStatementInteraction[]
      - `code` 'read' | 'vread' | 'update' | 'patch' | 'delete' | 'history-instance' | 'history-type' | 'create' | 'search-type'
      - `documentation` string
      - `id` string, nullable — ID of the FHIR element (optional)
    - `searchParam` FhirCapabilityStatementSearchParam[]
      - `name` string
      - `definition` string
      - `type` 'number' | 'date' | 'string' | 'token' | 'reference' | 'composite' | 'quantity' | 'uri' | 'special'
      - `documentation` string, nullable
      - `id` string, nullable — ID of the FHIR element (optional)
    - `operation` FhirCapabilityStatementOperation[]
      - `name` string — Name by which the operation/query is invoked
      - `definition` string, nullable — The defined operation/query
      - `documentation` string, nullable — Specific details about operation behavior
      - `id` string, nullable — ID of the FHIR element (optional)
    - `compartment` string[]
    - `id` string, nullable — ID of the FHIR element (optional)
  - `text` FhirNarrative
    - `status` 'generated' | 'extensions' | 'additional' | 'empty' — Describes how the narrative was generated
    - `div` string — Limited xhtml content
    - `id` string, nullable — ID of the FHIR element (optional)
  - `contained` AbstractFhirResource[] — Contained, inline Resources
    - `id` string, nullable — Logical id of this artifact
    - `meta` FhirResourceMeta
      - `lastUpdated` string, date-time, nullable — When the resource version last changed
      - `profile` string[] — Profiles this resource claims to conform to
    - `resourceType` string, nullable — Resource Type
  - `id` string, nullable — Logical id of this artifact
  - `meta` FhirResourceMeta
    - `lastUpdated` string, date-time, nullable — When the resource version last changed
    - `profile` string[] — Profiles this resource claims to conform to
  - `resourceType` string, nullable — Resource Type

## Other responses

- `404` — Resource not found

---

[API](https://skmtc.dev/halaxy/apis/halaxy-api.md) · [All operations](https://skmtc.dev/halaxy/apis/halaxy-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/halaxy/halaxy-api/revisions/d72139daaa89/schema)