pub struct RequirementsBuilder { /* private fields */ }
Expand description
Builder for RequirementsInner
.
Implementations§
Source§impl RequirementsBuilder
impl RequirementsBuilder
Sourcepub fn id(self, value: String) -> RequirementsBuilder
pub fn id(self, value: String) -> RequirementsBuilder
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.
Sourcepub fn meta(self, value: Meta) -> RequirementsBuilder
pub fn meta(self, value: Meta) -> RequirementsBuilder
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.
Sourcepub fn implicit_rules(self, value: String) -> RequirementsBuilder
pub fn implicit_rules(self, value: String) -> RequirementsBuilder
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.
Sourcepub fn language(self, value: String) -> RequirementsBuilder
pub fn language(self, value: String) -> RequirementsBuilder
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).
Sourcepub fn text(self, value: Narrative) -> RequirementsBuilder
pub fn text(self, value: Narrative) -> RequirementsBuilder
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.
Sourcepub fn contained(self, value: Vec<Resource>) -> RequirementsBuilder
pub fn contained(self, value: Vec<Resource>) -> RequirementsBuilder
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.
Sourcepub fn extension(self, value: Vec<Extension>) -> RequirementsBuilder
pub fn extension(self, value: Vec<Extension>) -> RequirementsBuilder
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.
Sourcepub fn modifier_extension(self, value: Vec<Extension>) -> RequirementsBuilder
pub fn modifier_extension(self, value: Vec<Extension>) -> RequirementsBuilder
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.
Sourcepub fn url(self, value: String) -> RequirementsBuilder
pub fn url(self, value: String) -> RequirementsBuilder
Canonical identifier for this Requirements, represented as a URI (globally unique)
An absolute URI that is used to identify this Requirements 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 Requirements is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the Requirements 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.
Sourcepub fn url_ext(self, value: FieldExtension) -> RequirementsBuilder
pub fn url_ext(self, value: FieldExtension) -> RequirementsBuilder
Extension field.
Sourcepub fn identifier(self, value: Vec<Option<Identifier>>) -> RequirementsBuilder
pub fn identifier(self, value: Vec<Option<Identifier>>) -> RequirementsBuilder
Additional identifier for the Requirements (business identifier)
A formal identifier that is used to identify this Requirements when it is represented in other formats, or referenced in a specification, model, design or an instance.
Sourcepub fn identifier_ext(
self,
value: Vec<Option<FieldExtension>>,
) -> RequirementsBuilder
pub fn identifier_ext( self, value: Vec<Option<FieldExtension>>, ) -> RequirementsBuilder
Extension field.
Sourcepub fn version(self, value: String) -> RequirementsBuilder
pub fn version(self, value: String) -> RequirementsBuilder
Business version of the Requirements
The identifier that is used to identify this version of the Requirements when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the Requirements 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 Requirements 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 Requirements with the format [url]|[version]. The version SHOULD NOT contain a ‘#’ - see Business Version.
Sourcepub fn version_ext(self, value: FieldExtension) -> RequirementsBuilder
pub fn version_ext(self, value: FieldExtension) -> RequirementsBuilder
Extension field.
Sourcepub fn version_algorithm(
self,
value: RequirementsVersionAlgorithm,
) -> RequirementsBuilder
pub fn version_algorithm( self, value: RequirementsVersionAlgorithm, ) -> RequirementsBuilder
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.
Sourcepub fn version_algorithm_ext(
self,
value: RequirementsVersionAlgorithmExtension,
) -> RequirementsBuilder
pub fn version_algorithm_ext( self, value: RequirementsVersionAlgorithmExtension, ) -> RequirementsBuilder
Extension field.
Sourcepub fn name(self, value: String) -> RequirementsBuilder
pub fn name(self, value: String) -> RequirementsBuilder
Name for this Requirements (computer friendly)
A natural language name identifying the Requirements. 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.
Sourcepub fn name_ext(self, value: FieldExtension) -> RequirementsBuilder
pub fn name_ext(self, value: FieldExtension) -> RequirementsBuilder
Extension field.
Sourcepub fn title(self, value: String) -> RequirementsBuilder
pub fn title(self, value: String) -> RequirementsBuilder
Name for this Requirements (human friendly)
A short, descriptive, user-friendly title for the Requirements.
This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
Sourcepub fn title_ext(self, value: FieldExtension) -> RequirementsBuilder
pub fn title_ext(self, value: FieldExtension) -> RequirementsBuilder
Extension field.
Sourcepub fn status(self, value: PublicationStatus) -> RequirementsBuilder
pub fn status(self, value: PublicationStatus) -> RequirementsBuilder
PublicationStatus; draft | active | retired | unknown
The status of this Requirements. Enables tracking the life-cycle of the content.
Allows filtering of Requirements that are appropriate for use versus not.
See guidance around (not) making local changes to elements here.
Sourcepub fn status_ext(self, value: FieldExtension) -> RequirementsBuilder
pub fn status_ext(self, value: FieldExtension) -> RequirementsBuilder
Extension field.
Sourcepub fn experimental(self, value: bool) -> RequirementsBuilder
pub fn experimental(self, value: bool) -> RequirementsBuilder
For testing purposes, not real usage
A Boolean value to indicate that this Requirements is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
Allows filtering of Requirements that are appropriate for use versus not.
Sourcepub fn experimental_ext(self, value: FieldExtension) -> RequirementsBuilder
pub fn experimental_ext(self, value: FieldExtension) -> RequirementsBuilder
Extension field.
Sourcepub fn date(self, value: DateTime) -> RequirementsBuilder
pub fn date(self, value: DateTime) -> RequirementsBuilder
Date last changed
The date (and optionally time) when the Requirements was published. 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 Requirements changes.
Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the Requirements. 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.
Sourcepub fn date_ext(self, value: FieldExtension) -> RequirementsBuilder
pub fn date_ext(self, value: FieldExtension) -> RequirementsBuilder
Extension field.
Sourcepub fn publisher(self, value: String) -> RequirementsBuilder
pub fn publisher(self, value: String) -> RequirementsBuilder
Name of the publisher/steward (organization or individual)
The name of the organization or individual responsible for the release and ongoing maintenance of the Requirements.
Usually an organization but may be an individual. The publisher (or steward) of the Requirements is the organization or individual primarily responsible for the maintenance and upkeep of the Requirements. 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 Requirements. This item SHOULD be populated unless the information is available from context.
Sourcepub fn publisher_ext(self, value: FieldExtension) -> RequirementsBuilder
pub fn publisher_ext(self, value: FieldExtension) -> RequirementsBuilder
Extension field.
Sourcepub fn contact(self, value: Vec<Option<ContactDetail>>) -> RequirementsBuilder
pub fn contact(self, value: Vec<Option<ContactDetail>>) -> RequirementsBuilder
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.
Sourcepub fn contact_ext(
self,
value: Vec<Option<FieldExtension>>,
) -> RequirementsBuilder
pub fn contact_ext( self, value: Vec<Option<FieldExtension>>, ) -> RequirementsBuilder
Extension field.
Sourcepub fn description(self, value: String) -> RequirementsBuilder
pub fn description(self, value: String) -> RequirementsBuilder
Natural language description of the requirements
A free text natural language description of the requirements.
This description can be used for a general description of the requirements, and which covers why it was defined.
Sourcepub fn description_ext(self, value: FieldExtension) -> RequirementsBuilder
pub fn description_ext(self, value: FieldExtension) -> RequirementsBuilder
Extension field.
Sourcepub fn use_context(
self,
value: Vec<Option<UsageContext>>,
) -> RequirementsBuilder
pub fn use_context( self, value: Vec<Option<UsageContext>>, ) -> RequirementsBuilder
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 Requirements instances.
When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
Sourcepub fn use_context_ext(
self,
value: Vec<Option<FieldExtension>>,
) -> RequirementsBuilder
pub fn use_context_ext( self, value: Vec<Option<FieldExtension>>, ) -> RequirementsBuilder
Extension field.
Sourcepub fn jurisdiction(
self,
value: Vec<Option<CodeableConcept>>,
) -> RequirementsBuilder
pub fn jurisdiction( self, value: Vec<Option<CodeableConcept>>, ) -> RequirementsBuilder
Jurisdiction; Intended jurisdiction for Requirements (if applicable)
A legal or geographic region in which the Requirements is intended to be used.
It may be possible for the Requirements 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.).
Sourcepub fn jurisdiction_ext(
self,
value: Vec<Option<FieldExtension>>,
) -> RequirementsBuilder
pub fn jurisdiction_ext( self, value: Vec<Option<FieldExtension>>, ) -> RequirementsBuilder
Extension field.
Sourcepub fn purpose(self, value: String) -> RequirementsBuilder
pub fn purpose(self, value: String) -> RequirementsBuilder
Why this Requirements is defined
Explanation of why this Requirements is needed and why it has been designed as it has.
This element does not describe the usage of the Requirements. 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 Requirements.
Sourcepub fn purpose_ext(self, value: FieldExtension) -> RequirementsBuilder
pub fn purpose_ext(self, value: FieldExtension) -> RequirementsBuilder
Extension field.
Sourcepub fn copyright(self, value: String) -> RequirementsBuilder
pub fn copyright(self, value: String) -> RequirementsBuilder
Use and/or publishing restrictions
A copyright statement relating to the Requirements and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the Requirements.
…
Sourcepub fn copyright_ext(self, value: FieldExtension) -> RequirementsBuilder
pub fn copyright_ext(self, value: FieldExtension) -> RequirementsBuilder
Extension field.
Sourcepub fn copyright_label(self, value: String) -> RequirementsBuilder
pub fn copyright_label(self, value: String) -> RequirementsBuilder
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.
Sourcepub fn copyright_label_ext(self, value: FieldExtension) -> RequirementsBuilder
pub fn copyright_label_ext(self, value: FieldExtension) -> RequirementsBuilder
Extension field.
Sourcepub fn derived_from(self, value: Vec<Option<String>>) -> RequirementsBuilder
pub fn derived_from(self, value: Vec<Option<String>>) -> RequirementsBuilder
Other set of Requirements this builds on
Another set of Requirements that this set of Requirements builds on and updates.
Existing statements (by key) may be narrowed or clarified, and additional statements added.
Sourcepub fn derived_from_ext(
self,
value: Vec<Option<FieldExtension>>,
) -> RequirementsBuilder
pub fn derived_from_ext( self, value: Vec<Option<FieldExtension>>, ) -> RequirementsBuilder
Extension field.
Sourcepub fn reference(self, value: Vec<Option<String>>) -> RequirementsBuilder
pub fn reference(self, value: Vec<Option<String>>) -> RequirementsBuilder
External artifact (rule/document etc. that) created this set of requirements
A reference to another artifact that created this set of requirements. This could be a Profile, etc., or external regulation, or business requirements expressed elsewhere.
Sourcepub fn reference_ext(
self,
value: Vec<Option<FieldExtension>>,
) -> RequirementsBuilder
pub fn reference_ext( self, value: Vec<Option<FieldExtension>>, ) -> RequirementsBuilder
Extension field.
Sourcepub fn actor(self, value: Vec<Option<String>>) -> RequirementsBuilder
pub fn actor(self, value: Vec<Option<String>>) -> RequirementsBuilder
Actor for these requirements
An actor these requirements are in regard to.
If more than one actor is specified, then it’s up to the statements to describe in narrative if they don’t apply to all actors.
Sourcepub fn actor_ext(
self,
value: Vec<Option<FieldExtension>>,
) -> RequirementsBuilder
pub fn actor_ext( self, value: Vec<Option<FieldExtension>>, ) -> RequirementsBuilder
Extension field.
Sourcepub fn statement(
self,
value: Vec<Option<RequirementsStatement>>,
) -> RequirementsBuilder
pub fn statement( self, value: Vec<Option<RequirementsStatement>>, ) -> RequirementsBuilder
Actual statement as markdown
The actual statement of requirement, in markdown format.
Sourcepub fn statement_ext(
self,
value: Vec<Option<FieldExtension>>,
) -> RequirementsBuilder
pub fn statement_ext( self, value: Vec<Option<FieldExtension>>, ) -> RequirementsBuilder
Extension field.
Sourcepub fn build_inner(self) -> Result<RequirementsInner, BuilderError>
pub fn build_inner(self) -> Result<RequirementsInner, BuilderError>
Source§impl RequirementsBuilder
impl RequirementsBuilder
Sourcepub fn build(self) -> Result<Requirements, BuilderError>
pub fn build(self) -> Result<Requirements, BuilderError>
Finalize building Requirements.