Struct ProcedureBuilder

pub struct ProcedureBuilder { /* private fields */ }

Builder for ProcedureInner.

Implementations

impl ProcedureBuilder

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

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

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

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

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

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

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

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

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

External Identifiers for this procedure

Business identifiers assigned to this procedure by the performer or other systems which remain constant as the resource is updated and is propagated 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 Person resource instances might share the same social insurance number.

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

Extension field.

pub fn instantiates_canonical(self, value: Vec<Option<String>>) -> Self

Instantiates FHIR protocol or definition

The URL pointing to a FHIR-defined protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.

pub fn instantiates_canonical_ext( self, value: Vec<Option<FieldExtension>>, ) -> Self

Extension field.

pub fn instantiates_uri(self, value: Vec<Option<String>>) -> Self

Instantiates external protocol or definition

The URL pointing to an externally maintained protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.

This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.

pub fn instantiates_uri_ext(self, value: Vec<Option<FieldExtension>>) -> Self

Extension field.

pub fn based_on(self, value: Vec<Option<Reference>>) -> Self

A request for this procedure

A reference to a resource that contains details of the request for this procedure.

pub fn based_on_ext(self, value: Vec<Option<FieldExtension>>) -> Self

Extension field.

pub fn part_of(self, value: Vec<Option<Reference>>) -> Self

Part of referenced event

A larger event of which this particular procedure is a component or step.

The MedicationAdministration resource has a partOf reference to Procedure, but this is not a circular reference. For example, the anesthesia MedicationAdministration is part of the surgical Procedure (MedicationAdministration.partOf = Procedure). For example, the procedure to insert the IV port for an IV medication administration is part of the medication administration (Procedure.partOf = MedicationAdministration).

pub fn part_of_ext(self, value: Vec<Option<FieldExtension>>) -> Self

Extension field.

pub fn status(self, value: EventStatus) -> Self

ProcedureStatus; preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown

A code specifying the state of the procedure. Generally, this will be the in-progress or completed state.

The “unknown” code is not to be used to convey other statuses. The “unknown” code should be used when one of the statuses applies, but the authoring system doesn’t know the current state of the procedure.

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

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

Extension field.

pub fn status_reason(self, value: CodeableConcept) -> Self

ProcedureNegationReason; Reason for current status

Captures the reason for the current state of the procedure.

This is generally only used for “exception” statuses such as “not-done”, “suspended” or “aborted”. The reason for performing the event at all is captured in reasonCode, not here.

pub fn status_reason_ext(self, value: FieldExtension) -> Self

Extension field.

pub fn category(self, value: Vec<Option<CodeableConcept>>) -> Self

ProcedureCategory; Classification of the procedure

A code that classifies the procedure for searching, sorting and display purposes (e.g. “Surgical Procedure”).

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

Extension field.

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

ProcedureCode; Identification of the procedure

The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. “Laparoscopic Appendectomy”).

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

Extension field.

pub fn subject(self, value: Reference) -> Self

Individual or entity the procedure was performed on

On whom or on what the procedure was performed. This is usually an individual human, but can also be performed on animals, groups of humans or animals, organizations or practitioners (for licensing), locations or devices (for safety inspections or regulatory authorizations). If the actual focus of the procedure is different from the subject, the focus element specifies the actual focus of the procedure.

pub fn subject_ext(self, value: FieldExtension) -> Self

Extension field.

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

Who is the target of the procedure when it is not the subject of record only

Who is the target of the procedure when it is not the subject of record only. If focus is not present, then subject is the focus. If focus is present and the subject is one of the targets of the procedure, include subject as a focus as well. If focus is present and the subject is not included in focus, it implies that the procedure was only targeted on the focus. For example, when a caregiver is given education for a patient, the caregiver would be the focus and the procedure record is associated with the subject (e.g. patient). For example, use focus when recording the target of the education, training, or counseling is the parent or relative of a patient.

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

Extension field.

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

The Encounter during which this Procedure was created

The Encounter during which this Procedure was created or performed or to which the creation of this record is tightly associated.

This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.

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

Extension field.

pub fn occurrence(self, value: ProcedureOccurrence) -> Self

When the procedure occurred or is occurring

Estimated or actual date, date-time, period, or age when the procedure did occur or is occurring. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.

This indicates when the procedure actually occurred or is occurring, not when it was asked/requested/ordered to occur. For the latter, look at the occurence element of the Request this Procedure is “basedOn”. The status code allows differentiation of whether the timing reflects a historic event or an ongoing event. Ongoing events should not include an upper bound in the Period or Timing.bounds.

Age is generally used when the patient reports an age at which the procedure was performed. Range is generally used when the patient reports an age range when the procedure was performed, such as sometime between 20-25 years old. dateTime supports a range of precision due to some procedures being reported as past procedures that might not have millisecond precision while other procedures performed and documented during the encounter might have more precise UTC timestamps with timezone.

pub fn occurrence_ext(self, value: ProcedureOccurrenceExtension) -> Self

Extension field.

pub fn recorded(self, value: DateTime) -> Self

When the procedure was first captured in the subject’s record

The date the occurrence of the procedure was first captured in the record regardless of Procedure.status (potentially after the occurrence of the event).

pub fn recorded_ext(self, value: FieldExtension) -> Self

Extension field.

pub fn recorder(self, value: Reference) -> Self

Who recorded the procedure

Individual who recorded the record and takes responsibility for its content.

pub fn recorder_ext(self, value: FieldExtension) -> Self

Extension field.

pub fn reported(self, value: ProcedureReported) -> Self

Reported rather than primary record

Indicates if this record was captured as a secondary ‘reported’ record rather than as an original primary source-of-truth record. It may also indicate the source of the report.

pub fn reported_ext(self, value: ProcedureReportedExtension) -> Self

Extension field.

pub fn performer(self, value: Vec<Option<ProcedurePerformer>>) -> Self

Who performed the procedure and what they did

Indicates who or what performed the procedure and how they were involved.

pub fn performer_ext(self, value: Vec<Option<FieldExtension>>) -> Self

Extension field.

pub fn location(self, value: Reference) -> Self

Where the procedure happened

The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant.

pub fn location_ext(self, value: FieldExtension) -> Self

Extension field.

pub fn reason(self, value: Vec<Option<CodeableReference>>) -> Self

ProcedureReason; The justification that the procedure was performed

The coded reason or reference why the procedure was performed. This may be a coded entity of some type, be present as text, or be a reference to one of several resources that justify the procedure.

Use Procedure.reason.concept when a code sufficiently describes the reason. Use Procedure.reason.reference when referencing a resource, which allows more information to be conveyed, such as onset date. For a single Procedure.reason, if both Procedure.reason.concept and Procedure.reason.reference are present, they are expected to be consistent with each other.

pub fn reason_ext(self, value: Vec<Option<FieldExtension>>) -> Self

Extension field.

pub fn body_site(self, value: Vec<Option<CodeableConcept>>) -> Self

BodySite; Target body sites

Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.

If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure.

pub fn body_site_ext(self, value: Vec<Option<FieldExtension>>) -> Self

Extension field.

pub fn outcome(self, value: CodeableConcept) -> Self

ProcedureOutcome; The result of procedure

The outcome of the procedure - did it resolve the reasons for the procedure being performed?

If outcome contains narrative text only, it can be captured using the CodeableConcept.text.

pub fn outcome_ext(self, value: FieldExtension) -> Self

Extension field.

pub fn report(self, value: Vec<Option<Reference>>) -> Self

Any report resulting from the procedure

This could be a histology result, pathology report, surgical report, etc.

There could potentially be multiple reports - e.g. if this was a procedure which took multiple biopsies resulting in a number of anatomical pathology reports.

pub fn report_ext(self, value: Vec<Option<FieldExtension>>) -> Self

Extension field.

pub fn complication(self, value: Vec<Option<CodeableReference>>) -> Self

ProcedureComplication; Complication following the procedure

Any complications that occurred during the procedure, or in the immediate post-performance period. These are generally tracked separately from the notes, which will typically describe the procedure itself rather than any ‘post procedure’ issues.

If complications are only expressed by the narrative text, they can be captured using the CodeableReference.concept.text.

pub fn complication_ext(self, value: Vec<Option<FieldExtension>>) -> Self

Extension field.

pub fn follow_up(self, value: Vec<Option<CodeableConcept>>) -> Self

ProcedureFollowUp; Instructions for follow up

If the procedure required specific follow up - e.g. removal of sutures. The follow up may be represented as a simple note or could potentially be more complex, in which case the CarePlan resource can be used.

pub fn follow_up_ext(self, value: Vec<Option<FieldExtension>>) -> Self

Extension field.

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

Additional information about the procedure

Any other notes and comments about the procedure.

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

Extension field.

pub fn focal_device(self, value: Vec<Option<ProcedureFocalDevice>>) -> Self

Manipulated, implanted, or removed device

A device that is implanted, removed or otherwise manipulated (calibration, battery replacement, fitting a prosthesis, attaching a wound-vac, etc.) as a focal portion of the Procedure.

pub fn focal_device_ext(self, value: Vec<Option<FieldExtension>>) -> Self

Extension field.

pub fn used(self, value: Vec<Option<CodeableReference>>) -> Self

ProcedureUsed; Items used during procedure

Identifies medications, devices and any other substance used as part of the procedure.

For devices actually implanted or removed, use Procedure.focalDevice.manipulated.

pub fn used_ext(self, value: Vec<Option<FieldExtension>>) -> Self

Extension field.

pub fn supporting_info(self, value: Vec<Option<Reference>>) -> Self

Extra information relevant to the procedure

Other resources from the patient record that may be relevant to the procedure. The information from these resources was either used to create the instance or is provided to help with its interpretation. This extension should not be used if more specific inline elements or extensions are available.

pub fn supporting_info_ext(self, value: Vec<Option<FieldExtension>>) -> Self

Extension field.

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

Builds a new ProcedureInner.

Errors

If a required field has not been initialized.

impl ProcedureBuilder

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

Finalize building Procedure.

Trait Implementations

impl Default for ProcedureBuilder

fn default() -> Self

Returns the “default value” for a type.