Struct MedicationKnowledgeBuilder

pub struct MedicationKnowledgeBuilder { /* private fields */ }

Builder for MedicationKnowledgeInner.

Implementations

impl MedicationKnowledgeBuilder

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

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

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

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

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

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

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

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

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 identifier( self, value: Vec<Option<Identifier>>, ) -> MedicationKnowledgeBuilder

Business identifier for this medication

Business identifier for this medication.

This is a business identifier, not a resource identifier (see discussion).

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

Extension field.

pub fn code(self, value: CodeableConcept) -> MedicationKnowledgeBuilder

MedicationFormalRepresentation; Code that identifies this medication

A code that specifies this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.

Depending on the context of use, the code that was actually selected by the user (prescriber, dispenser, etc.) will have the coding.userSelected set to true. As described in the coding datatype: “A coding may be marked as a “userSelected” if a user selected the particular coded value in a user interface (e.g. the user selects an item in a pick-list). If a user selected coding exists, it is the preferred choice for performing translations etc. Other codes can only be literal translations to alternative code systems, or codes at a lower level of granularity (e.g. a generic code for a vendor-specific primary one).

pub fn code_ext(self, value: FieldExtension) -> MedicationKnowledgeBuilder

Extension field.

pub fn status( self, value: MedicationKnowledgeStatusCodes, ) -> MedicationKnowledgeBuilder

MedicationKnowledgeStatus; active | entered-in-error | inactive

A code to indicate if the medication referred to by this MedicationKnowledge is in active use within the drug database or inventory system. The status refers to the validity about the information of the medication and not to its medicinal properties.

This status is intended to identify if the medication in a local system is in active use within a drug database or inventory. For example, a pharmacy system may create a new drug file record for a compounded product “ABC Hospital Special Cream” with an active status. At some point in the future, it may be determined that the drug record was created with an error and the status is changed to “entered in error”. This status is not intended to specify if a medication is part of a particular formulary. It is possible that the drug record may be referenced by multiple formularies or catalogues and each of those entries would have a separate status.

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

Extension field.

pub fn author(self, value: Reference) -> MedicationKnowledgeBuilder

Creator or owner of the knowledge or information about the medication

The creator or owner of the knowledge or information about the medication.

pub fn author_ext(self, value: FieldExtension) -> MedicationKnowledgeBuilder

Extension field.

pub fn intended_jurisdiction( self, value: Vec<Option<CodeableConcept>>, ) -> MedicationKnowledgeBuilder

Codes that identify the different jurisdictions for which the information of this resource was created

Lists the jurisdictions that this medication knowledge was written for.

The codes could have varying granularity from a country or group of countries down to a specific district.

pub fn intended_jurisdiction_ext( self, value: Vec<Option<FieldExtension>>, ) -> MedicationKnowledgeBuilder

Extension field.

pub fn name(self, value: Vec<Option<String>>) -> MedicationKnowledgeBuilder

A name associated with the medication being described

All of the names for a medication, for example, the name(s) given to a medication in different countries. For example, acetaminophen and paracetamol or salbutamol and albuterol.

pub fn name_ext( self, value: Vec<Option<FieldExtension>>, ) -> MedicationKnowledgeBuilder

Extension field.

pub fn related_medication_knowledge( self, value: Vec<Option<MedicationKnowledgeRelatedMedicationKnowledge>>, ) -> MedicationKnowledgeBuilder

Associated or related medication information

Associated or related medications. For example, if the medication is a branded product (e.g. Crestor), this is the Therapeutic Moeity (e.g. Rosuvastatin) or if this is a generic medication (e.g. Rosuvastatin), this would link to a branded product (e.g. Crestor.

pub fn related_medication_knowledge_ext( self, value: Vec<Option<FieldExtension>>, ) -> MedicationKnowledgeBuilder

Extension field.

pub fn associated_medication( self, value: Vec<Option<Reference>>, ) -> MedicationKnowledgeBuilder

The set of medication resources that are associated with this medication

Links to associated medications that could be prescribed, dispensed or administered.

pub fn associated_medication_ext( self, value: Vec<Option<FieldExtension>>, ) -> MedicationKnowledgeBuilder

Extension field.

pub fn product_type( self, value: Vec<Option<CodeableConcept>>, ) -> MedicationKnowledgeBuilder

Category of the medication or product

Category of the medication or product (e.g. branded product, therapeutic moeity, generic product, innovator product, etc.).

pub fn product_type_ext( self, value: Vec<Option<FieldExtension>>, ) -> MedicationKnowledgeBuilder

Extension field.

pub fn monograph( self, value: Vec<Option<MedicationKnowledgeMonograph>>, ) -> MedicationKnowledgeBuilder

Associated documentation about the medication

Associated documentation about the medication.

pub fn monograph_ext( self, value: Vec<Option<FieldExtension>>, ) -> MedicationKnowledgeBuilder

Extension field.

pub fn preparation_instruction( self, value: String, ) -> MedicationKnowledgeBuilder

The instructions for preparing the medication

The instructions for preparing the medication.

pub fn preparation_instruction_ext( self, value: FieldExtension, ) -> MedicationKnowledgeBuilder

Extension field.

pub fn cost( self, value: Vec<Option<MedicationKnowledgeCost>>, ) -> MedicationKnowledgeBuilder

The pricing of the medication

The price of the medication.

pub fn cost_ext( self, value: Vec<Option<FieldExtension>>, ) -> MedicationKnowledgeBuilder

Extension field.

pub fn monitoring_program( self, value: Vec<Option<MedicationKnowledgeMonitoringProgram>>, ) -> MedicationKnowledgeBuilder

Program under which a medication is reviewed

The program under which the medication is reviewed.

pub fn monitoring_program_ext( self, value: Vec<Option<FieldExtension>>, ) -> MedicationKnowledgeBuilder

Extension field.

pub fn indication_guideline( self, value: Vec<Option<MedicationKnowledgeIndicationGuideline>>, ) -> MedicationKnowledgeBuilder

Guidelines or protocols for administration of the medication for an indication

Guidelines or protocols that are applicable for the administration of the medication based on indication.

pub fn indication_guideline_ext( self, value: Vec<Option<FieldExtension>>, ) -> MedicationKnowledgeBuilder

Extension field.

pub fn medicine_classification( self, value: Vec<Option<MedicationKnowledgeMedicineClassification>>, ) -> MedicationKnowledgeBuilder

Categorization of the medication within a formulary or classification system

Categorization of the medication within a formulary or classification system.

pub fn medicine_classification_ext( self, value: Vec<Option<FieldExtension>>, ) -> MedicationKnowledgeBuilder

Extension field.

pub fn packaging( self, value: Vec<Option<MedicationKnowledgePackaging>>, ) -> MedicationKnowledgeBuilder

Details about packaged medications

Information that only applies to packages (not products).

pub fn packaging_ext( self, value: Vec<Option<FieldExtension>>, ) -> MedicationKnowledgeBuilder

Extension field.

pub fn clinical_use_issue( self, value: Vec<Option<Reference>>, ) -> MedicationKnowledgeBuilder

Potential clinical issue with or between medication(s)

Potential clinical issue with or between medication(s) (for example, drug-drug interaction, drug-disease contraindication, drug-allergy interaction, etc.).

pub fn clinical_use_issue_ext( self, value: Vec<Option<FieldExtension>>, ) -> MedicationKnowledgeBuilder

Extension field.

pub fn storage_guideline( self, value: Vec<Option<MedicationKnowledgeStorageGuideline>>, ) -> MedicationKnowledgeBuilder

How the medication should be stored

Information on how the medication should be stored, for example, refrigeration temperatures and length of stability at a given temperature.

pub fn storage_guideline_ext( self, value: Vec<Option<FieldExtension>>, ) -> MedicationKnowledgeBuilder

Extension field.

pub fn regulatory( self, value: Vec<Option<MedicationKnowledgeRegulatory>>, ) -> MedicationKnowledgeBuilder

Regulatory information about a medication

Regulatory information about a medication.

pub fn regulatory_ext( self, value: Vec<Option<FieldExtension>>, ) -> MedicationKnowledgeBuilder

Extension field.

pub fn definitional( self, value: MedicationKnowledgeDefinitional, ) -> MedicationKnowledgeBuilder

Minimal definition information about the medication

Along with the link to a Medicinal Product Definition resource, this information provides common definitional elements that are needed to understand the specific medication that is being described.

pub fn definitional_ext( self, value: FieldExtension, ) -> MedicationKnowledgeBuilder

Extension field.

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

Builds a new MedicationKnowledgeInner.

Errors

If a required field has not been initialized.

impl MedicationKnowledgeBuilder

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

Finalize building MedicationKnowledge.

Trait Implementations

impl Default for MedicationKnowledgeBuilder

fn default() -> MedicationKnowledgeBuilder

Returns the “default value” for a type.