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.
package_name: hl7.fhir.r5.core
derivation: specialization
name: CapabilityStatement2
type: CapabilityStatement2
elements:
  description: {short: Natural language description of the capability statement2, type: markdown, index: 9}
  format:
    min: 1
    short: formats supported (xml | json | ttl | mime type)
    type: code
    array: true
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/mimetypes|4.4.0'}
    isSummary: true
    index: 26
  date: {short: Date last changed, type: dateTime, isSummary: true, index: 6}
  publisher: {short: Name of the publisher (organization or individual), type: string, isSummary: true, index: 7}
  patchFormat:
    short: Patch formats supported
    type: code
    array: true
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/mimetypes|4.4.0'}
    isSummary: true
    index: 27
  fhirVersion:
    short: FHIR Version the system supports
    type: code
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/FHIR-version|4.4.0'}
    isSummary: true
    index: 25
  jurisdiction:
    short: Intended jurisdiction for capability statement2 (if applicable)
    type: CodeableConcept
    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, type: canonical, array: true, isSummary: true, index: 15}
  purpose: {short: Why this capability statement2 is defined, type: markdown, index: 12}
  name: {short: Name for this capability statement2 (computer friendly), type: string, isSummary: true, index: 2}
  useContext: {short: The context that the content is intended to support, type: UsageContext, array: true, isSummary: true, index: 10}
  copyright: {short: Use and/or publishing restrictions, type: markdown, index: 13}
  experimental: {short: 'For testing purposes, not real usage', type: boolean, isSummary: true, index: 5}
  imports: {short: Canonical URL of another capability statement this adds to, type: canonical, array: true, isSummary: true, index: 16}
  title: {short: Name for this capability statement2 (human friendly), type: string, isSummary: true, index: 3}
  status:
    isModifier: true
    short: draft | active | retired | unknown
    type: code
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/publication-status|4.4.0'}
    isModifierReason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
    isSummary: true
    index: 4
  kind:
    short: instance | capability | requirements
    type: code
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/capability-statement-kind|4.4.0'}
    isSummary: true
    index: 14
  implementationGuide: {type: canonical, short: Implementation guides supported, isSummary: true, array: true, index: 28}
  url: {short: 'Canonical identifier for this capability statement2, represented as a URI (globally unique)', type: uri, isSummary: true, index: 0}
  software:
    short: Software that is covered by this capability statement
    type: BackboneElement
    isSummary: true
    index: 17
    elements:
      name: {type: string, short: A name the software is known by, isSummary: true, index: 18}
      version: {short: Version covered by this statement, type: string, isSummary: true, index: 19}
      releaseDate: {type: dateTime, short: Date this version was released, isSummary: true, index: 20}
    required: [name]
  version: {short: Business version of the capability statement2, type: string, isSummary: true, index: 1}
  contact: {short: Contact details for the publisher, type: ContactDetail, array: true, isSummary: true, index: 8}
  implementation:
    short: If this describes a specific instance
    type: BackboneElement
    isSummary: true
    index: 21
    elements:
      description: {type: string, short: Describes this specific instance, isSummary: true, index: 22}
      url: {type: url, short: Base URL for the installation, isSummary: true, index: 23}
      custodian:
        short: Organization that manages the data
        refers: ['http://hl7.org/fhir/StructureDefinition/Organization']
        type: Reference
        isSummary: true
        index: 24
    required: [description]
  rest:
    constraint:
      cp2-9: {human: A given resource can only be described once per RESTful mode., source: 'http://hl7.org/fhir/StructureDefinition/CapabilityStatement2', severity: error, expression: resource.select(type).isDistinct()}
    short: If the endpoint is a RESTful one
    type: BackboneElement
    array: true
    isSummary: true
    index: 29
    elements:
      mode:
        short: client | server
        type: code
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/restful-capability-mode|4.4.0'}
        isSummary: true
        index: 30
      documentation: {type: markdown, short: General description of implementation, index: 31}
      resource:
        constraint:
          cp2-12: {human: Search parameter names must be unique in the context of a resource., source: 'http://hl7.org/fhir/StructureDefinition/CapabilityStatement2', severity: error, expression: searchParam.select(name).isDistinct()}
        short: Resource served on the REST interface
        type: BackboneElement
        array: true
        isSummary: true
        index: 32
        elements:
          type:
            short: A resource type that is supported
            type: code
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/resource-types|4.4.0'}
            isSummary: true
            index: 33
          profile: {short: Base System profile for all uses of resource, type: canonical, isSummary: true, index: 34}
          supportedProfile: {short: Profiles for use cases supported, type: canonical, array: true, isSummary: true, index: 35}
          documentation: {type: markdown, short: Additional information about the use of the resource type, index: 36}
          interaction:
            short: What operations are supported?
            type: BackboneElement
            array: true
            index: 37
            elements:
              code:
                type: 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.4.0'}
                index: 38
              documentation: {type: markdown, short: Anything special about operation behavior, index: 39}
            required: [code]
          searchParam:
            type: BackboneElement
            short: Search parameters supported by implementation
            array: true
            index: 40
            elements:
              name: {type: string, short: Name of search parameter, index: 41}
              definition: {type: canonical, short: Source of definition for parameter, index: 42}
              type:
                short: number | date | string | token | reference | composite | quantity | uri | special
                type: code
                binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/search-param-type|4.4.0'}
                index: 43
              documentation: {type: markdown, short: Server-specific usage, index: 44}
            required: [name, type]
          operation:
            short: Definition of a resource operation
            type: BackboneElement
            array: true
            isSummary: true
            index: 45
            elements:
              name: {short: Name by which the operation/query is invoked, type: string, isSummary: true, index: 46}
              definition: {short: The defined operation/query, type: canonical, isSummary: true, index: 47}
              documentation: {type: markdown, short: Specific details about operation behavior, index: 48}
            required: [name, definition]
        required: [type]
      interaction:
        type: BackboneElement
        short: What operations are supported?
        array: true
        index: 49
        elements:
          code:
            type: code
            short: transaction | batch | search-system | history-system
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/system-restful-interaction|4.4.0'}
            index: 50
          documentation: {type: markdown, short: Anything special about operation behavior, index: 51}
        required: [code]
      searchParam:
        short: Search parameters for searching all resources
        elementReference: ['http://hl7.org/fhir/StructureDefinition/CapabilityStatement2', elements, rest, elements, resource, elements, searchParam]
        array: true
        index: 52
      operation:
        elementReference: ['http://hl7.org/fhir/StructureDefinition/CapabilityStatement2', elements, rest, elements, resource, elements, operation]
        short: Definition of a system level operation
        array: true
        isSummary: true
        index: 53
      compartment: {type: canonical, short: Compartments served/used by system, array: true, index: 54}
    required: [mode]
package_version: 4.4.0
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/CapabilityStatement2
base: http://hl7.org/fhir/StructureDefinition/CanonicalResource
version: 4.4.0
required: [status, kind, fhirVersion, date, format]