Struct RequirementsStatementBuilder

pub struct RequirementsStatementBuilder { /* private fields */ }

Builder for RequirementsStatement.

Implementations

impl RequirementsStatementBuilder

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

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

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

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 key(self, value: String) -> RequirementsStatementBuilder

Key that identifies this statement

Key that identifies this statement (unique within this resource).

Refer directly to the statement by {url}#{key}

pub fn key_ext(self, value: FieldExtension) -> RequirementsStatementBuilder

Extension field.

pub fn label(self, value: String) -> RequirementsStatementBuilder

Short Human label for this statement

A short human usable label for this statement.

The key is intended for computers, while this is intended for humans. In its absence, the key should be convenient for a human to say (e.g. not a UUID)

pub fn label_ext(self, value: FieldExtension) -> RequirementsStatementBuilder

Extension field.

pub fn conformance( self, value: Vec<Option<ConformanceExpectation>>, ) -> RequirementsStatementBuilder

??; SHALL | SHOULD | MAY | SHOULD-NOT

A short human usable label for this statement.

The conformance code is extracted from the requirement to make indexing and display easier. The requirement needs to express the conformance verbs directly in the markdown content. It’s not unusual to mix verbs in a single sentence (e.g. System SHALL do X and SHOULD do Y)

pub fn conformance_ext( self, value: Vec<Option<FieldExtension>>, ) -> RequirementsStatementBuilder

Extension field.

pub fn conditionality(self, value: bool) -> RequirementsStatementBuilder

Set to true if requirements statement is conditional

This boolean flag is set to true of the text of the requirement is conditional on something e.g. it includes lanauage like ‘if x then y’. This conditionality flag is introduced for purposes of filtering and colour highlighting etc.

There is no intent that the conditional statement by evaluatable

pub fn conditionality_ext( self, value: FieldExtension, ) -> RequirementsStatementBuilder

Extension field.

pub fn requirement(self, value: String) -> RequirementsStatementBuilder

The actual requirement

The actual requirement for human consumption.

pub fn requirement_ext( self, value: FieldExtension, ) -> RequirementsStatementBuilder

Extension field.

pub fn derived_from(self, value: String) -> RequirementsStatementBuilder

Another statement this clarifies/restricts ([url#]key)

Another statement on one of the requirements that this requirement clarifies or restricts.

This can be just a key, if there is only one matching statement in the requirements statements referenced in Requirements.derivedFrom. If there is more than one, it should be in the format texturl#key

pub fn derived_from_ext( self, value: FieldExtension, ) -> RequirementsStatementBuilder

Extension field.

pub fn parent(self, value: String) -> RequirementsStatementBuilder

A larger requirement that this requirement helps to refine and enable

A larger requirement that this requirement helps to refine and enable.

Follows the same convention as statement.derivedFrom, where a reference is the canonical of the Requirements followed by ‘#’ and the ‘key’ of the specific requirement.

pub fn parent_ext(self, value: FieldExtension) -> RequirementsStatementBuilder

Extension field.

pub fn satisfied_by( self, value: Vec<Option<String>>, ) -> RequirementsStatementBuilder

Design artifact that satisfies this requirement

A reference to another artifact that satisfies this requirement. This could be a Profile, extension, or an element in one of those, or a CapabilityStatement, OperationDefinition, SearchParameter, CodeSystem(/code), ValueSet, Libary etc.

This is for use when the requirement is met be a pre-existing artifact e.g. a rule that’s met by the base FHIR spec, or a national implementation guide.

pub fn satisfied_by_ext( self, value: Vec<Option<FieldExtension>>, ) -> RequirementsStatementBuilder

Extension field.

pub fn reference( self, value: Vec<Option<String>>, ) -> RequirementsStatementBuilder

External artifact (rule/document etc. that) created this requirement

A reference to another artifact that created this requirement. This could be a Profile, etc., or external regulation, or business requirements expressed elsewhere.

pub fn reference_ext( self, value: Vec<Option<FieldExtension>>, ) -> RequirementsStatementBuilder

Extension field.

pub fn source( self, value: Vec<Option<Reference>>, ) -> RequirementsStatementBuilder

Who asked for this statement

Who asked for this statement to be a requirement. By default, it’s assumed that the publisher knows who it is if it matters.

pub fn source_ext( self, value: Vec<Option<FieldExtension>>, ) -> RequirementsStatementBuilder

Extension field.

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

Builds a new RequirementsStatement.

Errors

If a required field has not been initialized.

Trait Implementations

impl Default for RequirementsStatementBuilder

fn default() -> RequirementsStatementBuilder

Returns the “default value” for a type.