DocumentReference

Struct DocumentReference 

Source
pub struct DocumentReference {
Show 24 fields pub id: Option<String>, pub meta: Option<Box<Meta>>, pub implicitRules: Option<Box<FHIRUri>>, pub language: Option<Box<FHIRCode>>, pub text: Option<Box<Narrative>>, pub contained: Option<Vec<Box<Resource>>>, pub extension: Option<Vec<Box<Extension>>>, pub modifierExtension: Option<Vec<Box<Extension>>>, pub masterIdentifier: Option<Box<Identifier>>, pub identifier_: Option<Vec<Box<Identifier>>>, pub status: Box<DocumentReferenceStatus>, pub docStatus: Option<Box<CompositionStatus>>, pub type_: Option<Box<CodeableConcept>>, pub category: Option<Vec<Box<CodeableConcept>>>, pub subject: Option<Box<Reference>>, pub date: Option<Box<FHIRInstant>>, pub author: Option<Vec<Box<Reference>>>, pub authenticator: Option<Box<Reference>>, pub custodian: Option<Box<Reference>>, pub relatesTo: Option<Vec<DocumentReferenceRelatesTo>>, pub description: Option<Box<FHIRString>>, pub securityLabel: Option<Vec<Box<CodeableConcept>>>, pub content: Vec<DocumentReferenceContent>, pub context: Option<DocumentReferenceContext>,
}
Expand description

A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.

Fields§

§id: Option<String>

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

§meta: Option<Box<Meta>>

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.

§implicitRules: Option<Box<FHIRUri>>

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.

§language: Option<Box<FHIRCode>>

The base language in which the resource is written.

§text: Option<Box<Narrative>>

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: Option<Vec<Box<Resource>>>

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

§extension: Option<Vec<Box<Extension>>>

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 manageable, 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.

§modifierExtension: Option<Vec<Box<Extension>>>

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 manageable, 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).

§masterIdentifier: Option<Box<Identifier>>

Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document.

§identifier_: Option<Vec<Box<Identifier>>>

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

§status: Box<DocumentReferenceStatus>

The status of this document reference.

§docStatus: Option<Box<CompositionStatus>>

The status of the underlying document.

§type_: Option<Box<CodeableConcept>>

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.

§category: Option<Vec<Box<CodeableConcept>>>

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.

§subject: Option<Box<Reference>>

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

§date: Option<Box<FHIRInstant>>

When the document reference was created.

§author: Option<Vec<Box<Reference>>>

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

§authenticator: Option<Box<Reference>>

Which person or organization authenticates that this document is valid.

§custodian: Option<Box<Reference>>

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

§relatesTo: Option<Vec<DocumentReferenceRelatesTo>>

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

§description: Option<Box<FHIRString>>

Human-readable description of the source document.

§securityLabel: Option<Vec<Box<CodeableConcept>>>

A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the “reference” to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to.

§content: Vec<DocumentReferenceContent>

The document and format referenced. There may be multiple content element repetitions, each with a different format.

§context: Option<DocumentReferenceContext>

The clinical context in which the document was prepared.

Trait Implementations§

Source§

impl Clone for DocumentReference

Source§

fn clone(&self) -> DocumentReference

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for DocumentReference

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for DocumentReference

Source§

fn default() -> DocumentReference

Returns the “default value” for a type. Read more
Source§

impl FHIRJSONDeserializer for DocumentReference

Source§

impl FHIRJSONSerializer for DocumentReference

Source§

fn serialize_value( &self, writer: &mut dyn Write, ) -> Result<bool, SerializeError>

Source§

fn serialize_extension( &self, writer: &mut dyn Write, ) -> Result<bool, SerializeError>

Source§

fn serialize_field( &self, field: &str, writer: &mut dyn Write, ) -> Result<bool, SerializeError>

Source§

fn is_fp_primitive(&self) -> bool

Source§

impl MetaValue for DocumentReference

Source§

fn fields(&self) -> Vec<&'static str>

Source§

fn get_field<'a>(&'a self, field: &str) -> Option<&'a dyn MetaValue>

Source§

fn get_field_mut<'a>(&'a mut self, field: &str) -> Option<&'a mut dyn MetaValue>

Source§

fn get_index_mut<'a>( &'a mut self, index: usize, ) -> Option<&'a mut dyn MetaValue>

Source§

fn get_index<'a>(&'a self, _index: usize) -> Option<&'a dyn MetaValue>

Source§

fn typename(&self) -> &'static str

Source§

fn as_any(&self) -> &dyn Any

Source§

fn flatten(&self) -> Vec<&dyn MetaValue>

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more