http://hl7.org/fhir/StructureDefinition/CapabilityStatement|4.0.1

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.
derivation: specialization
name: CapabilityStatement
type: CapabilityStatement
elements:
  description: {short: Natural language description of the capability statement, index: 9}
  format:
    min: 1
    short: formats supported (xml | json | ttl | mime type)
    array: true
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/mimetypes|4.0.1'}
    isSummary: true
    index: 26
  date: {short: Date last changed, isSummary: true, index: 6}
  publisher: {short: Name of the publisher (organization or individual), isSummary: true, index: 7}
  patchFormat:
    short: Patch formats supported
    array: true
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/mimetypes|4.0.1'}
    isSummary: true
    index: 27
  fhirVersion:
    short: FHIR Version the system supports
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/FHIR-version|4.0.1'}
    isSummary: true
    index: 25
  jurisdiction:
    short: Intended jurisdiction for capability statement (if applicable)
    array: true
    binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/jurisdiction'}
    isSummary: true
    index: 11
  instantiates: {short: Canonical URL of another capability statement this implements, array: true, isSummary: true, index: 15}
  purpose: {short: Why this capability statement is defined, index: 12}
  name: {short: Name for this capability statement (computer friendly), isSummary: true, index: 2}
  useContext: {short: The context that the content is intended to support, array: true, isSummary: true, index: 10}
  copyright: {short: Use and/or publishing restrictions, index: 13}
  experimental: {short: 'For testing purposes, not real usage', isSummary: true, index: 5}
  imports: {short: Canonical URL of another capability statement this adds to, array: true, isSummary: true, index: 16}
  title: {short: Name for this capability statement (human friendly), isSummary: true, index: 3}
  document:
    short: Document definition
    array: true
    isSummary: true
    index: 78
    elements:
      mode:
        short: producer | consumer
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/document-mode|4.0.1'}
        isSummary: true
        index: 79
      documentation: {short: Description of document support, index: 80}
      profile: {short: Constraint on the resources used in the document, isSummary: true, index: 81}
    required: [profile, mode]
  status:
    isModifier: true
    short: draft | active | retired | unknown
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/publication-status|4.0.1'}
    isModifierReason: This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration
    isSummary: true
    index: 4
  messaging:
    short: If messaging is supported
    array: true
    isSummary: true
    index: 69
    elements:
      endpoint:
        short: Where messages should be sent
        array: true
        index: 70
        elements:
          protocol:
            short: http | ftp | mllp +
            binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/message-transport'}
            index: 71
          address: {short: Network address or identifier of the end-point, index: 72}
        required: [protocol, address]
      reliableCache: {short: Reliable Message Cache Length (min), index: 73}
      documentation: {short: Messaging interface behavior details, index: 74}
      supportedMessage:
        short: Messages supported by this system
        array: true
        isSummary: true
        index: 75
        elements:
          mode:
            short: sender | receiver
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/event-capability-mode|4.0.1'}
            isSummary: true
            index: 76
          definition: {short: Message supported by this system, isSummary: true, index: 77}
        required: [mode, definition]
  kind:
    short: instance | capability | requirements
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/capability-statement-kind|4.0.1'}
    isSummary: true
    index: 14
  implementationGuide: {short: Implementation guides supported, array: true, isSummary: true, index: 28}
  url: {short: 'Canonical identifier for this capability statement, represented as a URI (globally unique)', isSummary: true, index: 0}
  software:
    short: Software that is covered by this capability statement
    isSummary: true
    index: 17
    elements:
      name: {short: A name the software is known by, isSummary: true, index: 18}
      version: {short: Version covered by this statement, isSummary: true, index: 19}
      releaseDate: {short: Date this version was released, isSummary: true, index: 20}
    required: [name]
  version: {short: Business version of the capability statement, isSummary: true, index: 1}
  contact: {short: Contact details for the publisher, array: true, isSummary: true, index: 8}
  implementation:
    short: If this describes a specific instance
    isSummary: true
    index: 21
    elements:
      description: {short: Describes this specific instance, isSummary: true, index: 22}
      url: {short: Base URL for the installation, isSummary: true, index: 23}
      custodian: {short: Organization that manages the data, isSummary: true, index: 24}
    required: [description]
  rest:
    constraint:
      cpb-9: {human: A given resource can only be described once per RESTful mode., severity: error, expression: resource.select(type).isDistinct()}
    short: If the endpoint is a RESTful one
    array: true
    isSummary: true
    index: 29
    elements:
      mode:
        short: client | server
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/restful-capability-mode|4.0.1'}
        isSummary: true
        index: 30
      documentation: {short: General description of implementation, index: 31}
      security:
        short: Information about security of implementation
        isSummary: true
        index: 32
        elements:
          cors: {short: 'Adds CORS Headers (http://enable-cors.org/)', isSummary: true, index: 33}
          service:
            short: OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates
            array: true
            binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/restful-security-service'}
            isSummary: true
            index: 34
          description: {short: General description of how security works, index: 35}
      resource:
        constraint:
          cpb-12: {human: Search parameter names must be unique in the context of a resource., severity: error, expression: searchParam.select(name).isDistinct()}
        short: Resource served on the REST interface
        array: true
        isSummary: true
        index: 36
        elements:
          searchRevInclude: {short: _revinclude values supported by the server, array: true, index: 53}
          searchParam:
            short: Search parameters supported by implementation
            array: true
            index: 54
            elements:
              name: {short: Name of search parameter, index: 55}
              definition: {short: Source of definition for parameter, index: 56}
              type:
                short: number | date | string | token | reference | composite | quantity | uri | special
                binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/search-param-type|4.0.1'}
                index: 57
              documentation: {short: Server-specific usage, index: 58}
            required: [name, type]
          conditionalUpdate: {short: If allows/uses conditional update, index: 49}
          conditionalRead:
            short: not-supported | modified-since | not-match | full-support
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/conditional-read-status|4.0.1'}
            index: 48
          operation:
            short: Definition of a resource operation
            array: true
            isSummary: true
            index: 59
            elements:
              name: {short: Name by which the operation/query is invoked, isSummary: true, index: 60}
              definition: {short: The defined operation/query, isSummary: true, index: 61}
              documentation: {short: Specific details about operation behavior, index: 62}
            required: [name, definition]
          referencePolicy:
            short: literal | logical | resolves | enforced | local
            array: true
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/reference-handling-policy|4.0.1'}
            index: 51
          readHistory: {short: Whether vRead can return past versions, index: 45}
          type:
            short: A resource type that is supported
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/resource-types|4.0.1'}
            isSummary: true
            index: 37
          interaction:
            short: What operations are supported?
            array: true
            index: 41
            elements:
              code:
                short: read | vread | update | patch | delete | history-instance | history-type | create | search-type
                binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/type-restful-interaction|4.0.1'}
                index: 42
              documentation: {short: Anything special about operation behavior, index: 43}
            required: [code]
          documentation: {short: Additional information about the use of the resource type, index: 40}
          updateCreate: {short: If update can commit to a new identity, index: 46}
          conditionalCreate: {short: If allows/uses conditional create, index: 47}
          supportedProfile: {short: Profiles for use cases supported, array: true, isSummary: true, index: 39}
          searchInclude: {short: _include values supported by the server, array: true, index: 52}
          versioning:
            short: no-version | versioned | versioned-update
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/versioning-policy|4.0.1'}
            index: 44
          profile: {short: Base System profile for all uses of resource, isSummary: true, index: 38}
          conditionalDelete:
            short: not-supported | single | multiple - how conditional delete is supported
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/conditional-delete-status|4.0.1'}
            index: 50
        required: [type]
      interaction:
        short: What operations are supported?
        array: true
        index: 63
        elements:
          code:
            short: transaction | batch | search-system | history-system
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/system-restful-interaction|4.0.1'}
            index: 64
          documentation: {short: Anything special about operation behavior, index: 65}
        required: [code]
      searchParam:
        elementReference: ['http://hl7.org/fhir/StructureDefinition/CapabilityStatement', elements, rest, elements, resource, elements, searchParam]
        short: Search parameters for searching all resources
        array: true
        index: 66
      operation:
        elementReference: ['http://hl7.org/fhir/StructureDefinition/CapabilityStatement', elements, rest, elements, resource, elements, operation]
        short: Definition of a system level operation
        array: true
        isSummary: true
        index: 67
      compartment: {short: Compartments served/used by system, array: true, index: 68}
    required: [mode]
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/CapabilityStatement
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 4.0.1
required: [status, kind, fhirVersion, date, format]