Package com.ibm.fhir.model.resource

Class Endpoint

  • All Implemented Interfaces:
    Visitable
    @Generated("com.ibm.fhir.tools.CodeGenerator")
public class Endpoint
extends DomainResource
    The technical details of an endpoint that can be used for electronic services, such as for web services providing XDS. b or a REST endpoint for another FHIR server. This may include any security context information.

    Maturity level: FMM2 (Trial Use)

    • Method Detail

      • getIdentifier

        public List<Identifier> getIdentifier()
        Identifier for the organization that is used to identify the endpoint across multiple disparate systems.
        Returns:
        An unmodifiable list containing immutable objects of type Identifier that may be empty.

      • getStatus

        public EndpointStatus getStatus()
        active | suspended | error | off | test.
        Returns:
        An immutable object of type EndpointStatus that is non-null.

      • getConnectionType

        public Coding getConnectionType()
        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).
        Returns:
        An immutable object of type Coding that is non-null.

      • getName

        public String getName()
        A friendly name that this endpoint can be referred to with.
        Returns:
        An immutable object of type String that may be null.

      • getManagingOrganization

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

      • getContact

        public List<ContactPoint> getContact()
        Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.
        Returns:
        An unmodifiable list containing immutable objects of type ContactPoint that may be empty.

      • getPeriod

        public Period getPeriod()
        The interval during which the endpoint is expected to be operational.
        Returns:
        An immutable object of type Period that may be null.

      • getPayloadType

        public List<CodeableConcept> getPayloadType()
        The payload type describes the acceptable content that can be communicated on the endpoint.
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept that is non-empty.

      • getPayloadMimeType

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

      • getAddress

        public Url getAddress()
        The uri that describes the actual end-point to connect to.
        Returns:
        An immutable object of type Url that is non-null.

      • getHeader

        public List<String> getHeader()
        Additional headers / information to send as part of the notification.
        Returns:
        An unmodifiable list containing immutable objects of type String that may be empty.

      • accept

        public void accept​(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

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object