Struct fhir_sdk::r5::resources::MessageDefinitionInner

pub struct MessageDefinitionInner {

    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 version_algorithm: Option<MessageDefinitionVersionAlgorithm>,
    pub version_algorithm_ext: Option<MessageDefinitionVersionAlgorithmExtension>,
    pub name: Option<String>,
    pub name_ext: Option<FieldExtension>,
    pub title: Option<String>,
    pub title_ext: Option<FieldExtension>,
    pub replaces: Vec<Option<String>>,
    pub replaces_ext: Vec<Option<FieldExtension>>,
    pub status: PublicationStatus,
    pub status_ext: Option<FieldExtension>,
    pub experimental: Option<bool>,
    pub experimental_ext: Option<FieldExtension>,
    pub date: DateTime,
    pub date_ext: Option<FieldExtension>,
    pub publisher: Option<String>,
    pub publisher_ext: Option<FieldExtension>,
    pub contact: Vec<Option<ContactDetail>>,
    pub contact_ext: Vec<Option<FieldExtension>>,
    pub description: Option<String>,
    pub description_ext: Option<FieldExtension>,
    pub use_context: Vec<Option<UsageContext>>,
    pub use_context_ext: Vec<Option<FieldExtension>>,
    pub jurisdiction: Vec<Option<CodeableConcept>>,
    pub jurisdiction_ext: Vec<Option<FieldExtension>>,
    pub purpose: Option<String>,
    pub purpose_ext: Option<FieldExtension>,
    pub copyright: Option<String>,
    pub copyright_ext: Option<FieldExtension>,
    pub copyright_label: Option<String>,
    pub copyright_label_ext: Option<FieldExtension>,
    pub base: Option<String>,
    pub base_ext: Option<FieldExtension>,
    pub parent: Vec<Option<String>>,
    pub parent_ext: Vec<Option<FieldExtension>>,
    pub event: MessageDefinitionEvent,
    pub event_ext: Option<MessageDefinitionEventExtension>,
    pub category: Option<MessageSignificanceCategory>,
    pub category_ext: Option<FieldExtension>,
    pub focus: Vec<Option<MessageDefinitionFocus>>,
    pub focus_ext: Vec<Option<FieldExtension>>,
    pub response_required: Option<MessageheaderResponseRequest>,
    pub response_required_ext: Option<FieldExtension>,
    pub allowed_response: Vec<Option<MessageDefinitionAllowedResponse>>,
    pub allowed_response_ext: Vec<Option<FieldExtension>>,
    pub graph: Option<String>,
    pub graph_ext: Option<FieldExtension>,
    /* private fields */
}

Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted.

MessageDefinition v5.0.0

A resource that defines a type of message that can be exchanged between systems

Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted.

This would be a MIF-level artifact.

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>

The cannonical URL for a given MessageDefinition

The business identifier that is used to reference the MessageDefinition and is expected to be consistent from server to server.

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.

The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions.

In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.

url_ext: Option<FieldExtension>

Extension field.

identifier: Vec<Option<Identifier>>

Business Identifier for a given MessageDefinition

A formal identifier that is used to identify this message definition when it is represented in other formats, or referenced in a specification, model, design or an instance.

Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this message definition outside of FHIR, where it is not possible to use the logical URI.

identifier_ext: Vec<Option<FieldExtension>>

Extension field.

version: Option<String>

Business version of the message definition

The identifier that is used to identify this version of the message definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the message definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

There may be different message definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the message definition with the format [url]|[version]. The version SHOULD NOT contain a ‘#’ - see Business Version.

version_ext: Option<FieldExtension>

Extension field.

version_algorithm: Option<MessageDefinitionVersionAlgorithm>

How to compare versions

Indicates the mechanism used to compare versions to determine which is more current.

If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can’t be successfully be determined.

version_algorithm_ext: Option<MessageDefinitionVersionAlgorithmExtension>

Extension field.

name: Option<String>

Name for this message definition (computer friendly)

A natural language name identifying the message definition. 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: Option<String>

Name for this message definition (human friendly)

A short, descriptive, user-friendly title for the message definition.

This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

title_ext: Option<FieldExtension>

Extension field.

replaces: Vec<Option<String>>

Takes the place of

A MessageDefinition that is superseded by this definition.

replaces_ext: Vec<Option<FieldExtension>>

Extension field.

status: PublicationStatus

PublicationStatus; draft | active | retired | unknown

The status of this message definition. Enables tracking the life-cycle of the content.

Allows filtering of message definitions that are appropriate for use versus not.

See guidance around (not) making local changes to elements here.

status_ext: Option<FieldExtension>

Extension field.

experimental: Option<bool>

For testing purposes, not real usage

A Boolean value to indicate that this message definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

Allows filtering of message definitions that are appropriate for use versus not.

experimental_ext: Option<FieldExtension>

Extension field.

date: DateTime

Date last changed

The date (and optionally time) when the message definition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the message definition changes.

The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the message definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

See guidance around (not) making local changes to elements here.

date_ext: Option<FieldExtension>

Extension field.

publisher: Option<String>

Name of the publisher/steward (organization or individual)

The name of the organization or individual responsible for the release and ongoing maintenance of the message definition.

Usually an organization but may be an individual. The publisher (or steward) of the message definition is the organization or individual primarily responsible for the maintenance and upkeep of the message definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the message definition. This item SHOULD be populated unless the information is available from context.

publisher_ext: Option<FieldExtension>

Extension field.

contact: Vec<Option<ContactDetail>>

Contact details for the publisher

Contact details to assist a user in finding and communicating with the publisher.

May be a web site, an email address, a telephone number, etc.

See guidance around (not) making local changes to elements here.

contact_ext: Vec<Option<FieldExtension>>

Extension field.

description: Option<String>

Natural language description of the message definition

A free text natural language description of the message definition from a consumer’s perspective.

This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the message definition as conveyed in the ‘text’ field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the message definition is presumed to be the predominant language in the place the message definition was created).

description_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 message definition 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.

jurisdiction: Vec<Option<CodeableConcept>>

Jurisdiction; Intended jurisdiction for message definition (if applicable)

A legal or geographic region in which the message definition is intended to be used.

It may be possible for the message definition to be used in jurisdictions other than those for which it was originally designed or intended.

DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new ‘jurisdiction’ code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)

jurisdiction_ext: Vec<Option<FieldExtension>>

Extension field.

purpose: Option<String>

Why this message definition is defined

Explanation of why this message definition is needed and why it has been designed as it has.

This element does not describe the usage of the message definition. Instead, it provides traceability of ’‘why’’ the resource is either needed or ’‘why’’ it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this message definition.

purpose_ext: Option<FieldExtension>

Extension field.

copyright: Option<String>

Use and/or publishing restrictions

A copyright statement relating to the message definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the message definition.

copyright_ext: Option<FieldExtension>

Extension field.

copyright_label: Option<String>

Copyright holder and year(s)

A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. ‘All rights reserved’, ‘Some rights reserved’).

The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general ‘copyright’ element.

copyright_label_ext: Option<FieldExtension>

Extension field.

base: Option<String>

Definition this one is based on

The MessageDefinition that is the basis for the contents of this resource.

base_ext: Option<FieldExtension>

Extension field.

parent: Vec<Option<String>>

Protocol/workflow this is part of

Identifies a protocol or workflow that this MessageDefinition represents a step in.

It should be possible to use MessageDefinition to describe a message to be used by certain steps in a particular protocol as part of a PlanDefinition or ActivityDefinition.

parent_ext: Vec<Option<FieldExtension>>

Extension field.

event: MessageDefinitionEvent

Event code or link to the EventDefinition

Event code or link to the EventDefinition.

event_ext: Option<MessageDefinitionEventExtension>

Extension field.

category: Option<MessageSignificanceCategory>

MessageSignificanceCategory; consequence | currency | notification

The impact of the content of the message.

category_ext: Option<FieldExtension>

Extension field.

focus: Vec<Option<MessageDefinitionFocus>>

Resource(s) that are the subject of the event

Identifies the resource (or resources) that are being addressed by the event. For example, the Encounter for an admit message or two Account records for a merge.

focus_ext: Vec<Option<FieldExtension>>

Extension field.

response_required: Option<MessageheaderResponseRequest>

messageheader-response-request; always | on-error | never | on-success

Declare at a message definition level whether a response is required or only upon error or success, or never.

This enables the capability currently available through MSH-16 (Application Level acknowledgement) in HL7 Version 2 to declare at a message instance level whether a response is required or only upon error or success, or never.

response_required_ext: Option<FieldExtension>

Extension field.

allowed_response: Vec<Option<MessageDefinitionAllowedResponse>>

Responses to this message

Indicates what types of messages may be sent as an application-level response to this message.

This indicates an application level response to “close” a transaction implicit in a particular request message. To define a complete workflow scenario, look to the [PlanDefinition] resource which allows the definition of complex orchestrations, conditionality, etc.

allowed_response_ext: Vec<Option<FieldExtension>>

Extension field.

graph: Option<String>

Canonical reference to a GraphDefinition

Graph is Canonical reference to a GraphDefinition. If a URL is provided, it is the canonical reference to a GraphDefinition that it controls what additional resources are to be added to the Bundle when building the message. The GraphDefinition can also specify profiles that apply to the various resources.

graph_ext: Option<FieldExtension>

Extension field.

Trait Implementations

impl Clone for MessageDefinitionInner

fn clone(&self) -> MessageDefinitionInner

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MessageDefinitionInner

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MessageDefinitionInner

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<MessageDefinitionInner> for MessageDefinition

fn from(inner: MessageDefinitionInner) -> MessageDefinition

Converts to this type from the input type.

impl PartialEq for MessageDefinitionInner

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

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 MessageDefinitionInner