Struct CompositionSectionBuilder

pub struct CompositionSectionBuilder { /* private fields */ }

Builder for CompositionSection.

Implementations

impl CompositionSectionBuilder

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

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

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

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 title(self, value: String) -> CompositionSectionBuilder

Label for section (e.g. for ToC)

The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.

The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.

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

Extension field.

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

CompositionSectionType; Classification of section (recommended)

A code identifying the kind of content contained within the section. This must be consistent with the section title.

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

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

Extension field.

pub fn author(self, value: Vec<Option<Reference>>) -> CompositionSectionBuilder

Who and/or what authored the section

Identifies who is responsible for the information in this section, not necessarily who typed it in.

pub fn author_ext( self, value: Vec<Option<FieldExtension>>, ) -> CompositionSectionBuilder

Extension field.

pub fn focus(self, value: Reference) -> CompositionSectionBuilder

Who/what the section is about, when it is not about the subject of composition

The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).

Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples.

pub fn focus_ext(self, value: FieldExtension) -> CompositionSectionBuilder

Extension field.

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

Text summary of the section, for human interpretation

A human-readable narrative that contains the attested content of the section, 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.

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

pub fn text_ext(self, value: FieldExtension) -> CompositionSectionBuilder

Extension field.

pub fn ordered_by(self, value: CodeableConcept) -> CompositionSectionBuilder

SectionEntryOrder; Order of section entries

Specifies the order applied to the items in the section entries.

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

pub fn ordered_by_ext(self, value: FieldExtension) -> CompositionSectionBuilder

Extension field.

pub fn entry(self, value: Vec<Option<Reference>>) -> CompositionSectionBuilder

A reference to data that supports this section

A reference to the actual resource from which the narrative in the section is derived.

If there are no entries in the list, an emptyReason SHOULD be provided.

pub fn entry_ext( self, value: Vec<Option<FieldExtension>>, ) -> CompositionSectionBuilder

Extension field.

pub fn empty_reason(self, value: CodeableConcept) -> CompositionSectionBuilder

SectionEmptyReason; Why the section is empty

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

pub fn empty_reason_ext( self, value: FieldExtension, ) -> CompositionSectionBuilder

Extension field.

pub fn section( self, value: Vec<Option<CompositionSection>>, ) -> CompositionSectionBuilder

Nested Section

A nested sub-section within this section.

Nested sections are primarily used to help human readers navigate to particular portions of the document.

pub fn section_ext( self, value: Vec<Option<FieldExtension>>, ) -> CompositionSectionBuilder

Extension field.

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

Builds a new CompositionSection.

Errors

If a required field has not been initialized.

Trait Implementations

impl Default for CompositionSectionBuilder

fn default() -> CompositionSectionBuilder

Returns the “default value” for a type.