Package com.ibm.fhir.model.resource

Class Endpoint.Builder

    • Method Detail

      • id

        public Endpoint.Builder id​(java.lang.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 Endpoint.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 Endpoint.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

      • language

        public Endpoint.Builder language​(Code language)
        The base language in which the resource is written.
        Overrides:
        language in class DomainResource.Builder
        Parameters:
        language - Language of the resource content
        Returns:
        A reference to this Builder instance

      • text

        public Endpoint.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 Endpoint.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 Endpoint.Builder contained​(java.util.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:
        java.lang.NullPointerException - If the passed collection is null

      • extension

        public Endpoint.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 Endpoint.Builder extension​(java.util.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:
        java.lang.NullPointerException - If the passed collection is null

      • modifierExtension

        public Endpoint.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 Endpoint.Builder modifierExtension​(java.util.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:
        java.lang.NullPointerException - If the passed collection is null

      • identifier

        public Endpoint.Builder identifier​(Identifier... identifier)
        Identifier for the organization that is used to identify the endpoint across multiple disparate systems.

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

        Parameters:
        identifier - Identifies this endpoint across multiple systems
        Returns:
        A reference to this Builder instance

      • identifier

        public Endpoint.Builder identifier​(java.util.Collection<Identifier> identifier)
        Identifier for the organization that is used to identify the endpoint across multiple disparate systems.

        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 - Identifies this endpoint across multiple systems
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • status

        public Endpoint.Builder status​(EndpointStatus status)
        active | suspended | error | off | test.

        This element is required.

        Parameters:
        status - active | suspended | error | off | entered-in-error | test
        Returns:
        A reference to this Builder instance

      • connectionType

        public Endpoint.Builder connectionType​(Coding connectionType)
        A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook).

        This element is required.

        Parameters:
        connectionType - Protocol/Profile/Standard to be used with this endpoint connection
        Returns:
        A reference to this Builder instance

      • name

        public Endpoint.Builder name​(java.lang.String name)
        Convenience method for setting name.
        Parameters:
        name - A name that this endpoint can be identified by
        Returns:
        A reference to this Builder instance
        See Also:
        name(com.ibm.fhir.model.type.String)

      • name

        public Endpoint.Builder name​(String name)
        A friendly name that this endpoint can be referred to with.
        Parameters:
        name - A name that this endpoint can be identified by
        Returns:
        A reference to this Builder instance

      • managingOrganization

        public Endpoint.Builder managingOrganization​(Reference managingOrganization)
        The organization that manages this endpoint (even if technically another organization is hosting this in the cloud, it is the organization associated with the data).

        Allowed resource types for this reference:

        Parameters:
        managingOrganization - Organization that manages this endpoint (might not be the organization that exposes the endpoint)
        Returns:
        A reference to this Builder instance

      • contact

        public Endpoint.Builder contact​(ContactPoint... contact)
        Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.

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

        Parameters:
        contact - Contact details for source (e.g. troubleshooting)
        Returns:
        A reference to this Builder instance

      • contact

        public Endpoint.Builder contact​(java.util.Collection<ContactPoint> contact)
        Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.

        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 source (e.g. troubleshooting)
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • period

        public Endpoint.Builder period​(Period period)
        The interval during which the endpoint is expected to be operational.
        Parameters:
        period - Interval the endpoint is expected to be operational
        Returns:
        A reference to this Builder instance

      • payloadType

        public Endpoint.Builder payloadType​(CodeableConcept... payloadType)
        The payload type describes the acceptable content that can be communicated on the endpoint.

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

        This element is required.

        Parameters:
        payloadType - The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
        Returns:
        A reference to this Builder instance

      • payloadType

        public Endpoint.Builder payloadType​(java.util.Collection<CodeableConcept> payloadType)
        The payload type describes the acceptable content that can be communicated on the endpoint.

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

        This element is required.

        Parameters:
        payloadType - The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • payloadMimeType

        public Endpoint.Builder payloadMimeType​(Code... payloadMimeType)
        The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType).

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

        Parameters:
        payloadMimeType - Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
        Returns:
        A reference to this Builder instance

      • payloadMimeType

        public Endpoint.Builder payloadMimeType​(java.util.Collection<Code> payloadMimeType)
        The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType).

        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:
        payloadMimeType - Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • address

        public Endpoint.Builder address​(Url address)
        The uri that describes the actual end-point to connect to.

        This element is required.

        Parameters:
        address - The technical base address for connecting to this endpoint
        Returns:
        A reference to this Builder instance

      • header

        public Endpoint.Builder header​(java.lang.String... header)
        Convenience method for setting header.

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

        Parameters:
        header - Usage depends on the channel type
        Returns:
        A reference to this Builder instance
        See Also:
        #header(com.ibm.fhir.model.type.String)

      • header

        public Endpoint.Builder header​(String... header)
        Additional headers / information to send as part of the notification.

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

        Parameters:
        header - Usage depends on the channel type
        Returns:
        A reference to this Builder instance

      • header

        public Endpoint.Builder header​(java.util.Collection<String> header)
        Additional headers / information to send as part of the notification.

        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:
        header - Usage depends on the channel type
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • build

        public Endpoint build()
        Build the Endpoint

        Required elements:

        • status
        • connectionType
        • payloadType
        • address
        Specified by:
        build in interface Builder<Resource>
        Specified by:
        build in class DomainResource.Builder
        Returns:
        An immutable object of type Endpoint
        Throws:
        java.lang.IllegalStateException - if the current state cannot be built into a valid Endpoint per the base specification

      • validate

        protected void validate​(Endpoint endpoint)