Struct CapabilityStatementBuilder

pub struct CapabilityStatementBuilder { /* private fields */ }

Builder for CapabilityStatementInner.

Implementations

impl CapabilityStatementBuilder

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

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.

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

pub fn meta(self, value: Meta) -> CapabilityStatementBuilder

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.

pub fn implicit_rules(self, value: String) -> CapabilityStatementBuilder

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.

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

pub fn language(self, value: String) -> CapabilityStatementBuilder

Language; Language of the resource content

The base language in which the resource is written.

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

pub fn text(self, value: Narrative) -> CapabilityStatementBuilder

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 resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a “text blob” or where text is additionally entered raw or narrated and encoded information is added later.

pub fn contained(self, value: Vec<Resource>) -> CapabilityStatementBuilder

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.

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

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

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.

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>, ) -> CapabilityStatementBuilder

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

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 url(self, value: String) -> CapabilityStatementBuilder

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.

Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions.

In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.

pub fn url_ext(self, value: FieldExtension) -> CapabilityStatementBuilder

Extension field.

pub fn identifier( self, value: Vec<Option<Identifier>>, ) -> CapabilityStatementBuilder

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.

pub fn identifier_ext( self, value: Vec<Option<FieldExtension>>, ) -> CapabilityStatementBuilder

Extension field.

pub fn version(self, value: String) -> CapabilityStatementBuilder

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.

There may be different capability statement instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the capability statement with the format [url]|[version]. The version SHOULD NOT contain a ‘#’ - see Business Version.

pub fn version_ext(self, value: FieldExtension) -> CapabilityStatementBuilder

Extension field.

pub fn version_algorithm( self, value: CapabilityStatementVersionAlgorithm, ) -> CapabilityStatementBuilder

How to compare versions

Indicates the mechanism used to compare versions to determine which is more current.

If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can’t be successfully be determined.

pub fn version_algorithm_ext( self, value: CapabilityStatementVersionAlgorithmExtension, ) -> CapabilityStatementBuilder

Extension field.

pub fn name(self, value: String) -> CapabilityStatementBuilder

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.

The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.

pub fn name_ext(self, value: FieldExtension) -> CapabilityStatementBuilder

Extension field.

pub fn title(self, value: String) -> CapabilityStatementBuilder

Name for this capability statement (human friendly)

A short, descriptive, user-friendly title for the capability statement.

This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

pub fn title_ext(self, value: FieldExtension) -> CapabilityStatementBuilder

Extension field.

pub fn status(self, value: PublicationStatus) -> CapabilityStatementBuilder

PublicationStatus; draft | active | retired | unknown

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

Allows filtering of capability statements that are appropriate for use versus not.This is not intended for use with actual capability statements, but where capability statements are used to describe possible or desired systems.

See guidance around (not) making local changes to elements here.

pub fn status_ext(self, value: FieldExtension) -> CapabilityStatementBuilder

Extension field.

pub fn experimental(self, value: bool) -> CapabilityStatementBuilder

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.

Allows filtering of capability statements that are appropriate for use versus not.

pub fn experimental_ext( self, value: FieldExtension, ) -> CapabilityStatementBuilder

Extension field.

pub fn date(self, value: DateTime) -> CapabilityStatementBuilder

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

The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the capability statement. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

See guidance around (not) making local changes to elements here.

pub fn date_ext(self, value: FieldExtension) -> CapabilityStatementBuilder

Extension field.

pub fn publisher(self, value: String) -> CapabilityStatementBuilder

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.

Usually an organization but may be an individual. The publisher (or steward) of the capability statement is the organization or individual primarily responsible for the maintenance and upkeep of the capability statement. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the capability statement. This item SHOULD be populated unless the information is available from context.

pub fn publisher_ext(self, value: FieldExtension) -> CapabilityStatementBuilder

Extension field.

pub fn contact( self, value: Vec<Option<ContactDetail>>, ) -> CapabilityStatementBuilder

Contact details for the publisher

Contact details to assist a user in finding and communicating with the publisher.

May be a web site, an email address, a telephone number, etc.

See guidance around (not) making local changes to elements here.

pub fn contact_ext( self, value: Vec<Option<FieldExtension>>, ) -> CapabilityStatementBuilder

Extension field.

pub fn description(self, value: String) -> CapabilityStatementBuilder

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.

This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the capability statement as conveyed in the ‘text’ field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the capability statement is presumed to be the predominant language in the place the capability statement was created).This does not need to be populated if the description is adequately implied by the software or implementation details.

pub fn description_ext( self, value: FieldExtension, ) -> CapabilityStatementBuilder

Extension field.

pub fn use_context( self, value: Vec<Option<UsageContext>>, ) -> CapabilityStatementBuilder

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.

When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

pub fn use_context_ext( self, value: Vec<Option<FieldExtension>>, ) -> CapabilityStatementBuilder

Extension field.

pub fn jurisdiction( self, value: Vec<Option<CodeableConcept>>, ) -> CapabilityStatementBuilder

Jurisdiction; Intended jurisdiction for capability statement (if applicable)

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

It may be possible for the capability statement to be used in jurisdictions other than those for which it was originally designed or intended.

DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new ‘jurisdiction’ code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)

pub fn jurisdiction_ext( self, value: Vec<Option<FieldExtension>>, ) -> CapabilityStatementBuilder

Extension field.

pub fn purpose(self, value: String) -> CapabilityStatementBuilder

Why this capability statement is defined

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

This element does not describe the usage of the capability statement. Instead, it provides traceability of ’‘why’’ the resource is either needed or ’‘why’’ it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this capability statement.

pub fn purpose_ext(self, value: FieldExtension) -> CapabilityStatementBuilder

Extension field.

pub fn copyright(self, value: String) -> CapabilityStatementBuilder

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.

…

pub fn copyright_ext(self, value: FieldExtension) -> CapabilityStatementBuilder

Extension field.

pub fn copyright_label(self, value: String) -> CapabilityStatementBuilder

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 resctricted. (e.g. ‘All rights reserved’, ‘Some rights reserved’).

The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general ‘copyright’ element.

pub fn copyright_label_ext( self, value: FieldExtension, ) -> CapabilityStatementBuilder

Extension field.

pub fn kind(self, value: CapabilityStatementKind) -> CapabilityStatementBuilder

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

pub fn kind_ext(self, value: FieldExtension) -> CapabilityStatementBuilder

Extension field.

pub fn instantiates( self, value: Vec<Option<String>>, ) -> CapabilityStatementBuilder

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.

HL7 defines the following Services: Terminology Service.

Many Implementation Guides define additional services.

pub fn instantiates_ext( self, value: Vec<Option<FieldExtension>>, ) -> CapabilityStatementBuilder

Extension field.

pub fn imports(self, value: Vec<Option<String>>) -> CapabilityStatementBuilder

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.

the contents of any directly or indirectly imported CapabilityStatements SHALL NOT overlap, i.e. they cannot refer to the same rest/resource, operations/name, searchparam/name, interaction/code, messaging/endpoint, document/mode pair.

A capability statement that imports another CapabilityStatement automatically instantiates it too (though this is often not a very useful statement for the kinds of CapabilityStatements that are suitable for importing).

pub fn imports_ext( self, value: Vec<Option<FieldExtension>>, ) -> CapabilityStatementBuilder

Extension field.

pub fn software( self, value: CapabilityStatementSoftware, ) -> CapabilityStatementBuilder

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.

pub fn software_ext(self, value: FieldExtension) -> CapabilityStatementBuilder

Extension field.

pub fn implementation( self, value: CapabilityStatementImplementation, ) -> CapabilityStatementBuilder

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.

pub fn implementation_ext( self, value: FieldExtension, ) -> CapabilityStatementBuilder

Extension field.

pub fn fhir_version(self, value: FHIRVersion) -> CapabilityStatementBuilder

FHIRVersion; FHIR 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.

Servers may implement multiple versions (see Managing Multiple Versions, and the $versions operation). If they do, and the CapabilityStatement is requested from the server, then this fhirVersion will be either the version requested, or the server’s default version.

pub fn fhir_version_ext( self, value: FieldExtension, ) -> CapabilityStatementBuilder

Extension field.

pub fn format(self, value: Vec<Option<String>>) -> CapabilityStatementBuilder

MimeType; formats supported (xml | json | ttl | mime type)

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

“xml”, “json” and “ttl” are allowed, which describe the simple encodings described in the specification (and imply appropriate bundle support). Otherwise, mime types are legal here.

pub fn format_ext( self, value: Vec<Option<FieldExtension>>, ) -> CapabilityStatementBuilder

Extension field.

pub fn patch_format( self, value: Vec<Option<String>>, ) -> CapabilityStatementBuilder

MimeType; Patch formats supported

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

At present, the patch mime types application/json-patch+json and application/xml-patch+xml are legal. Generally, if a server supports PATCH, it would be expected to support the patch formats and match the formats it supports, but this is not always possible or necessary.

pub fn patch_format_ext( self, value: Vec<Option<FieldExtension>>, ) -> CapabilityStatementBuilder

Extension field.

pub fn accept_language( self, value: Vec<Option<String>>, ) -> CapabilityStatementBuilder

Language; Languages supported

A list of the languages supported by this implementation that are usefully supported in the textAccept-Language header.

In general, if a server gets a request with an Accept-Language that it doesn’t support, it should still reutrn the resource, just in its default language for the resource.

pub fn accept_language_ext( self, value: Vec<Option<FieldExtension>>, ) -> CapabilityStatementBuilder

Extension field.

pub fn implementation_guide( self, value: Vec<Option<String>>, ) -> CapabilityStatementBuilder

Implementation guides supported

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

Note: this is primarily only relevant in terms of ImplementationGuides that don’t define specific CapabilityStatements declaring the expectation of distinct roles. (E.g. generic IGs that establish privacy policies.) In situations where an ImplementationGuide does define CapabilityStatements, asserting CapabilityStatement.implementationGuide means that the implementation adheres to any Implementation.global definitions present in that IG as well as any textual requirements around security or other general interoperability behaviors. However, it does not make any assertions as to conformance with any of the CapabilityStatements defined in the IG. To assert conformance with CapabilityStatements in a referenced IG, it is necessary to use the CapabilityStatement.instantiates element.

pub fn implementation_guide_ext( self, value: Vec<Option<FieldExtension>>, ) -> CapabilityStatementBuilder

Extension field.

pub fn rest( self, value: Vec<Option<CapabilityStatementRest>>, ) -> CapabilityStatementBuilder

If the endpoint is a RESTful one

A definition of the restful capabilities of the solution, if any.

Multiple repetitions allow definition of both client and/or server behaviors or possibly behaviors under different configuration settings (for software or requirements statements).

pub fn rest_ext( self, value: Vec<Option<FieldExtension>>, ) -> CapabilityStatementBuilder

Extension field.

pub fn messaging( self, value: Vec<Option<CapabilityStatementMessaging>>, ) -> CapabilityStatementBuilder

If messaging is supported

A description of the messaging capabilities of the solution.

Multiple repetitions allow the documentation of multiple endpoints per solution.

pub fn messaging_ext( self, value: Vec<Option<FieldExtension>>, ) -> CapabilityStatementBuilder

Extension field.

pub fn document( self, value: Vec<Option<CapabilityStatementDocument>>, ) -> CapabilityStatementBuilder

Document definition

A document definition.

pub fn document_ext( self, value: Vec<Option<FieldExtension>>, ) -> CapabilityStatementBuilder

Extension field.

pub fn build_inner(self) -> Result<CapabilityStatementInner, BuilderError>

Builds a new CapabilityStatementInner.

Errors

If a required field has not been initialized.

impl CapabilityStatementBuilder

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

Finalize building CapabilityStatement.

Trait Implementations

impl Default for CapabilityStatementBuilder

fn default() -> CapabilityStatementBuilder

Returns the “default value” for a type.