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

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