Package com.ibm.fhir.model.resource

Class MessageDefinition.Builder

    • Method Detail

      • id

        public MessageDefinition.Builder id​(String id)
        The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
        Overrides:
        id in class DomainResource.Builder
        Parameters:
        id - Logical id of this artifact
        Returns:
        A reference to this Builder instance

      • meta

        public MessageDefinition.Builder meta​(Meta 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.
        Overrides:
        meta in class DomainResource.Builder
        Parameters:
        meta - Metadata about the resource
        Returns:
        A reference to this Builder instance

      • implicitRules

        public MessageDefinition.Builder implicitRules​(Uri implicitRules)
        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.
        Overrides:
        implicitRules in class DomainResource.Builder
        Parameters:
        implicitRules - A set of rules under which this content was created
        Returns:
        A reference to this Builder instance

      • text

        public MessageDefinition.Builder text​(Narrative text)
        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.
        Overrides:
        text in class DomainResource.Builder
        Parameters:
        text - Text summary of the resource, for human interpretation
        Returns:
        A reference to this Builder instance

      • contained

        public MessageDefinition.Builder contained​(Resource... contained)
        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.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Overrides:
        contained in class DomainResource.Builder
        Parameters:
        contained - Contained, inline Resources
        Returns:
        A reference to this Builder instance

      • contained

        public MessageDefinition.Builder contained​(Collection<Resource> contained)
        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.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Overrides:
        contained in class DomainResource.Builder
        Parameters:
        contained - Contained, inline Resources
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • extension

        public MessageDefinition.Builder extension​(Extension... 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.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Overrides:
        extension in class DomainResource.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance

      • extension

        public MessageDefinition.Builder extension​(Collection<Extension> 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.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Overrides:
        extension in class DomainResource.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • modifierExtension

        public MessageDefinition.Builder modifierExtension​(Extension... modifierExtension)
        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).

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Overrides:
        modifierExtension in class DomainResource.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored
        Returns:
        A reference to this Builder instance

      • modifierExtension

        public MessageDefinition.Builder modifierExtension​(Collection<Extension> modifierExtension)
        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).

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Overrides:
        modifierExtension in class DomainResource.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • url

        public MessageDefinition.Builder url​(Uri url)
        The business identifier that is used to reference the MessageDefinition and *is* expected to be consistent from server to server.
        Parameters:
        url - Business Identifier for a given MessageDefinition
        Returns:
        A reference to this Builder instance

      • identifier

        public MessageDefinition.Builder identifier​(Identifier... identifier)
        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.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        identifier - Primary key for the message definition on a given server
        Returns:
        A reference to this Builder instance

      • identifier

        public MessageDefinition.Builder identifier​(Collection<Identifier> identifier)
        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.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        identifier - Primary key for the message definition on a given server
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • version

        public MessageDefinition.Builder version​(String version)
        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.
        Parameters:
        version - Business version of the message definition
        Returns:
        A reference to this Builder instance

      • name

        public MessageDefinition.Builder name​(String name)
        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.
        Parameters:
        name - Name for this message definition (computer friendly)
        Returns:
        A reference to this Builder instance

      • title

        public MessageDefinition.Builder title​(String title)
        A short, descriptive, user-friendly title for the message definition.
        Parameters:
        title - Name for this message definition (human friendly)
        Returns:
        A reference to this Builder instance

      • replaces

        public MessageDefinition.Builder replaces​(Canonical... replaces)
        A MessageDefinition that is superseded by this definition.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        replaces - Takes the place of
        Returns:
        A reference to this Builder instance

      • replaces

        public MessageDefinition.Builder replaces​(Collection<Canonical> replaces)
        A MessageDefinition that is superseded by this definition.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        replaces - Takes the place of
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • status

        public MessageDefinition.Builder status​(PublicationStatus status)
        The status of this message definition. Enables tracking the life-cycle of the content.

        This element is required.

        Parameters:
        status - draft | active | retired | unknown
        Returns:
        A reference to this Builder instance

      • experimental

        public MessageDefinition.Builder experimental​(Boolean experimental)
        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.
        Parameters:
        experimental - For testing purposes, not real usage
        Returns:
        A reference to this Builder instance

      • date

        public MessageDefinition.Builder date​(DateTime date)
        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.

        This element is required.

        Parameters:
        date - Date last changed
        Returns:
        A reference to this Builder instance

      • publisher

        public MessageDefinition.Builder publisher​(String publisher)
        The name of the organization or individual that published the message definition.
        Parameters:
        publisher - Name of the publisher (organization or individual)
        Returns:
        A reference to this Builder instance

      • contact

        public MessageDefinition.Builder contact​(ContactDetail... contact)
        Contact details to assist a user in finding and communicating with the publisher.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        contact - Contact details for the publisher
        Returns:
        A reference to this Builder instance

      • contact

        public MessageDefinition.Builder contact​(Collection<ContactDetail> contact)
        Contact details to assist a user in finding and communicating with the publisher.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        contact - Contact details for the publisher
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • description

        public MessageDefinition.Builder description​(Markdown description)
        A free text natural language description of the message definition from a consumer's perspective.
        Parameters:
        description - Natural language description of the message definition
        Returns:
        A reference to this Builder instance

      • useContext

        public MessageDefinition.Builder useContext​(UsageContext... useContext)
        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.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        useContext - The context that the content is intended to support
        Returns:
        A reference to this Builder instance

      • useContext

        public MessageDefinition.Builder useContext​(Collection<UsageContext> useContext)
        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.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        useContext - The context that the content is intended to support
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • jurisdiction

        public MessageDefinition.Builder jurisdiction​(CodeableConcept... jurisdiction)
        A legal or geographic region in which the message definition is intended to be used.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        jurisdiction - Intended jurisdiction for message definition (if applicable)
        Returns:
        A reference to this Builder instance

      • jurisdiction

        public MessageDefinition.Builder jurisdiction​(Collection<CodeableConcept> jurisdiction)
        A legal or geographic region in which the message definition is intended to be used.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        jurisdiction - Intended jurisdiction for message definition (if applicable)
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • purpose

        public MessageDefinition.Builder purpose​(Markdown purpose)
        Explanation of why this message definition is needed and why it has been designed as it has.
        Parameters:
        purpose - Why this message definition is defined
        Returns:
        A reference to this Builder instance

      • copyright

        public MessageDefinition.Builder copyright​(Markdown copyright)
        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.
        Parameters:
        copyright - Use and/or publishing restrictions
        Returns:
        A reference to this Builder instance

      • base

        public MessageDefinition.Builder base​(Canonical base)
        The MessageDefinition that is the basis for the contents of this resource.
        Parameters:
        base - Definition this one is based on
        Returns:
        A reference to this Builder instance

      • parent

        public MessageDefinition.Builder parent​(Canonical... parent)
        Identifies a protocol or workflow that this MessageDefinition represents a step in.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        parent - Protocol/workflow this is part of
        Returns:
        A reference to this Builder instance

      • parent

        public MessageDefinition.Builder parent​(Collection<Canonical> parent)
        Identifies a protocol or workflow that this MessageDefinition represents a step in.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        parent - Protocol/workflow this is part of
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • event

        public MessageDefinition.Builder event​(Element event)
        Event code or link to the EventDefinition.

        This element is required.

        This is a choice element with the following allowed types:

        Parameters:
        event - Event code or link to the EventDefinition
        Returns:
        A reference to this Builder instance

      • focus

        public MessageDefinition.Builder focus​(MessageDefinition.Focus... focus)
        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.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        focus - Resource(s) that are the subject of the event
        Returns:
        A reference to this Builder instance

      • focus

        public MessageDefinition.Builder focus​(Collection<MessageDefinition.Focus> focus)
        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.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        focus - Resource(s) that are the subject of the event
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • responseRequired

        public MessageDefinition.Builder responseRequired​(MessageHeaderResponseRequest responseRequired)
        Declare at a message definition level whether a response is required or only upon error or success, or never.
        Parameters:
        responseRequired - always | on-error | never | on-success
        Returns:
        A reference to this Builder instance

      • allowedResponse

        public MessageDefinition.Builder allowedResponse​(MessageDefinition.AllowedResponse... allowedResponse)
        Indicates what types of messages may be sent as an application-level response to this message.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        allowedResponse - Responses to this message
        Returns:
        A reference to this Builder instance

      • allowedResponse

        public MessageDefinition.Builder allowedResponse​(Collection<MessageDefinition.AllowedResponse> allowedResponse)
        Indicates what types of messages may be sent as an application-level response to this message.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        allowedResponse - Responses to this message
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • graph

        public MessageDefinition.Builder graph​(Canonical... graph)
        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.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        graph - Canonical reference to a GraphDefinition
        Returns:
        A reference to this Builder instance

      • graph

        public MessageDefinition.Builder graph​(Collection<Canonical> graph)
        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.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        graph - Canonical reference to a GraphDefinition
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null