Struct DocumentReferenceBuilder

pub struct DocumentReferenceBuilder { /* private fields */ }

Builder for DocumentReferenceInner.

Implementations

impl DocumentReferenceBuilder

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

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

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

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

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

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

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

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

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

Business identifiers for the document

Other business identifiers associated with the document, including version independent identifiers.

The structure and format of this identifier would be consistent with the specification corresponding to the format of the document. (e.g. for a DICOM standard document, a 64-character numeric UID; for an HL7 CDA format, the CDA Document Id root and extension).

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

Extension field.

pub fn version(self, value: String) -> DocumentReferenceBuilder

An explicitly assigned identifer of a variation of the content in the DocumentReference

An explicitly assigned identifer of a variation of the content in the DocumentReference.

While each resource, including the DocumentReference itself, has its own version identifier, this is a formal identifier for the logical version of the DocumentReference as a whole. It would remain constant if the resources were moved to a new server, and all got new individual resource versions, for example.

pub fn version_ext(self, value: FieldExtension) -> DocumentReferenceBuilder

Extension field.

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

Procedure that caused this media to be created

A procedure that is fulfilled in whole or in part by the creation of this media.

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

Extension field.

pub fn status(self, value: DocumentReferenceStatus) -> DocumentReferenceBuilder

DocumentReferenceStatus; current | superseded | entered-in-error

The status of this document reference.

This is the status of the DocumentReference object, which might be independent from the docStatus element.

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

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

Extension field.

pub fn doc_status(self, value: CompositionStatus) -> DocumentReferenceBuilder

ReferredDocumentStatus; registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown

The status of the underlying document.

The document that is pointed to might be in various lifecycle states.

pub fn doc_status_ext(self, value: FieldExtension) -> DocumentReferenceBuilder

Extension field.

pub fn modality( self, value: Vec<Option<CodeableConcept>>, ) -> DocumentReferenceBuilder

ImagingModality; Imaging modality used

Imaging modality used. This may include both acquisition and non-acquisition modalities.

pub fn modality_ext( self, value: Vec<Option<FieldExtension>>, ) -> DocumentReferenceBuilder

Extension field.

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

DocumentType; Kind of document (LOINC if possible)

Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.

Key metadata element describing the document that describes he exact type of document. Helps humans to assess whether the document is of interest when viewing a list of documents.

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

Extension field.

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

ReferencedItemCategory; Categorization of document

A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.

Key metadata element describing the the category or classification of the document. This is a broader perspective that groups similar documents based on how they would be used. This is a primary key used in searching.

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

Extension field.

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

Who/what is the subject of the document

Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).

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

Extension field.

pub fn context(self, value: Vec<Option<Reference>>) -> DocumentReferenceBuilder

Context of the document content

Describes the clinical encounter or type of care that the document content is associated with.

pub fn context_ext( self, value: Vec<Option<FieldExtension>>, ) -> DocumentReferenceBuilder

Extension field.

pub fn event( self, value: Vec<Option<CodeableReference>>, ) -> DocumentReferenceBuilder

DocumentEventType; Main clinical acts documented

This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a “History and Physical Report” in which the procedure being documented is necessarily a “History and Physical” act.

An event can further specialize the act inherent in the type, such as where it is simply “Procedure Report” and the procedure was a “colonoscopy”. If one or more event codes are included, they shall not conflict with the values inherent in the class or type elements as such a conflict would create an ambiguous situation.

pub fn event_ext( self, value: Vec<Option<FieldExtension>>, ) -> DocumentReferenceBuilder

Extension field.

pub fn body_site( self, value: Vec<Option<CodeableReference>>, ) -> DocumentReferenceBuilder

BodySite; Body part included

The anatomic structures included in the document.

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

Extension field.

pub fn facility_type(self, value: CodeableConcept) -> DocumentReferenceBuilder

DocumentC80FacilityType; Kind of facility where patient was seen

The kind of facility where the patient was seen.

pub fn facility_type_ext( self, value: FieldExtension, ) -> DocumentReferenceBuilder

Extension field.

pub fn practice_setting( self, value: CodeableConcept, ) -> DocumentReferenceBuilder

DocumentC80PracticeSetting; Additional details about where the content was created (e.g. clinical specialty)

This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.

This element should be based on a coarse classification system for the class of specialty practice. Recommend the use of the classification system for Practice Setting, such as that described by the Subject Matter Domain in LOINC.

pub fn practice_setting_ext( self, value: FieldExtension, ) -> DocumentReferenceBuilder

Extension field.

pub fn period(self, value: Period) -> DocumentReferenceBuilder

Time of service that is being documented

The time period over which the service that is described by the document was provided.

pub fn period_ext(self, value: FieldExtension) -> DocumentReferenceBuilder

Extension field.

pub fn date(self, value: Instant) -> DocumentReferenceBuilder

When this document reference was created

When the document reference was created.

Referencing/indexing time is used for tracking, organizing versions and searching.

pub fn date_ext(self, value: FieldExtension) -> DocumentReferenceBuilder

Extension field.

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

Who and/or what authored the document

Identifies who is responsible for adding the information to the document.

Not necessarily who did the actual data entry (i.e. typist) or who was the source (informant).

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

Extension field.

pub fn attester( self, value: Vec<Option<DocumentReferenceAttester>>, ) -> DocumentReferenceBuilder

Attests to accuracy of the document

A participant who has authenticated the accuracy of the document.

Only list each attester once.

pub fn attester_ext( self, value: Vec<Option<FieldExtension>>, ) -> DocumentReferenceBuilder

Extension field.

pub fn custodian(self, value: Reference) -> DocumentReferenceBuilder

Organization which maintains the document

Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.

Identifies the logical organization (software system, vendor, or department) to go to find the current version, where to report issues, etc. This is different from the physical location (URL, disk drive, or server) of the document, which is the technical location of the document, which host may be delegated to the management of some other organization.

pub fn custodian_ext(self, value: FieldExtension) -> DocumentReferenceBuilder

Extension field.

pub fn relates_to( self, value: Vec<Option<DocumentReferenceRelatesTo>>, ) -> DocumentReferenceBuilder

Relationships to other documents

Relationships that this document has with other document references that already exist.

This element is labeled as a modifier because documents that append to other documents are incomplete on their own.

pub fn relates_to_ext( self, value: Vec<Option<FieldExtension>>, ) -> DocumentReferenceBuilder

Extension field.

pub fn description(self, value: String) -> DocumentReferenceBuilder

Human-readable description

Human-readable description of the source document.

What the document is about, a terse summary of the document.

pub fn description_ext(self, value: FieldExtension) -> DocumentReferenceBuilder

Extension field.

pub fn security_label( self, value: Vec<Option<CodeableConcept>>, ) -> DocumentReferenceBuilder

SecurityLabels; Document security-tags

A set of Security-Tag codes specifying the level of privacy/security of the Document found at DocumentReference.content.attachment.url. Note that DocumentReference.meta.security contains the security labels of the data elements in DocumentReference, while DocumentReference.securityLabel contains the security labels for the document the reference refers to. The distinction recognizes that the document may contain sensitive information, while the DocumentReference is metadata about the document and thus might not be as sensitive as the document. For example: a psychotherapy episode may contain highly sensitive information, while the metadata may simply indicate that some episode happened.

The confidentiality codes can carry multiple vocabulary items. HL7 has developed an understanding of security and privacy tags that might be desirable in a Document Sharing environment, called HL7 Healthcare Privacy and Security Classification System (HCS). The following specification is recommended but not mandated, as the vocabulary bindings are an administrative domain responsibility. The use of this method is up to the policy domain such as the XDS Affinity Domain or other Trust Domain where all parties including sender and recipients are trusted to appropriately tag and enforce.

In the HL7 Healthcare Privacy and Security Classification (HCS) there are code systems specific to Confidentiality, Sensitivity, Integrity, and Handling Caveats. Some values would come from a local vocabulary as they are related to workflow roles and special projects.

pub fn security_label_ext( self, value: Vec<Option<FieldExtension>>, ) -> DocumentReferenceBuilder

Extension field.

pub fn content( self, value: Vec<Option<DocumentReferenceContent>>, ) -> DocumentReferenceBuilder

Document referenced

The document and format referenced. If there are multiple content element repetitions, these must all represent the same document in different format, or attachment metadata.

content element shall not contain different versions of the same content. For version handling use multiple DocumentReference with .relatesTo.

pub fn content_ext( self, value: Vec<Option<FieldExtension>>, ) -> DocumentReferenceBuilder

Extension field.

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

Builds a new DocumentReferenceInner.

Errors

If a required field has not been initialized.

impl DocumentReferenceBuilder

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

Finalize building DocumentReference.

Trait Implementations

impl Default for DocumentReferenceBuilder

fn default() -> DocumentReferenceBuilder

Returns the “default value” for a type.