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