Skip to main content

CapabilityStatement

Struct CapabilityStatement 

Source
pub struct CapabilityStatement {
Show 35 fields pub id: Option<Id>, 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 version: Option<String>, 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 jurisdiction: Vec<CodeableConcept>, pub purpose: Option<Markdown>, pub copyright: Option<Markdown>, pub kind: Code, pub instantiates: Vec<Uri>, pub software: Option<CapabilityStatementSoftware>, pub implementation: Option<CapabilityStatementImplementation>, pub fhir_version: Id, pub accept_unknown: Code, pub format: Vec<Code>, pub patch_format: Vec<Code>, pub implementation_guide: Vec<Uri>, pub profile: Vec<Reference>, 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 that may be used as a statement of actual server functionality or a statement of required or desired server implementation.

Fields§

§id: Option<Id>

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 may 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.

§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 may 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, and nor can they have their own independent transaction scope.

§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. In order to make the use of extensions safe and manageable, 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.

§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. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, 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.

§url: Option<Uri>

Logical URI to reference this capability statement (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. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this capability statement is (or will be) published. The URL SHOULD include the major version of the capability statement. For more information see [Technical and Business Versions](resource.html#versions).

§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.

§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: Code

draft | active | retired | unknown

The status of this capability statement. Enables tracking the life-cycle of the content.

§experimental: Option<Boolean>

For testing purposes, not real usage

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: DateTime

Date this was last changed

The date (and optionally time) when the capability statement was published. The date must change if and 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 (organization or individual)

The name of the individual or organization that published 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>

Context the content is intended to support

The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate capability statement instances.

§jurisdiction: Vec<CodeableConcept>

Intended jurisdiction for capability statement (if applicable)

A legal or geographic region in which the capability statement is intended to be used.

§purpose: Option<Markdown>

Why this capability statement is defined

Explaination of why this capability statement is needed and why it has been designed as it has.

§copyright: Option<Markdown>

Use and/or publishing restrictions

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: Code

instance | 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<Uri>

Canonical URL of another capability statement this implements

Reference to a canonical URL of another CapabilityStatement that this software implements or uses. This capability statement is a published API description that corresponds to a business service. The rest of the capability statement does not need to repeat the details of the referenced resource, but can do so.

§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: Id

FHIR Version the system uses

The version of the FHIR specification on which this capability statement is based.

§accept_unknown: Code

no | extensions | elements | both

A code that indicates whether the application accepts unknown elements or extensions when reading resources.

§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

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

§implementation_guide: Vec<Uri>

Implementation guides supported

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

§profile: Vec<Reference>

Profiles for use cases supported

A list of profiles that represent different use cases supported by the system. For a server, “supported by the system” means the system hosts/produces a set of resources that are conformant to a particular profile, and allows clients that use its services to search using this profile and to find appropriate data. For a client, it means the system will search by this profile and process data according to the guidance implicit in the profile. See further discussion in [Using Profiles](profiling.html#profile-uses).

§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.

Trait Implementations§

Source§

impl Clone for CapabilityStatement

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for CapabilityStatement

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for CapabilityStatement

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for CapabilityStatement

Source§

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for CapabilityStatement

Source§

impl Json for CapabilityStatement

Source§

fn to_json(&self) -> Result<Object, EncodeError>

The JSON object. Read more
Source§

fn from_json(object: &Object, path: &mut Path) -> Result<Self, DecodeError>

Decodes object, refusing unknown properties. Read more
Source§

impl PartialEq for CapabilityStatement

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for CapabilityStatement

Source§

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for CapabilityStatement

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.