Configuring CapabilityStatement responce
In the FHIR specification, the CapabilityStatement resource describes the functionality of the server. It is used as a statement of the features of a FHIR-conformant system or as a set of rules that an application must provide.
Kodjin FHIR Server responds with a CapabilityStatement resource when a client sends a request to the metadata endpoint [base url]/metadata
Example:
The CapabilityStatement has static and dynamic parts. The dynamic part corresponds to the rest object in the CapabilityStatement and depends on uploaded profiles (implementation guides) for FHIR resources, terminologies (CodeSystem, ValueSet), extensions, and search parameters, enabled or disabled history as well as Smart on FHIR capabilities. The static part defines metadata for the system, including version, publisher, description, and supported formats (MIME types), etc.
The Kodjin FHIR Server provides an option to configure the static part in the template. To define or change the static section, follow Kodjin's configuration section.
Static parameters include:
| Name | Description |
|---|---|
| version | The identifier that is used to identify this version of the capability statement when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the capability statement 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 | A natural language name identifying the capability statement. This name should be usable as an identifier for the module by machine processing applications such as code generation. |
| title | A short, descriptive, user-friendly title for the capability statement. |
| status | The status of this capability statement. Enables tracking the life-cycle of the content.draft | active | retired | unknownValue Set: PublicationStatus (Required) |
| fhirVersion | The version of the FHIR specification that this CapabilityStatement describes (which SHALL be the same as the FHIR version of the CapabilityStatement itself). Value Set: FHIRVersion (Required) |
| contact | Contact details to assist a user in finding and communicating with the publisher. |
| description | A free text natural language description of the capability statement 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. |
| experimental | A Boolean value to indicate that this capability statement is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. |
| date | The date (and optionally time) when the capability statement 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 statement changes. |
| publisher | he name of the organization or individual that published the capability statement. |
| 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 statement instances. |
| jurisdiction | A legal or geographic region in which the capability statement is intended to be used (if applicable) Value Set: Jurisdiction (Extensible) |
| purpose | Explanation of why this capability statement is needed and why it has been designed as it has. |
| copyright | A copyright statement relating to the capability statement and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the capability statement. |
| 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). instance | capability | requirementsValue Set: CapabilityStatementKind (Required) |
| imports | Reference to a canonical URL of another CapabilityStatement 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. |
| name | A name the software is known by |
| version | Version covered by this statement |
| releaseDate | Date this version was released |
| 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 |
| description | Describes this specific instance |
| url | Base URL for the installation |
| custodian | Organization that manages the data |
| patchFormat | A list of the patch formats supported by this implementation using their content types. Value Set: MimeType (Required) |
| implementationGuide | A list of implementation guides that the server does (or should) support in their entirety. |