Struct CompositionInner

pub struct CompositionInner {

    pub id: Option<String>,
    pub meta: Option<Meta>,
    pub implicit_rules: Option<String>,
    pub language: Option<String>,
    pub text: Option<Narrative>,
    pub contained: Vec<Resource>,
    pub extension: Vec<Extension>,
    pub modifier_extension: Vec<Extension>,
    pub url: Option<String>,
    pub url_ext: Option<FieldExtension>,
    pub identifier: Vec<Option<Identifier>>,
    pub identifier_ext: Vec<Option<FieldExtension>>,
    pub version: Option<String>,
    pub version_ext: Option<FieldExtension>,
    pub status: CompositionStatus,
    pub status_ext: Option<FieldExtension>,
    pub type: CodeableConcept,
    pub type_ext: Option<FieldExtension>,
    pub category: Vec<Option<CodeableConcept>>,
    pub category_ext: Vec<Option<FieldExtension>>,
    pub subject: Vec<Option<Reference>>,
    pub subject_ext: Vec<Option<FieldExtension>>,
    pub encounter: Option<Reference>,
    pub encounter_ext: Option<FieldExtension>,
    pub date: DateTime,
    pub date_ext: Option<FieldExtension>,
    pub use_context: Vec<Option<UsageContext>>,
    pub use_context_ext: Vec<Option<FieldExtension>>,
    pub author: Vec<Option<Reference>>,
    pub author_ext: Vec<Option<FieldExtension>>,
    pub name: Option<String>,
    pub name_ext: Option<FieldExtension>,
    pub title: String,
    pub title_ext: Option<FieldExtension>,
    pub note: Vec<Option<Annotation>>,
    pub note_ext: Vec<Option<FieldExtension>>,
    pub attester: Vec<Option<CompositionAttester>>,
    pub attester_ext: Vec<Option<FieldExtension>>,
    pub custodian: Option<Reference>,
    pub custodian_ext: Option<FieldExtension>,
    pub relates_to: Vec<Option<RelatedArtifact>>,
    pub relates_to_ext: Vec<Option<FieldExtension>>,
    pub event: Vec<Option<CompositionEvent>>,
    pub event_ext: Vec<Option<FieldExtension>>,
    pub section: Vec<Option<CompositionSection>>,
    pub section_ext: Vec<Option<FieldExtension>>,
    /* private fields */
}

A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.).

Composition v5.0.0

A set of resources composed into a single coherent clinical statement with clinical attestation

A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.).

While the focus of this specification is on patient-specific clinical statements, this resource can also apply to other healthcare-related statements such as study protocol designs, healthcare invoices and other activities that are not necessarily patient-specific or clinical.

Fields

id: Option<String>

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.

meta: Option<Meta>

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.

implicit_rules: Option<String>

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.

language: Option<String>

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

text: Option<Narrative>

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.

contained: Vec<Resource>

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.

extension: Vec<Extension>

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.

modifier_extension: Vec<Extension>

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.

url: Option<String>

Canonical identifier for this Composition, represented as a URI (globally unique)

An absolute URI that is used to identify this Composition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this Composition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the Composition is stored on different servers.

Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

url_ext: Option<FieldExtension>

Extension field.

identifier: Vec<Option<Identifier>>

Version-independent identifier for the Composition

A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time.

Similar to ClinicalDocument/setId in CDA. See discussion in resource definition for how these relate.

identifier_ext: Vec<Option<FieldExtension>>

Extension field.

version: Option<String>

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

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

While each resource, including the composition itself, has its own version identifier, this is a formal identifier for the logical version of the Composition 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.

version_ext: Option<FieldExtension>

Extension field.

status: CompositionStatus

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

The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.

If a composition is marked as withdrawn, the compositions/documents in the series, or data from the composition or document series, should never be displayed to a user without being clearly marked as untrustworthy. The flag “entered-in-error” is why this element is labeled as a modifier of other elements.

Some reporting work flows require that the original narrative of a final document never be altered; instead, only new narrative can be added. The composition resource has no explicit status for explicitly noting whether this business rule is in effect. This would be handled by an extension if required.

status_ext: Option<FieldExtension>

Extension field.

type: CodeableConcept

DocumentType; Kind of composition (LOINC if possible)

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

For Composition type, LOINC is ubiquitous and strongly endorsed by HL7. Most implementation guides will require a specific LOINC code, or use LOINC as an extensible binding.

type_ext: Option<FieldExtension>

Extension field.

category: Vec<Option<CodeableConcept>>

DocumentCategory; Categorization of Composition

A categorization for the type of the composition - helps for indexing and searching. This may be implied by or derived from the code specified in the Composition Type.

category_ext: Vec<Option<FieldExtension>>

Extension field.

subject: Vec<Option<Reference>>

Who and/or what the composition is about

Who or what the composition is about. The composition 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 livestock, or a set of patients that share a common exposure).

For clinical documents, this is usually the patient.

subject_ext: Vec<Option<FieldExtension>>

Extension field.

encounter: Option<Reference>

Context of the Composition

Describes the clinical encounter or type of care this documentation is associated with.

encounter_ext: Option<FieldExtension>

Extension field.

date: DateTime

Composition editing time

The composition editing time, when the composition was last logically changed by the author.

The Last Modified Date on the composition may be after the date of the document was attested without being changed. This means that the date on an amended document is the date of the amendment, not the date of original authorship.

date_ext: Option<FieldExtension>

Extension field.

use_context: Vec<Option<UsageContext>>

The context that the content is intended to support

The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, …) or may be references to specific programs (insurance plans, studies, …) and may be used to assist with indexing and searching for appropriate Composition instances.

When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

use_context_ext: Vec<Option<FieldExtension>>

Extension field.

author: Vec<Option<Reference>>

Who and/or what authored the composition

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

author_ext: Vec<Option<FieldExtension>>

Extension field.

name: Option<String>

Name for this Composition (computer friendly)

A natural language name identifying the {{title}}. This name should be usable as an identifier for the module by machine processing applications such as code generation.

The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.

name_ext: Option<FieldExtension>

Extension field.

title: String

Human Readable name/title

Official human-readable label for the composition.

For many compositions, the title is the same as the text or a display name of Composition.type (e.g. a “consultation” or “progress note”). Note that CDA does not make title mandatory, but there are no known cases where it is useful for title to be omitted, so it is mandatory here. Feedback on this requirement is welcome during the trial use period.

title_ext: Option<FieldExtension>

Extension field.

note: Vec<Option<Annotation>>

For any additional notes

For any additional notes.

A comment, general note or annotation not coded elsewhere.

note_ext: Vec<Option<FieldExtension>>

Extension field.

attester: Vec<Option<CompositionAttester>>

Attests to accuracy of composition

A participant who has attested to the accuracy of the composition/document.

Only list each attester once.

attester_ext: Vec<Option<FieldExtension>>

Extension field.

custodian: Option<Reference>

Organization which maintains the composition

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

This is useful when documents are derived from a composition - provides guidance for how to get the latest version of the document. This is optional because this is sometimes not known by the authoring system, and can be inferred by context. However, it is important that this information be known when working with a derived document, so providing a custodian is encouraged.

custodian_ext: Option<FieldExtension>

Extension field.

relates_to: Vec<Option<RelatedArtifact>>

Relationships to other compositions/documents

Relationships that this composition has with other compositions or documents that already exist.

To reference (using relatesTo) a Bundle of type “document” or another Composition where you only have the identifier, use a resourceReference with an identifier.
When a Composition is an alternate representation of another type of document e.g. CDA, the other document could be referenced in a DocumentReference resource. Here is an example of using relatesTo to reference another Bundle of type “document” or Composition where you only have the identifier:

"relatesTo": [{
  "type": "replaces",
  "resourceReference": {
    "identifier": {
      "system": "...",
      "value": "..."
    }
  }
}]

relates_to_ext: Vec<Option<FieldExtension>>

Extension field.

event: Vec<Option<CompositionEvent>>

The clinical service(s) being documented

The clinical service, such as a colonoscopy or an appendectomy, being documented.

The event needs to be consistent with the type element, though can provide further information if desired.

event_ext: Vec<Option<FieldExtension>>

Extension field.

section: Vec<Option<CompositionSection>>

Composition is broken into sections

The root of the sections that make up the composition.

section_ext: Vec<Option<FieldExtension>>

Extension field.

Trait Implementations

impl Clone for CompositionInner

fn clone(&self) -> CompositionInner

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CompositionInner

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CompositionInner

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<CompositionInner> for Composition

fn from(inner: CompositionInner) -> Composition

Converts to this type from the input type.

impl PartialEq for CompositionInner

fn eq(&self, other: &CompositionInner) -> 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 CompositionInner

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 StructuralPartialEq for CompositionInner