pub struct CapabilityStatementRestResource {Show 18 fields
pub id: Option<String>,
pub extension: Vec<Extension>,
pub modifier_extension: Vec<Extension>,
pub type: Code,
pub profile: Option<Reference>,
pub documentation: Option<Markdown>,
pub interaction: Vec<CapabilityStatementRestResourceInteraction>,
pub versioning: Option<Code>,
pub read_history: Option<Boolean>,
pub update_create: Option<Boolean>,
pub conditional_create: Option<Boolean>,
pub conditional_read: Option<Code>,
pub conditional_update: Option<Boolean>,
pub conditional_delete: Option<Code>,
pub reference_policy: Vec<Code>,
pub search_include: Vec<String>,
pub search_rev_include: Vec<String>,
pub search_param: Vec<CapabilityStatementRestResourceSearchParam>,
}Expand description
Resource served on the REST interface
A specification of the restful capabilities of the solution for a specific resource type.
Fields§
§id: Option<String>xml:id (or equivalent in JSON)
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. 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 element, 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.
type: CodeA resource type that is supported
A type of resource exposed via the restful interface.
profile: Option<Reference>Base System profile for all uses of resource
A specification of the profile that describes the solution’s overall support for the resource, including any constraints on cardinality, bindings, lengths or other limitations. See further discussion in [Using Profiles](profiling.html#profile-uses).
documentation: Option<Markdown>Additional information about the use of the resource type
Additional information about the resource type used by the system.
interaction: Vec<CapabilityStatementRestResourceInteraction>What operations are supported?
Identifies a restful operation supported by the solution.
versioning: Option<Code>no-version | versioned | versioned-update
This field is set to no-version to specify that the system does not support (server) or use (client) versioning for this resource type. If this has some other value, the server must at least correctly track and populate the versionId meta-property on resources. If the value is ‘versioned-update’, then the server supports all the versioning features, including using e-tags for version integrity in the API.
read_history: Option<Boolean>Whether vRead can return past versions
A flag for whether the server is able to return past versions as part of the vRead operation.
update_create: Option<Boolean>If update can commit to a new identity
A flag to indicate that the server allows or needs to allow the client to create new identities on the server (e.g. that is, the client PUTs to a location where there is no existing resource). Allowing this operation means that the server allows the client to create new identities on the server.
conditional_create: Option<Boolean>If allows/uses conditional create
A flag that indicates that the server supports conditional create.
conditional_read: Option<Code>not-supported | modified-since | not-match | full-support
A code that indicates how the server supports conditional read.
conditional_update: Option<Boolean>If allows/uses conditional update
A flag that indicates that the server supports conditional update.
conditional_delete: Option<Code>not-supported | single | multiple - how conditional delete is supported
A code that indicates how the server supports conditional delete.
reference_policy: Vec<Code>literal | logical | resolves | enforced | local
A set of flags that defines how references are supported.
search_include: Vec<String>_include values supported by the server
A list of _include values supported by the server.
search_rev_include: Vec<String>_revinclude values supported by the server
A list of _revinclude (reverse include) values supported by the server.
search_param: Vec<CapabilityStatementRestResourceSearchParam>Search parameters supported by implementation
Search parameters 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.