> ## Documentation Index
> Fetch the complete documentation index at: https://docs.metriport.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.

## Properties

| Name                | Required | Type                                                                 | Description                                                                                     |
| ------------------- | -------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| url                 | No       | uri                                                                  | Canonical identifier for this capability statement, represented as a URI (globally unique)      |
| version             | No       | string                                                               | Business version of the capability statement                                                    |
| name                | No       | string                                                               | Name for this capability statement (computer friendly)                                          |
| title               | No       | string                                                               | Name for this capability statement (human friendly)                                             |
| status              | Yes      | code                                                                 | draft / active / retired / unknown                                                              |
| experimental        | No       | boolean                                                              | For testing purposes, not real usage                                                            |
| date                | Yes      | dateTime                                                             | Date last changed                                                                               |
| publisher           | No       | string                                                               | Name of the publisher (organization or individual)                                              |
| contact             | No       | [ContactDetail](/medical-api/fhir/data-types/contactdetail)\[]       | Contact details for the publisher                                                               |
| description         | No       | markdown                                                             | Natural language description of the capability statement                                        |
| useContext          | No       | [UsageContext](/medical-api/fhir/data-types/usagecontext)\[]         | The context that the content is intended to support                                             |
| jurisdiction        | No       | [CodeableConcept](/medical-api/fhir/data-types/codeableconcept)\[]   | Intended jurisdiction for capability statement (if applicable)                                  |
| purpose             | No       | markdown                                                             | Why this capability statement is defined                                                        |
| copyright           | No       | markdown                                                             | Use and/or publishing restrictions                                                              |
| kind                | Yes      | code                                                                 | instance / capability / requirements                                                            |
| instantiates        | No       | canonical\[]                                                         | Canonical URL of another capability statement this implements                                   |
| imports             | No       | canonical\[]                                                         | Canonical URL of another capability statement this adds to                                      |
| software            | No       | CapabilityStatementSoftware                                          | Software that is covered by this capability statement                                           |
| - id                | No       | string                                                               | Unique id for inter-element referencing                                                         |
| - extension         | No       | [Extension](/medical-api/fhir/data-types/extension)\[]               | Additional content defined by implementations                                                   |
| - modifierExtension | No       | [Extension](/medical-api/fhir/data-types/extension)\[]               | Extensions that cannot be ignored even if unrecognized                                          |
| - name              | Yes      | string                                                               | A name the software is known by                                                                 |
| - version           | No       | string                                                               | Version covered by this statement                                                               |
| - releaseDate       | No       | dateTime                                                             | Date this version was released                                                                  |
| implementation      | No       | CapabilityStatementImplementation                                    | If this describes a specific instance                                                           |
| - id                | No       | string                                                               | Unique id for inter-element referencing                                                         |
| - extension         | No       | [Extension](/medical-api/fhir/data-types/extension)\[]               | Additional content defined by implementations                                                   |
| - modifierExtension | No       | [Extension](/medical-api/fhir/data-types/extension)\[]               | Extensions that cannot be ignored even if unrecognized                                          |
| - description       | Yes      | string                                                               | Describes this specific instance                                                                |
| - url               | No       | url                                                                  | Base URL for the installation                                                                   |
| - custodian         | No       | Reference\<[Organization](/medical-api/fhir/resources/organization)> | Organization that manages the data                                                              |
| fhirVersion         | Yes      | code                                                                 | FHIR Version the system supports                                                                |
| format              | Yes      | code\[]                                                              | formats supported (xml / json / ttl / mime type)                                                |
| patchFormat         | No       | code\[]                                                              | Patch formats supported                                                                         |
| implementationGuide | No       | canonical\[]                                                         | Implementation guides supported                                                                 |
| rest                | No       | CapabilityStatementRest                                              | If the endpoint is a RESTful one                                                                |
| - id                | No       | string                                                               | Unique id for inter-element referencing                                                         |
| - extension         | No       | [Extension](/medical-api/fhir/data-types/extension)\[]               | Additional content defined by implementations                                                   |
| - modifierExtension | No       | [Extension](/medical-api/fhir/data-types/extension)\[]               | Extensions that cannot be ignored even if unrecognized                                          |
| - mode              | Yes      | code                                                                 | client / server                                                                                 |
| - documentation     | No       | markdown                                                             | General description of implementation                                                           |
| - security          | No       | CapabilityStatementRestSecurity                                      | Information about security of implementation                                                    |
| - id                | No       | string                                                               | Unique id for inter-element referencing                                                         |
| - extension         | No       | [Extension](/medical-api/fhir/data-types/extension)\[]               | Additional content defined by implementations                                                   |
| - modifierExtension | No       | [Extension](/medical-api/fhir/data-types/extension)\[]               | Extensions that cannot be ignored even if unrecognized                                          |
| - cors              | No       | boolean                                                              | Adds CORS Headers ([http://enable-cors.org/](http://enable-cors.org/))                          |
| - service           | No       | [CodeableConcept](/medical-api/fhir/data-types/codeableconcept)\[]   | OAuth / SMART-on-FHIR / NTLM / Basic / Kerberos / Certificates                                  |
| - description       | No       | markdown                                                             | General description of how security works                                                       |
| - resource          | No       | CapabilityStatementRestResource                                      | Resource served on the REST interface                                                           |
| - id                | No       | string                                                               | Unique id for inter-element referencing                                                         |
| - extension         | No       | [Extension](/medical-api/fhir/data-types/extension)\[]               | Additional content defined by implementations                                                   |
| - modifierExtension | No       | [Extension](/medical-api/fhir/data-types/extension)\[]               | Extensions that cannot be ignored even if unrecognized                                          |
| - type              | Yes      | code                                                                 | A resource type that is supported                                                               |
| - profile           | No       | canonical                                                            | Base System profile for all uses of resource                                                    |
| - supportedProfile  | No       | canonical\[]                                                         | Profiles for use cases supported                                                                |
| - documentation     | No       | markdown                                                             | Additional information about the use of the resource type                                       |
| - interaction       | No       | CapabilityStatementRestResourceInteraction                           | What operations are supported?                                                                  |
| - id                | No       | string                                                               | Unique id for inter-element referencing                                                         |
| - extension         | No       | [Extension](/medical-api/fhir/data-types/extension)\[]               | Additional content defined by implementations                                                   |
| - modifierExtension | No       | [Extension](/medical-api/fhir/data-types/extension)\[]               | Extensions that cannot be ignored even if unrecognized                                          |
| - code              | Yes      | code                                                                 | read / vread / update / patch / delete / history-instance / history-type / create / search-type |
| - documentation     | No       | markdown                                                             | Anything special about operation behavior                                                       |
| - versioning        | No       | code                                                                 | no-version / versioned / versioned-update                                                       |
| - readHistory       | No       | boolean                                                              | Whether vRead can return past versions                                                          |
| - updateCreate      | No       | boolean                                                              | If update can commit to a new identity                                                          |
| - conditionalCreate | No       | boolean                                                              | If allows/uses conditional create                                                               |
| - conditionalRead   | No       | code                                                                 | not-supported / modified-since / not-match / full-support                                       |
| - conditionalUpdate | No       | boolean                                                              | If allows/uses conditional update                                                               |
| - conditionalDelete | No       | code                                                                 | not-supported / single / multiple - how conditional delete is supported                         |
| - referencePolicy   | No       | code\[]                                                              | literal / logical / resolves / enforced / local                                                 |
| - searchInclude     | No       | string\[]                                                            | \_include values supported by the server                                                        |
| - searchRevInclude  | No       | string\[]                                                            | \_revinclude values supported by the server                                                     |
| - searchParam       | No       | CapabilityStatementRestResourceSearchParam                           | Search parameters supported by implementation                                                   |
| - id                | No       | string                                                               | Unique id for inter-element referencing                                                         |
| - extension         | No       | [Extension](/medical-api/fhir/data-types/extension)\[]               | Additional content defined by implementations                                                   |
| - modifierExtension | No       | [Extension](/medical-api/fhir/data-types/extension)\[]               | Extensions that cannot be ignored even if unrecognized                                          |
| - name              | Yes      | string                                                               | Name of search parameter                                                                        |
| - definition        | No       | canonical                                                            | Source of definition for parameter                                                              |
| - type              | Yes      | code                                                                 | number / date / string / token / reference / composite / quantity / uri / special               |
| - documentation     | No       | markdown                                                             | Server-specific usage                                                                           |
| - operation         | No       | CapabilityStatementRestResourceOperation                             | Definition of a resource operation                                                              |
| - id                | No       | string                                                               | Unique id for inter-element referencing                                                         |
| - extension         | No       | [Extension](/medical-api/fhir/data-types/extension)\[]               | Additional content defined by implementations                                                   |
| - modifierExtension | No       | [Extension](/medical-api/fhir/data-types/extension)\[]               | Extensions that cannot be ignored even if unrecognized                                          |
| - name              | Yes      | string                                                               | Name by which the operation/query is invoked                                                    |
| - definition        | Yes      | canonical                                                            | The defined operation/query                                                                     |
| - documentation     | No       | markdown                                                             | Specific details about operation behavior                                                       |
| - interaction       | No       | CapabilityStatementRestInteraction                                   | What operations are supported?                                                                  |
| - id                | No       | string                                                               | Unique id for inter-element referencing                                                         |
| - extension         | No       | [Extension](/medical-api/fhir/data-types/extension)\[]               | Additional content defined by implementations                                                   |
| - modifierExtension | No       | [Extension](/medical-api/fhir/data-types/extension)\[]               | Extensions that cannot be ignored even if unrecognized                                          |
| - code              | Yes      | code                                                                 | transaction / batch / search-system / history-system                                            |
| - documentation     | No       | markdown                                                             | Anything special about operation behavior                                                       |
| - searchParam       | No       | \[]                                                                  | Search parameters for searching all resources                                                   |
| - operation         | No       | \[]                                                                  | Definition of a system level operation                                                          |
| - compartment       | No       | canonical\[]                                                         | Compartments served/used by system                                                              |
| messaging           | No       | CapabilityStatementMessaging                                         | If messaging is supported                                                                       |
| - id                | No       | string                                                               | Unique id for inter-element referencing                                                         |
| - extension         | No       | [Extension](/medical-api/fhir/data-types/extension)\[]               | Additional content defined by implementations                                                   |
| - modifierExtension | No       | [Extension](/medical-api/fhir/data-types/extension)\[]               | Extensions that cannot be ignored even if unrecognized                                          |
| - endpoint          | No       | CapabilityStatementMessagingEndpoint                                 | Where messages should be sent                                                                   |
| - id                | No       | string                                                               | Unique id for inter-element referencing                                                         |
| - extension         | No       | [Extension](/medical-api/fhir/data-types/extension)\[]               | Additional content defined by implementations                                                   |
| - modifierExtension | No       | [Extension](/medical-api/fhir/data-types/extension)\[]               | Extensions that cannot be ignored even if unrecognized                                          |
| - protocol          | Yes      | [Coding](/medical-api/fhir/data-types/coding)                        | http / ftp / mllp +                                                                             |
| - address           | Yes      | url                                                                  | Network address or identifier of the end-point                                                  |
| - reliableCache     | No       | unsignedInt                                                          | Reliable Message Cache Length (min)                                                             |
| - documentation     | No       | markdown                                                             | Messaging interface behavior details                                                            |
| - supportedMessage  | No       | CapabilityStatementMessagingSupportedMessage                         | Messages supported by this system                                                               |
| - id                | No       | string                                                               | Unique id for inter-element referencing                                                         |
| - extension         | No       | [Extension](/medical-api/fhir/data-types/extension)\[]               | Additional content defined by implementations                                                   |
| - modifierExtension | No       | [Extension](/medical-api/fhir/data-types/extension)\[]               | Extensions that cannot be ignored even if unrecognized                                          |
| - mode              | Yes      | code                                                                 | sender / receiver                                                                               |
| - definition        | Yes      | canonical                                                            | Message supported by this system                                                                |
| document            | No       | CapabilityStatementDocument                                          | Document definition                                                                             |
| - id                | No       | string                                                               | Unique id for inter-element referencing                                                         |
| - extension         | No       | [Extension](/medical-api/fhir/data-types/extension)\[]               | Additional content defined by implementations                                                   |
| - modifierExtension | No       | [Extension](/medical-api/fhir/data-types/extension)\[]               | Extensions that cannot be ignored even if unrecognized                                          |
| - mode              | Yes      | code                                                                 | producer / consumer                                                                             |
| - documentation     | No       | markdown                                                             | Description of document support                                                                 |
| - profile           | Yes      | canonical                                                            | Constraint on the resources used in the document                                                |

## Search Parameters

| Name                  | Type      | Description                                                                                | Expression                                         |
| --------------------- | --------- | ------------------------------------------------------------------------------------------ | -------------------------------------------------- |
| context               | token     | A use context assigned to the capability statement                                         | CapabilityStatement.useContext.value               |
| context-quantity      | quantity  | A quantity- or range-valued use context assigned to the capability statement               | CapabilityStatement.useContext.value               |
| context-type          | token     | A type of use context assigned to the capability statement                                 | CapabilityStatement.useContext.code                |
| date                  | date      | The capability statement publication date                                                  | CapabilityStatement.date                           |
| description           | string    | The description of the capability statement                                                | CapabilityStatement.description                    |
| fhirversion           | token     | The version of FHIR                                                                        | CapabilityStatement.version                        |
| format                | token     | formats supported (xml / json / ttl / mime type)                                           | CapabilityStatement.format                         |
| guide                 | reference | Implementation guides supported                                                            | CapabilityStatement.implementationGuide            |
| jurisdiction          | token     | Intended jurisdiction for the capability statement                                         | CapabilityStatement.jurisdiction                   |
| mode                  | token     | Mode - restful (server/client) or messaging (sender/receiver)                              | CapabilityStatement.rest.mode                      |
| name                  | string    | Computationally friendly name of the capability statement                                  | CapabilityStatement.name                           |
| publisher             | string    | Name of the publisher of the capability statement                                          | CapabilityStatement.publisher                      |
| resource              | token     | Name of a resource mentioned in a capability statement                                     | CapabilityStatement.rest.resource.type             |
| resource-profile      | reference | A profile id invoked in a capability statement                                             | CapabilityStatement.rest.resource.profile          |
| security-service      | token     | OAuth / SMART-on-FHIR / NTLM / Basic / Kerberos / Certificates                             | CapabilityStatement.rest.security.service          |
| software              | string    | Part of the name of a software application                                                 | CapabilityStatement.software.name                  |
| status                | token     | The current status of the capability statement                                             | CapabilityStatement.status                         |
| supported-profile     | reference | Profiles for use cases supported                                                           | CapabilityStatement.rest.resource.supportedProfile |
| title                 | string    | The human-friendly name of the capability statement                                        | CapabilityStatement.title                          |
| url                   | uri       | The uri that identifies the capability statement                                           | CapabilityStatement.url                            |
| version               | token     | The business version of the capability statement                                           | CapabilityStatement.version                        |
| context-type-quantity | composite | A use context type and quantity- or range-based value assigned to the capability statement | CapabilityStatement.useContext                     |
| context-type-value    | composite | A use context type and value assigned to the capability statement                          | CapabilityStatement.useContext                     |

## Inherited Properties

| Name              | Required | Type                                                   | Description                                            |
| ----------------- | -------- | ------------------------------------------------------ | ------------------------------------------------------ |
| id                | No       | string                                                 | Logical id of this artifact                            |
| meta              | No       | [Meta](/medical-api/fhir/data-types/meta)              | Metadata about the resource                            |
| implicitRules     | No       | uri                                                    | A set of rules under which this content was created    |
| language          | No       | code                                                   | Language of the resource content                       |
| text              | No       | [Narrative](/medical-api/fhir/data-types/narrative)    | Text summary of the resource, for human interpretation |
| contained         | No       | Resource\[]                                            | Contained, inline Resources                            |
| extension         | No       | [Extension](/medical-api/fhir/data-types/extension)\[] | Additional content defined by implementations          |
| modifierExtension | No       | [Extension](/medical-api/fhir/data-types/extension)\[] | Extensions that cannot be ignored                      |

To view the FHIR specification for this resource, see [CapabilityStatement](https://www.hl7.org/fhir/StructureDefinition/CapabilityStatement).
