pub struct CapabilityStatement {Show 39 fields
pub id: Option<String>,
pub meta: Option<Meta>,
pub implicit_rules: Option<Uri>,
pub language: Option<Code>,
pub text: Option<Narrative>,
pub contained: Vec<Resource>,
pub extension: Vec<Extension>,
pub modifier_extension: Vec<Extension>,
pub url: Option<Uri>,
pub identifier: Vec<Identifier>,
pub version: Option<String>,
pub version_algorithm: Option<CapabilityStatementVersionAlgorithm>,
pub name: Option<String>,
pub title: Option<String>,
pub status: Code,
pub experimental: Option<Boolean>,
pub date: DateTime,
pub publisher: Option<String>,
pub contact: Vec<ContactDetail>,
pub description: Option<Markdown>,
pub use_context: Vec<UsageContext>,
pub actor_definition: Vec<Canonical>,
pub jurisdiction: Vec<CodeableConcept>,
pub purpose: Option<Markdown>,
pub copyright: Option<Markdown>,
pub copyright_label: Option<String>,
pub kind: Code,
pub instantiates: Vec<Canonical>,
pub imports: Vec<Canonical>,
pub software: Option<CapabilityStatementSoftware>,
pub implementation: Option<CapabilityStatementImplementation>,
pub fhir_version: Code,
pub format: Vec<Code>,
pub patch_format: Vec<Code>,
pub accept_language: Vec<Code>,
pub implementation_guide: Vec<Canonical>,
pub rest: Vec<CapabilityStatementRest>,
pub messaging: Vec<CapabilityStatementMessaging>,
pub document: Vec<CapabilityStatementDocument>,
}Expand description
A statement of system capabilities
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.
Fields§
§id: Option<String>Logical id of this artifact
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta: Option<Meta>Metadata about the resource
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicit_rules: Option<Uri>A set of rules under which this content was created
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. For DomainResources, if more than one implicitRules policy applies, additional policies may be conveyed using the [additionalImplicitRules](https://build.fhir.org/ig/HL7/fhir-extensions/StructureDefinition-additionalImplicitRules.html) extension.
language: Option<Code>Language of the resource content
The base language in which the resource is written.
text: Option<Narrative>Text summary of the resource, for human interpretation
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it “clinically safe” for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained: Vec<Resource>Contained, inline Resources
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.
extension: Vec<Extension>Additional content defined by implementations
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifier_extension: Vec<Extension>Extensions that cannot be ignored
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element’s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
url: Option<Uri>Canonical identifier for this capability statement, represented as a URI (globally unique)
An absolute URI that is used to identify this capability statement 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 an authoritative instance of this capability statement is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the capability statement is stored on different servers.
identifier: Vec<Identifier>Additional identifier for the CapabilityStatement (business identifier)
A formal identifier that is used to identify this CapabilityStatement when it is represented in other formats, or referenced in a specification, model, design or an instance.
version: Option<String>Business version of the capability statement
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.
version_algorithm: Option<CapabilityStatementVersionAlgorithm>How to compare versions
Indicates the mechanism used to compare versions to determine which is more current.
name: Option<String>Name for this capability statement (computer friendly)
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: Option<String>Name for this capability statement (human friendly)
A short, descriptive, user-friendly title for the capability statement.
status: Codedraft | active | retired | unknown
The status of this capability statement. Enables tracking the life-cycle of the content.
experimental: Option<Boolean>For testing only - never for real usage
A Boolean value to indicate that this capability statement is authored for testing purposes (or education/evaluation/marketing) and no version of this resource will ever be intended for genuine usage.
date: DateTimeDate last changed
The date (and optionally time) when the capability statement was last significantly changed. 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: Option<String>Name of the publisher/steward (organization or individual)
The name of the organization or individual responsible for the release and ongoing maintenance of the capability statement.
contact: Vec<ContactDetail>Contact details for the publisher
Contact details to assist a user in finding and communicating with the publisher.
description: Option<Markdown>Natural language description of the capability statement
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.
use_context: Vec<UsageContext>The context that the content is intended to support
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.
actor_definition: Vec<Canonical>ActorDefinitions the CapabilityStatement supports
ActorDefinitions to describe the specific sets of functionality supported by (or that should be supported by) systems (via obligations).
jurisdiction: Vec<CodeableConcept>Jurisdiction of the authority that maintains the capability statement (if applicable)
A legal or geographic region in which the authority that maintains the resource is operating. In general, the jurisdiction is also found in the useContext. The useContext may reference additional jurisdictions because the defining jurisdiction does not necessarily limit the jurisdictions of use.
purpose: Option<Markdown>Why this capability statement is defined
Explanation of why this capability statement is needed and why it has been designed as it has.
copyright: Option<Markdown>Notice about intellectual property ownership, can include restrictions on use
A copyright statement relating to the capability statement and/or its contents. Copyright statements are notices of intellectual property ownership and can include restrictions on the use and publishing of the capability statement.
copyright_label: Option<String>Copyright holder and year(s)
A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are restricted. (e.g. ‘All rights reserved’, ‘Some rights reserved’).
kind: Codeinstance | capability | requirements
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: Vec<Canonical>Canonical URL of another capability statement this implements
Reference to a canonical URL of another CapabilityStatement 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: Vec<Canonical>Canonical URL of another capability statement this adds to
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: Option<CapabilityStatementSoftware>Software that is covered by this capability statement
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: Option<CapabilityStatementImplementation>If this describes a specific instance
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.
fhir_version: CodeFHIR Version the system supports
The version of the FHIR specification that this CapabilityStatement describes (which SHALL be the same as the FHIR version of the CapabilityStatement itself). There is no default value.
format: Vec<Code>formats supported (xml | json | ttl | mime type)
A list of the formats supported by this implementation using their content types.
patch_format: Vec<Code>Patch formats supported (Mime types for FHIR and JSON And XML Patch)
A list of the patch formats supported by this implementation using their content types.
accept_language: Vec<Code>Languages supported
A list of the languages supported by this implementation that are usefully supported in the ```Accept-Language``` header.
implementation_guide: Vec<Canonical>Implementation guides supported
A list of implementation guides that the server does (or should) support in their entirety.
rest: Vec<CapabilityStatementRest>If the endpoint is a RESTful one
A definition of the restful capabilities of the solution, if any.
messaging: Vec<CapabilityStatementMessaging>If messaging is supported
A description of the messaging capabilities of the solution.
document: Vec<CapabilityStatementDocument>Document definition
A document definition.