pub struct CapabilityStatementRest {
pub id: Option<String>,
pub extension: Vec<Extension>,
pub modifier_extension: Vec<Extension>,
pub mode: Code,
pub documentation: Option<Markdown>,
pub security: Option<CapabilityStatementRestSecurity>,
pub resource: Vec<CapabilityStatementRestResource>,
pub interaction: Vec<CapabilityStatementRestInteraction>,
pub search_param: Vec<CapabilityStatementRestResourceSearchParam>,
pub operation: Vec<CapabilityStatementRestResourceOperation>,
pub compartment: Vec<Canonical>,
}Expand description
If the endpoint is a RESTful one
A definition of the restful capabilities of the solution, if any.
Fields§
§id: Option<String>Unique id for inter-element referencing
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
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 element. 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 even if unrecognized
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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).
mode: Codeclient | server
Identifies whether this portion of the statement is describing the ability to initiate or receive restful operations.
documentation: Option<Markdown>General description of implementation
Information about the system’s restful capabilities that apply across all applications, such as security.
security: Option<CapabilityStatementRestSecurity>Information about security of implementation
Information about security implementation from an interface perspective - what a client needs to know.
resource: Vec<CapabilityStatementRestResource>Resource served on the REST interface
A specification of the restful capabilities of the solution for a specific resource type.
interaction: Vec<CapabilityStatementRestInteraction>What operations are supported?
A specification of restful operations supported by the system.
search_param: Vec<CapabilityStatementRestResourceSearchParam>Search parameters for searching all resources
Search parameters that are supported for searching all resources for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation. This is only for searches executed against the system-level endpoint.
operation: Vec<CapabilityStatementRestResourceOperation>Definition of a system level operation
Definition of an operation or a named query together with its parameters and their meaning and type.
compartment: Vec<Canonical>Compartments served/used by system
An absolute URI which is a reference to the definition of a compartment that the system supports. The reference is to a CompartmentDefinition resource by its canonical URL .