Struct DocumentReference

pub struct DocumentReference(pub Box<DocumentReferenceInner>);

A reference to a document of any kind for any purpose. While the term “document” implies a more narrow focus, for this resource this “document” encompasses any serialized object with a mime-type, it includes formal patient-centric documents (CDA), clinical notes, scanned paper, non-patient specific documents like policy text, as well as a photo, video, or audio recording acquired or used in healthcare. The DocumentReference resource provides metadata about the document so that the document can be discovered and managed. The actual content may be inline base64 encoded data or provided by direct reference.

DocumentReference v5.0.0

A reference to a document

A reference to a document of any kind for any purpose. While the term “document” implies a more narrow focus, for this resource this “document” encompasses any serialized object with a mime-type, it includes formal patient-centric documents (CDA), clinical notes, scanned paper, non-patient specific documents like policy text, as well as a photo, video, or audio recording acquired or used in healthcare. The DocumentReference resource provides metadata about the document so that the document can be discovered and managed. The actual content may be inline base64 encoded data or provided by direct reference.

Usually, this is used for documents other than those defined by FHIR.

Tuple Fields

0: Box<DocumentReferenceInner>

Implementations

impl DocumentReference

pub fn builder() -> DocumentReferenceBuilder

Start building an instance.

impl DocumentReference

pub const fn resource_type() -> ResourceType

Get the resource type for this FHIR resource.

Trait Implementations

impl BaseResource for DocumentReference

fn id(&self) -> &Option<String>

Get id.

fn id_mut(&mut self) -> &mut Option<String>

Get id mutably.

fn set_id(&mut self, value: Option<String>)

Set id.

fn meta(&self) -> &Option<Meta>

Get meta.

fn meta_mut(&mut self) -> &mut Option<Meta>

Get meta mutably.

fn set_meta(&mut self, value: Option<Meta>)

Set meta.

fn implicit_rules(&self) -> &Option<String>

Get implicit_rules.

fn implicit_rules_mut(&mut self) -> &mut Option<String>

Get implicit_rules mutably.

fn set_implicit_rules(&mut self, value: Option<String>)

Set implicit_rules.

fn language(&self) -> &Option<String>

Get language.

fn language_mut(&mut self) -> &mut Option<String>

Get language mutably.

fn set_language(&mut self, value: Option<String>)

Set language.

impl Clone for DocumentReference

fn clone(&self) -> DocumentReference

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentReference

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

Formats the value using the given formatter.

impl Deref for DocumentReference

type Target = DocumentReferenceInner

The resulting type after dereferencing.

fn deref(&self) -> &<DocumentReference as Deref>::Target

Dereferences the value.

impl DerefMut for DocumentReference

fn deref_mut(&mut self) -> &mut <DocumentReference as Deref>::Target

Mutably dereferences the value.

impl<'de> Deserialize<'de> for DocumentReference

fn deserialize<__D>( __deserializer: __D, ) -> Result<DocumentReference, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl DomainResource for DocumentReference

fn id(&self) -> &Option<String>

Get id.

fn id_mut(&mut self) -> &mut Option<String>

Get id mutably.

fn set_id(&mut self, value: Option<String>)

Set id.

fn meta(&self) -> &Option<Meta>

Get meta.

fn meta_mut(&mut self) -> &mut Option<Meta>

Get meta mutably.

fn set_meta(&mut self, value: Option<Meta>)

Set meta.

fn implicit_rules(&self) -> &Option<String>

Get implicit_rules.

fn implicit_rules_mut(&mut self) -> &mut Option<String>

Get implicit_rules mutably.

fn set_implicit_rules(&mut self, value: Option<String>)

Set implicit_rules.

fn language(&self) -> &Option<String>

Get language.

fn language_mut(&mut self) -> &mut Option<String>

Get language mutably.

fn set_language(&mut self, value: Option<String>)

Set language.

fn text(&self) -> &Option<Narrative>

Get text.

fn text_mut(&mut self) -> &mut Option<Narrative>

Get text mutably.

fn set_text(&mut self, value: Option<Narrative>)

Set text.

fn contained(&self) -> &Vec<Resource>

Get contained.

fn contained_mut(&mut self) -> &mut Vec<Resource>

Get contained mutably.

fn set_contained(&mut self, value: Vec<Resource>)

Set contained.

fn extension(&self) -> &Vec<Extension>

Get extension.

fn extension_mut(&mut self) -> &mut Vec<Extension>

Get extension mutably.

fn set_extension(&mut self, value: Vec<Extension>)

Set extension.

fn modifier_extension(&self) -> &Vec<Extension>

Get modifier_extension.

fn modifier_extension_mut(&mut self) -> &mut Vec<Extension>

Get modifier_extension mutably.

fn set_modifier_extension(&mut self, value: Vec<Extension>)

Set modifier_extension.

impl From<DocumentReference> for Resource

fn from(resource: DocumentReference) -> Resource

Converts to this type from the input type.

impl From<DocumentReferenceInner> for DocumentReference

fn from(inner: DocumentReferenceInner) -> DocumentReference

Converts to this type from the input type.

impl IdentifiableResource for DocumentReference

fn identifier(&self) -> &Vec<Option<Identifier>>

Get the identifier field.

fn identifier_mut(&mut self) -> &mut Vec<Option<Identifier>>

Get the identifier field mutably.

fn set_identifier(&mut self, value: Vec<Option<Identifier>>)

Set the identifier field.

fn identifier_ext(&self) -> &Vec<Option<FieldExtension>>

Get the identifier extension field.

fn identifier_ext_mut(&mut self) -> &mut Vec<Option<FieldExtension>>

Get the identifier extension field mutably.

fn set_identifier_ext(&mut self, value: Vec<Option<FieldExtension>>)

Set the identifier extension field.

fn place_identifier(&mut self, identifier: Identifier) -> bool

Append or replace an identifier. If there is already an identifier with the same system or type (exact full match), it is replaced, otherwise appended.

fn identifier_with_system(&self, system: &str) -> Option<&String>

Return the first identifier value for a given system.

fn identifiers_with_system(&self, system: &str) -> Vec<&Identifier>

Return a list of identifiers for a given system.

fn identifier_with_type( &self, type_system: &str, type_code: &str, ) -> Option<&String>

Return the first identifier value for a given type.

fn identifiers_with_type( &self, type_system: &str, type_code: &str, ) -> Vec<&Identifier>

Return a list of identifiers for a given type.

impl NamedResource for DocumentReference

const FHIR_VERSION: &'static str = "5.0.0"

The FHIR version of this resource.

const TYPE: ResourceType = ResourceType::DocumentReference

The ResourceType of this resouce.

impl PartialEq for DocumentReference

fn eq(&self, other: &DocumentReference) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for DocumentReference

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> TryFrom<&'a Resource> for &'a DocumentReference

type Error = WrongResourceType

The type returned in the event of a conversion error.

fn try_from( resource: &'a Resource, ) -> Result<&'a DocumentReference, <&'a DocumentReference as TryFrom<&'a Resource>>::Error>

Performs the conversion.

impl<'a> TryFrom<&'a mut Resource> for &'a mut DocumentReference

type Error = WrongResourceType

The type returned in the event of a conversion error.

fn try_from( resource: &'a mut Resource, ) -> Result<&'a mut DocumentReference, <&'a mut DocumentReference as TryFrom<&'a mut Resource>>::Error>

Performs the conversion.

impl TryFrom<Resource> for DocumentReference

type Error = WrongResourceType

The type returned in the event of a conversion error.

fn try_from( resource: Resource, ) -> Result<DocumentReference, <DocumentReference as TryFrom<Resource>>::Error>

Performs the conversion.

impl StructuralPartialEq for DocumentReference