Struct CapabilityStatementRestBuilder

pub struct CapabilityStatementRestBuilder { /* private fields */ }

Builder for CapabilityStatementRest.

Implementations

impl CapabilityStatementRestBuilder

pub fn id(self, value: String) -> CapabilityStatementRestBuilder

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.

pub fn extension(self, value: Vec<Extension>) -> CapabilityStatementRestBuilder

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.

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

pub fn modifier_extension( self, value: Vec<Extension>, ) -> CapabilityStatementRestBuilder

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

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

pub fn mode( self, value: RestfulCapabilityMode, ) -> CapabilityStatementRestBuilder

RestfulCapabilityMode; client | server

Identifies whether this portion of the statement is describing the ability to initiate or receive restful operations.

pub fn mode_ext(self, value: FieldExtension) -> CapabilityStatementRestBuilder

Extension field.

pub fn documentation(self, value: String) -> CapabilityStatementRestBuilder

General description of implementation

Information about the system’s restful capabilities that apply across all applications, such as security.

pub fn documentation_ext( self, value: FieldExtension, ) -> CapabilityStatementRestBuilder

Extension field.

pub fn security( self, value: CapabilityStatementRestSecurity, ) -> CapabilityStatementRestBuilder

Information about security of implementation

Information about security implementation from an interface perspective - what a client needs to know.

pub fn security_ext( self, value: FieldExtension, ) -> CapabilityStatementRestBuilder

Extension field.

pub fn resource( self, value: Vec<Option<CapabilityStatementRestResource>>, ) -> CapabilityStatementRestBuilder

Resource served on the REST interface

A specification of the restful capabilities of the solution for a specific resource type.

Max of one repetition per resource type.

pub fn resource_ext( self, value: Vec<Option<FieldExtension>>, ) -> CapabilityStatementRestBuilder

Extension field.

pub fn interaction( self, value: Vec<Option<CapabilityStatementRestInteraction>>, ) -> CapabilityStatementRestBuilder

What operations are supported?

A specification of restful operations supported by the system.

pub fn interaction_ext( self, value: Vec<Option<FieldExtension>>, ) -> CapabilityStatementRestBuilder

Extension field.

pub fn search_param( self, value: Vec<Option<CapabilityStatementRestResourceSearchParam>>, ) -> CapabilityStatementRestBuilder

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.

Typically, the only search parameters supported for all searches are those that apply to all resources - tags, profiles, text search etc. These search parameters should include the control search parameters such as _sort, _count, etc. that also apply to this resource (though many will be listed at CapabilityStatement.rest.searchParam). The behavior of some search parameters may be further described by other code or extension elements, or narrative within the capability statement or linked SearchParameter definitions.

pub fn search_param_ext( self, value: Vec<Option<FieldExtension>>, ) -> CapabilityStatementRestBuilder

Extension field.

pub fn operation( self, value: Vec<Option<CapabilityStatementRestResourceOperation>>, ) -> CapabilityStatementRestBuilder

Definition of a system level operation

Definition of an operation or a named query together with its parameters and their meaning and type.

CapabilityStatement.rest.operation is for operations invoked at the system level, or for operations that are supported across multiple resource types. Operations linked from CapabilityStatement.rest.operation must have OperationDefinition.system = true, or more than one Operation.resource.

pub fn operation_ext( self, value: Vec<Option<FieldExtension>>, ) -> CapabilityStatementRestBuilder

Extension field.

pub fn compartment( self, value: Vec<Option<String>>, ) -> CapabilityStatementRestBuilder

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 .

At present, the only defined compartments are at CompartmentDefinition.

pub fn compartment_ext( self, value: Vec<Option<FieldExtension>>, ) -> CapabilityStatementRestBuilder

Extension field.

pub fn build(self) -> Result<CapabilityStatementRest, BuilderError>

Builds a new CapabilityStatementRest.

Errors

If a required field has not been initialized.

Trait Implementations

impl Default for CapabilityStatementRestBuilder

fn default() -> CapabilityStatementRestBuilder

Returns the “default value” for a type.