Struct AllergyIntoleranceBuilder

pub struct AllergyIntoleranceBuilder { /* private fields */ }

Builder for AllergyIntoleranceInner.

Implementations

impl AllergyIntoleranceBuilder

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

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

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

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

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

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

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

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

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

External ids for this item

Business identifiers assigned to this AllergyIntolerance by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.

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

Extension field.

pub fn clinical_status( self, value: CodeableConcept, ) -> AllergyIntoleranceBuilder

AllergyIntoleranceClinicalStatus; active | inactive | resolved

The clinical status of the allergy or intolerance.

AllergyIntolerance.clinicalStatus should be present if verificationStatus is not entered-in-error and the AllergyIntolerance.code isn’t negated (No Known Allergy, No Drug Allergy, No Food Allergy, No Latex Allergy). Refer to discussion if clinicalStatus is missing data. The data type is CodeableConcept because clinicalStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity.

pub fn clinical_status_ext( self, value: FieldExtension, ) -> AllergyIntoleranceBuilder

Extension field.

pub fn verification_status( self, value: CodeableConcept, ) -> AllergyIntoleranceBuilder

AllergyIntoleranceVerificationStatus; unconfirmed | presumed | confirmed | refuted | entered-in-error

Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product). The verification status pertains to the allergy or intolerance, itself, not to any specific AllergyIntolerance attribute.

The data type is CodeableConcept because verificationStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity.

pub fn verification_status_ext( self, value: FieldExtension, ) -> AllergyIntoleranceBuilder

Extension field.

pub fn type(self, value: CodeableConcept) -> AllergyIntoleranceBuilder

AllergyIntoleranceType; allergy | intolerance - Underlying mechanism (if known)

Identification of the underlying physiological mechanism for the reaction risk.

Allergic (typically immune-mediated) reactions have been traditionally regarded as an indicator for potential escalation to significant future risk. Contemporary knowledge suggests that some reactions previously thought to be immune-mediated are, in fact, non-immune, but in some cases can still pose a life threatening risk. It is acknowledged that many clinicians might not be in a position to distinguish the mechanism of a particular reaction. Often the term “allergy” is used rather generically and may overlap with the use of “intolerance” - in practice the boundaries between these two concepts might not be well-defined or understood. This data element is included nevertheless, because many legacy systems have captured this attribute. Immunologic testing may provide supporting evidence for the basis of the reaction and the causative substance, but no tests are 100% sensitive or specific for sensitivity to a particular substance. If, as is commonly the case, it is unclear whether the reaction is due to an allergy or an intolerance, then the type element should be omitted from the resource.

pub fn type_ext(self, value: FieldExtension) -> AllergyIntoleranceBuilder

Extension field.

pub fn category( self, value: Vec<Option<AllergyIntoleranceCategory>>, ) -> AllergyIntoleranceBuilder

AllergyIntoleranceCategory; food | medication | environment | biologic

Category of the identified substance.

This data element has been included because it is currently being captured in some clinical systems. This data can be derived from the substance where coding systems are used, and is effectively redundant in that situation. When searching on category, consider the implications of AllergyIntolerance resources without a category. For example, when searching on category = medication, medication allergies that don’t have a category valued will not be returned. Refer to search for more information on how to search category with a :missing modifier to get allergies that don’t have a category. Additionally, category should be used with caution because category can be subjective based on the sender.

pub fn category_ext( self, value: Vec<Option<FieldExtension>>, ) -> AllergyIntoleranceBuilder

Extension field.

pub fn criticality( self, value: AllergyIntoleranceCriticality, ) -> AllergyIntoleranceBuilder

AllergyIntoleranceCriticality; low | high | unable-to-assess

Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance.

The default criticality value for any propensity to an adverse reaction should be ‘Low Risk’, indicating at the very least a relative contraindication to deliberate or voluntary exposure to the substance. ‘High Risk’ is flagged if the clinician has identified a propensity for a more serious or potentially life-threatening reaction, such as anaphylaxis, and implies an absolute contraindication to deliberate or voluntary exposure to the substance. If this element is missing, the criticality is unknown (though it may be known elsewhere). Systems that capture a severity at the condition level are actually representing the concept of criticality whereas the severity documented at the reaction level is representing the true reaction severity. Existing systems that are capturing both condition criticality and reaction severity may use the term “severity” to represent both. Criticality is the worst it could be in the future (i.e. situation-agnostic) whereas severity is situation-dependent.

pub fn criticality_ext(self, value: FieldExtension) -> AllergyIntoleranceBuilder

Extension field.

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

AllergyIntoleranceCode; Code that identifies the allergy or intolerance

Code for an allergy or intolerance statement (either a positive or a negated/excluded statement). This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., “Latex”), an allergy or intolerance condition (e.g., “Latex allergy”), or a negated/excluded code for a specific substance or class (e.g., “No latex allergy”) or a general or categorical negated statement (e.g., “No known allergy”, “No known drug allergies”). Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the ‘code’ and ignore the ‘reaction.substance’. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance.

It is strongly recommended that this element be populated using a terminology, where possible. For example, some terminologies used include RxNorm, SNOMED CT, DM+D, NDFRT, ICD-9, IDC-10, UNII, and ATC. Plain text should only be used if there is no appropriate terminology available. Additional details can be specified in the text.

When a substance or product code is specified for the ‘code’ element, the “default” semantic context is that this is a positive statement of an allergy or intolerance (depending on the value of the ‘type’ element, if present) condition to the specified substance/product. In the corresponding SNOMED CT allergy model, the specified substance/product is the target (destination) of the “Causative agent” relationship.

The ‘substanceExposureRisk’ extension is available as a structured and more flexible alternative to the ‘code’ element for making positive or negative allergy or intolerance statements. This extension provides the capability to make “no known allergy” (or “no risk of adverse reaction”) statements regarding any coded substance/product (including cases when a pre-coordinated “no allergy to x” concept for that substance/product does not exist). If the ‘substanceExposureRisk’ extension is present, the AllergyIntolerance.code element SHALL be omitted.

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

Extension field.

pub fn patient(self, value: Reference) -> AllergyIntoleranceBuilder

Who the allergy or intolerance is for

The patient who has the allergy or intolerance.

pub fn patient_ext(self, value: FieldExtension) -> AllergyIntoleranceBuilder

Extension field.

pub fn encounter(self, value: Reference) -> AllergyIntoleranceBuilder

Encounter when the allergy or intolerance was asserted

The encounter when the allergy or intolerance was asserted.

pub fn encounter_ext(self, value: FieldExtension) -> AllergyIntoleranceBuilder

Extension field.

pub fn onset(self, value: AllergyIntoleranceOnset) -> AllergyIntoleranceBuilder

When allergy or intolerance was identified

Estimated or actual date, date-time, or age when allergy or intolerance was identified.

Age is generally used when the patient reports an age at which the AllergyIntolerance was noted. Period is generally used to convey an imprecise onset that occurred within the time period. Range is generally used to convey an imprecise age range (e.g. 4 to 6 years old).

pub fn onset_ext( self, value: AllergyIntoleranceOnsetExtension, ) -> AllergyIntoleranceBuilder

Extension field.

pub fn recorded_date(self, value: DateTime) -> AllergyIntoleranceBuilder

Date allergy or intolerance was first recorded

The recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date.

When onset date is unknown, recordedDate can be used to establish if the allergy or intolerance was present on or before a given date. If the recordedDate is known and provided by a sending system, it is preferred that the receiving system preserve that recordedDate value. If the recordedDate is not provided by the sending system, the receipt timestamp is sometimes used as the recordedDate.

pub fn recorded_date_ext( self, value: FieldExtension, ) -> AllergyIntoleranceBuilder

Extension field.

pub fn participant( self, value: Vec<Option<AllergyIntoleranceParticipant>>, ) -> AllergyIntoleranceBuilder

Who or what participated in the activities related to the allergy or intolerance and how they were involved

Indicates who or what participated in the activities related to the allergy or intolerance and how they were involved.

pub fn participant_ext( self, value: Vec<Option<FieldExtension>>, ) -> AllergyIntoleranceBuilder

Extension field.

pub fn last_occurrence(self, value: DateTime) -> AllergyIntoleranceBuilder

Date(/time) of last known occurrence of a reaction

Represents the date and/or time of the last known occurrence of a reaction event.

This date may be replicated by one of the Onset of Reaction dates. Where a textual representation of the date of last occurrence is required e.g. ’In Childhood, ‘10 years ago’ the AllergyIntolerance.note element should be used.

pub fn last_occurrence_ext( self, value: FieldExtension, ) -> AllergyIntoleranceBuilder

Extension field.

pub fn note(self, value: Vec<Option<Annotation>>) -> AllergyIntoleranceBuilder

Additional text not captured in other fields

Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.

For example: including reason for flagging a seriousness of ‘High Risk’; and instructions related to future exposure or administration of the substance, such as administration within an Intensive Care Unit or under corticosteroid cover. The notes should be related to an allergy or intolerance as a condition in general and not related to any particular episode of it. For episode notes and descriptions, use AllergyIntolerance.event.description and AllergyIntolerance.event.notes.

pub fn note_ext( self, value: Vec<Option<FieldExtension>>, ) -> AllergyIntoleranceBuilder

Extension field.

pub fn reaction( self, value: Vec<Option<AllergyIntoleranceReaction>>, ) -> AllergyIntoleranceBuilder

Adverse Reaction Events linked to exposure to substance

Details about each adverse reaction event linked to exposure to the identified substance.

pub fn reaction_ext( self, value: Vec<Option<FieldExtension>>, ) -> AllergyIntoleranceBuilder

Extension field.

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

Builds a new AllergyIntoleranceInner.

Errors

If a required field has not been initialized.

impl AllergyIntoleranceBuilder

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

Finalize building AllergyIntolerance.

Trait Implementations

impl Default for AllergyIntoleranceBuilder

fn default() -> AllergyIntoleranceBuilder

Returns the “default value” for a type.