Class CapabilityStatement2

All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

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.
See Also:
  • Field Details

    • url

      protected UriType url
      An absolute URI that is used to identify this capability statement2 when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this capability statement2 is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the capability statement2 is stored on different servers.
    • version

      protected StringType version
      The identifier that is used to identify this version of the capability statement2 when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the capability statement2 author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
    • name

      protected StringType name
      A natural language name identifying the capability statement2. This name should be usable as an identifier for the module by machine processing applications such as code generation.
    • title

      protected StringType title
      A short, descriptive, user-friendly title for the capability statement2.
    • status

      The status of this capability statement2. Enables tracking the life-cycle of the content.
    • experimental

      A Boolean value to indicate that this capability statement2 is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
    • date

      protected DateTimeType date
      The date (and optionally time) when the capability statement2 was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the capability statement2 changes.
    • publisher

      protected StringType publisher
      The name of the organization or individual that published the capability statement2.
    • contact

      Contact details to assist a user in finding and communicating with the publisher.
    • description

      A free text natural language description of the capability statement2 from a consumer's perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP.
    • useContext

      The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate capability statement2 instances.
    • jurisdiction

      A legal or geographic region in which the capability statement2 is intended to be used.
    • purpose

      protected MarkdownType purpose
      Explanation of why this capability statement2 is needed and why it has been designed as it has.
    • kind

      The way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind, not instance of software) or a class of implementation (e.g. a desired purchase).
    • instantiates

      Reference to a canonical URL of another CapabilityStatement2 that this software implements. This capability statement is a published API description that corresponds to a business service. The server may actually implement a subset of the capability statement it claims to implement, so the capability statement must specify the full capability details.
    • imports

      Reference to a canonical URL of another CapabilityStatement2 that this software adds to. The capability statement automatically includes everything in the other statement, and it is not duplicated, though the server may repeat the same resources, interactions and operations to add additional details to them.
    • software

      Software that is covered by this capability statement. It is used when the capability statement describes the capabilities of a particular software version, independent of an installation.
    • implementation

      Identifies a specific implementation instance that is described by the capability statement - i.e. a particular installation, rather than the capabilities of a software program.
    • fhirVersion

      The version of the FHIR specification that this CapabilityStatement2 describes (which SHALL be the same as the FHIR version of the CapabilityStatement2 itself). There is no default value.
    • format

      protected List<CodeType> format
      A list of the formats supported by this implementation using their content types.
    • patchFormat

      A list of the patch formats supported by this implementation using their content types.
    • implementationGuide

      A list of implementation guides that the server does (or should) support in their entirety.
    • rest

      A definition of the restful capabilities of the solution, if any.
    • SP_CONTEXT_QUANTITY

      public static final String SP_CONTEXT_QUANTITY
      Search parameter: context-quantity

      Description: A quantity- or range-valued use context assigned to the capability statement2
      Type: quantity
      Path: (CapabilityStatement2.useContext.value as Quantity) | (CapabilityStatement2.useContext.value as Range)

      See Also:
    • CONTEXT_QUANTITY

      public static final ca.uhn.fhir.rest.gclient.QuantityClientParam CONTEXT_QUANTITY
      Fluent Client search parameter constant for context-quantity

      Description: A quantity- or range-valued use context assigned to the capability statement2
      Type: quantity
      Path: (CapabilityStatement2.useContext.value as Quantity) | (CapabilityStatement2.useContext.value as Range)

    • SP_CONTEXT_TYPE_QUANTITY

      public static final String SP_CONTEXT_TYPE_QUANTITY
      Search parameter: context-type-quantity

      Description: A use context type and quantity- or range-based value assigned to the capability statement2
      Type: composite
      Path: CapabilityStatement2.useContext

      See Also:
    • CONTEXT_TYPE_QUANTITY

      public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.QuantityClientParam> CONTEXT_TYPE_QUANTITY
      Fluent Client search parameter constant for context-type-quantity

      Description: A use context type and quantity- or range-based value assigned to the capability statement2
      Type: composite
      Path: CapabilityStatement2.useContext

    • SP_CONTEXT_TYPE_VALUE

      public static final String SP_CONTEXT_TYPE_VALUE
      Search parameter: context-type-value

      Description: A use context type and value assigned to the capability statement2
      Type: composite
      Path: CapabilityStatement2.useContext

      See Also:
    • CONTEXT_TYPE_VALUE

      public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam> CONTEXT_TYPE_VALUE
      Fluent Client search parameter constant for context-type-value

      Description: A use context type and value assigned to the capability statement2
      Type: composite
      Path: CapabilityStatement2.useContext

    • SP_CONTEXT_TYPE

      public static final String SP_CONTEXT_TYPE
      Search parameter: context-type

      Description: A type of use context assigned to the capability statement2
      Type: token
      Path: CapabilityStatement2.useContext.code

      See Also:
    • CONTEXT_TYPE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT_TYPE
      Fluent Client search parameter constant for context-type

      Description: A type of use context assigned to the capability statement2
      Type: token
      Path: CapabilityStatement2.useContext.code

    • SP_CONTEXT

      public static final String SP_CONTEXT
      Search parameter: context

      Description: A use context assigned to the capability statement2
      Type: token
      Path: (CapabilityStatement2.useContext.value as CodeableConcept)

      See Also:
    • CONTEXT

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT
      Fluent Client search parameter constant for context

      Description: A use context assigned to the capability statement2
      Type: token
      Path: (CapabilityStatement2.useContext.value as CodeableConcept)

    • SP_DATE

      public static final String SP_DATE
      Search parameter: date

      Description: The capability statement2 publication date
      Type: date
      Path: CapabilityStatement2.date

      See Also:
    • DATE

      public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
      Fluent Client search parameter constant for date

      Description: The capability statement2 publication date
      Type: date
      Path: CapabilityStatement2.date

    • SP_DESCRIPTION

      public static final String SP_DESCRIPTION
      Search parameter: description

      Description: The description of the capability statement2
      Type: string
      Path: CapabilityStatement2.description

      See Also:
    • DESCRIPTION

      public static final ca.uhn.fhir.rest.gclient.StringClientParam DESCRIPTION
      Fluent Client search parameter constant for description

      Description: The description of the capability statement2
      Type: string
      Path: CapabilityStatement2.description

    • SP_FHIRVERSION

      public static final String SP_FHIRVERSION
      Search parameter: fhirversion

      Description: The version of FHIR
      Type: token
      Path: CapabilityStatement2.version

      See Also:
    • FHIRVERSION

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam FHIRVERSION
      Fluent Client search parameter constant for fhirversion

      Description: The version of FHIR
      Type: token
      Path: CapabilityStatement2.version

    • SP_FORMAT

      public static final String SP_FORMAT
      Search parameter: format

      Description: formats supported (xml | json | ttl | mime type)
      Type: token
      Path: CapabilityStatement2.format

      See Also:
    • FORMAT

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam FORMAT
      Fluent Client search parameter constant for format

      Description: formats supported (xml | json | ttl | mime type)
      Type: token
      Path: CapabilityStatement2.format

    • SP_GUIDE

      public static final String SP_GUIDE
      Search parameter: guide

      Description: Implementation guides supported
      Type: reference
      Path: CapabilityStatement2.implementationGuide

      See Also:
    • GUIDE

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam GUIDE
      Fluent Client search parameter constant for guide

      Description: Implementation guides supported
      Type: reference
      Path: CapabilityStatement2.implementationGuide

    • INCLUDE_GUIDE

      public static final ca.uhn.fhir.model.api.Include INCLUDE_GUIDE
      Constant for fluent queries to be used to add include statements. Specifies the path value of "CapabilityStatement2:guide".
    • SP_JURISDICTION

      public static final String SP_JURISDICTION
      Search parameter: jurisdiction

      Description: Intended jurisdiction for the capability statement2
      Type: token
      Path: CapabilityStatement2.jurisdiction

      See Also:
    • JURISDICTION

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam JURISDICTION
      Fluent Client search parameter constant for jurisdiction

      Description: Intended jurisdiction for the capability statement2
      Type: token
      Path: CapabilityStatement2.jurisdiction

    • SP_MODE

      public static final String SP_MODE
      Search parameter: mode

      Description: Mode - restful (server/client) or messaging (sender/receiver)
      Type: token
      Path: CapabilityStatement2.rest.mode

      See Also:
    • MODE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam MODE
      Fluent Client search parameter constant for mode

      Description: Mode - restful (server/client) or messaging (sender/receiver)
      Type: token
      Path: CapabilityStatement2.rest.mode

    • SP_NAME

      public static final String SP_NAME
      Search parameter: name

      Description: Computationally friendly name of the capability statement2
      Type: string
      Path: CapabilityStatement2.name

      See Also:
    • NAME

      public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME
      Fluent Client search parameter constant for name

      Description: Computationally friendly name of the capability statement2
      Type: string
      Path: CapabilityStatement2.name

    • SP_PUBLISHER

      public static final String SP_PUBLISHER
      Search parameter: publisher

      Description: Name of the publisher of the capability statement2
      Type: string
      Path: CapabilityStatement2.publisher

      See Also:
    • PUBLISHER

      public static final ca.uhn.fhir.rest.gclient.StringClientParam PUBLISHER
      Fluent Client search parameter constant for publisher

      Description: Name of the publisher of the capability statement2
      Type: string
      Path: CapabilityStatement2.publisher

    • SP_RESOURCE_PROFILE

      public static final String SP_RESOURCE_PROFILE
      Search parameter: resource-profile

      Description: A profile id invoked in a capability statement
      Type: reference
      Path: CapabilityStatement2.rest.resource.profile

      See Also:
    • RESOURCE_PROFILE

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam RESOURCE_PROFILE
      Fluent Client search parameter constant for resource-profile

      Description: A profile id invoked in a capability statement
      Type: reference
      Path: CapabilityStatement2.rest.resource.profile

    • INCLUDE_RESOURCE_PROFILE

      public static final ca.uhn.fhir.model.api.Include INCLUDE_RESOURCE_PROFILE
      Constant for fluent queries to be used to add include statements. Specifies the path value of "CapabilityStatement2:resource-profile".
    • SP_RESOURCE

      public static final String SP_RESOURCE
      Search parameter: resource

      Description: Name of a resource mentioned in a capability statement
      Type: token
      Path: CapabilityStatement2.rest.resource.type

      See Also:
    • RESOURCE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam RESOURCE
      Fluent Client search parameter constant for resource

      Description: Name of a resource mentioned in a capability statement
      Type: token
      Path: CapabilityStatement2.rest.resource.type

    • SP_SOFTWARE

      public static final String SP_SOFTWARE
      Search parameter: software

      Description: Part of the name of a software application
      Type: string
      Path: CapabilityStatement2.software.name

      See Also:
    • SOFTWARE

      public static final ca.uhn.fhir.rest.gclient.StringClientParam SOFTWARE
      Fluent Client search parameter constant for software

      Description: Part of the name of a software application
      Type: string
      Path: CapabilityStatement2.software.name

    • SP_STATUS

      public static final String SP_STATUS
      Search parameter: status

      Description: The current status of the capability statement2
      Type: token
      Path: CapabilityStatement2.status

      See Also:
    • STATUS

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
      Fluent Client search parameter constant for status

      Description: The current status of the capability statement2
      Type: token
      Path: CapabilityStatement2.status

    • SP_SUPPORTED_PROFILE

      public static final String SP_SUPPORTED_PROFILE
      Search parameter: supported-profile

      Description: Profiles for use cases supported
      Type: reference
      Path: CapabilityStatement2.rest.resource.supportedProfile

      See Also:
    • SUPPORTED_PROFILE

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUPPORTED_PROFILE
      Fluent Client search parameter constant for supported-profile

      Description: Profiles for use cases supported
      Type: reference
      Path: CapabilityStatement2.rest.resource.supportedProfile

    • INCLUDE_SUPPORTED_PROFILE

      public static final ca.uhn.fhir.model.api.Include INCLUDE_SUPPORTED_PROFILE
      Constant for fluent queries to be used to add include statements. Specifies the path value of "CapabilityStatement2:supported-profile".
    • SP_TITLE

      public static final String SP_TITLE
      Search parameter: title

      Description: The human-friendly name of the capability statement2
      Type: string
      Path: CapabilityStatement2.title

      See Also:
    • TITLE

      public static final ca.uhn.fhir.rest.gclient.StringClientParam TITLE
      Fluent Client search parameter constant for title

      Description: The human-friendly name of the capability statement2
      Type: string
      Path: CapabilityStatement2.title

    • SP_URL

      public static final String SP_URL
      Search parameter: url

      Description: The uri that identifies the capability statement2
      Type: uri
      Path: CapabilityStatement2.url

      See Also:
    • URL

      public static final ca.uhn.fhir.rest.gclient.UriClientParam URL
      Fluent Client search parameter constant for url

      Description: The uri that identifies the capability statement2
      Type: uri
      Path: CapabilityStatement2.url

    • SP_VERSION

      public static final String SP_VERSION
      Search parameter: version

      Description: The business version of the capability statement2
      Type: token
      Path: CapabilityStatement2.version

      See Also:
    • VERSION

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam VERSION
      Fluent Client search parameter constant for version

      Description: The business version of the capability statement2
      Type: token
      Path: CapabilityStatement2.version

  • Constructor Details

  • Method Details