Package org.linuxforhealth.fhir.model.resource

Class MessageDefinition

  • All Implemented Interfaces:
    Visitable
    @Generated("org.linuxforhealth.fhir.tools.CodeGenerator")
public class MessageDefinition
extends DomainResource
    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.

    Maturity level: FMM1 (Trial Use)

    • Method Detail

      • getUrl

        public Uri getUrl()
        The business identifier that is used to reference the MessageDefinition and *is* expected to be consistent from server to server.
        Returns:
        An immutable object of type Uri that may be null.

      • getIdentifier

        public java.util.List<Identifier> getIdentifier()
        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.
        Returns:
        An unmodifiable list containing immutable objects of type Identifier that may be empty.

      • getVersion

        public String getVersion()
        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.
        Returns:
        An immutable object of type String that may be null.

      • getName

        public String getName()
        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.
        Returns:
        An immutable object of type String that may be null.

      • getTitle

        public String getTitle()
        A short, descriptive, user-friendly title for the message definition.
        Returns:
        An immutable object of type String that may be null.

      • getReplaces

        public java.util.List<Canonical> getReplaces()
        A MessageDefinition that is superseded by this definition.
        Returns:
        An unmodifiable list containing immutable objects of type Canonical that may be empty.

      • getStatus

        public PublicationStatus getStatus()
        The status of this message definition. Enables tracking the life-cycle of the content.
        Returns:
        An immutable object of type PublicationStatus that is non-null.

      • getExperimental

        public Boolean getExperimental()
        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.
        Returns:
        An immutable object of type Boolean that may be null.

      • getDate

        public DateTime getDate()
        The date (and optionally time) when the message definition was published. 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.
        Returns:
        An immutable object of type DateTime that is non-null.

      • getPublisher

        public String getPublisher()
        The name of the organization or individual that published the message definition.
        Returns:
        An immutable object of type String that may be null.

      • getContact

        public java.util.List<ContactDetail> getContact()
        Contact details to assist a user in finding and communicating with the publisher.
        Returns:
        An unmodifiable list containing immutable objects of type ContactDetail that may be empty.

      • getDescription

        public Markdown getDescription()
        A free text natural language description of the message definition from a consumer's perspective.
        Returns:
        An immutable object of type Markdown that may be null.

      • getUseContext

        public java.util.List<UsageContext> getUseContext()
        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.
        Returns:
        An unmodifiable list containing immutable objects of type UsageContext that may be empty.

      • getJurisdiction

        public java.util.List<CodeableConcept> getJurisdiction()
        A legal or geographic region in which the message definition is intended to be used.
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

      • getPurpose

        public Markdown getPurpose()
        Explanation of why this message definition is needed and why it has been designed as it has.
        Returns:
        An immutable object of type Markdown that may be null.

      • getCopyright

        public Markdown getCopyright()
        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.
        Returns:
        An immutable object of type Markdown that may be null.

      • getBase

        public Canonical getBase()
        The MessageDefinition that is the basis for the contents of this resource.
        Returns:
        An immutable object of type Canonical that may be null.

      • getParent

        public java.util.List<Canonical> getParent()
        Identifies a protocol or workflow that this MessageDefinition represents a step in.
        Returns:
        An unmodifiable list containing immutable objects of type Canonical that may be empty.

      • getEvent

        public Element getEvent()
        Event code or link to the EventDefinition.
        Returns:
        An immutable object of type Coding or Uri that is non-null.

      • getFocus

        public java.util.List<MessageDefinition.Focus> getFocus()
        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.
        Returns:
        An unmodifiable list containing immutable objects of type MessageDefinition.Focus that may be empty.

      • getGraph

        public java.util.List<Canonical> getGraph()
        Canonical reference to a GraphDefinition. If a URL is provided, it is the canonical reference to a [GraphDefinition] (graphdefinition.html) that it controls what resources are to be added to the bundle when building the document. The GraphDefinition can also specify profiles that apply to the various resources.
        Returns:
        An unmodifiable list containing immutable objects of type Canonical that may be empty.

      • accept

        public void accept​(java.lang.String elementName,
                   int elementIndex,
                   Visitor visitor)
        Description copied from interface: Visitable
        Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this: 
         if (visitor.preVisit(this)) {
     visitor.visitStart(elementName, elementIndex, this);
     if (visitor.visit(elementName, elementIndex, this)) {
         // visit children
     }
     visitor.visitEnd(elementName, elementIndex, this);
     visitor.postVisit(this);
 }
        Specified by:
        accept in interface Visitable
        Specified by:
        accept in class AbstractVisitable
        Parameters:
        elementName - the name of the element in the context of this visit
        elementIndex - the index of the element in a list or -1 if it is not contained within a List
        visitor - the visitor to use

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object