Class Endpoint

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

    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.
    See Also:
    Serialized Form
    • Field Detail

      • identifier

        protected List<Identifier> identifier
        Identifier for the organization that is used to identify the endpoint across multiple disparate systems.
      • connectionType

        protected 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).
      • name

        protected StringType name
        A friendly name that this endpoint can be referred to with.
      • managingOrganization

        protected Reference managingOrganization
        The organization that manages this endpoint (even if technically another organisation is hosting this in the cloud, it is the organisation associated with the data).
      • managingOrganizationTarget

        protected Organization managingOrganizationTarget
        The actual object that is the target of the reference (The organization that manages this endpoint (even if technically another organisation is hosting this in the cloud, it is the organisation associated with the data).)
      • contact

        protected List<ContactPoint> contact
        Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.
      • period

        protected Period period
        The interval during which the endpoint is expected to be operational.
      • payloadType

        protected List<CodeableConcept> payloadType
        The payload type describes the acceptable content that can be communicated on the endpoint.
      • payloadMimeType

        protected List<CodeType> 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).
      • address

        protected UriType address
        The uri that describes the actual end-point to connect to.
      • header

        protected List<StringType> header
        Additional headers / information to send as part of the notification.
      • SP_PAYLOAD_TYPE

        public static final String SP_PAYLOAD_TYPE
        Search parameter: payload-type

        Description: The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
        Type: token
        Path: Endpoint.payloadType

        See Also:
        Constant Field Values
      • PAYLOAD_TYPE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam PAYLOAD_TYPE
        Fluent Client search parameter constant for payload-type

        Description: The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
        Type: token
        Path: Endpoint.payloadType

      • SP_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter: identifier

        Description: Identifies this endpoint across multiple systems
        Type: token
        Path: Endpoint.identifier

        See Also:
        Constant Field Values
      • IDENTIFIER

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
        Fluent Client search parameter constant for identifier

        Description: Identifies this endpoint across multiple systems
        Type: token
        Path: Endpoint.identifier

      • SP_ORGANIZATION

        public static final String SP_ORGANIZATION
        Search parameter: organization

        Description: The organization that is managing the endpoint
        Type: reference
        Path: Endpoint.managingOrganization

        See Also:
        Constant Field Values
      • ORGANIZATION

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ORGANIZATION
        Fluent Client search parameter constant for organization

        Description: The organization that is managing the endpoint
        Type: reference
        Path: Endpoint.managingOrganization

      • INCLUDE_ORGANIZATION

        public static final ca.uhn.fhir.model.api.Include INCLUDE_ORGANIZATION
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Endpoint:organization".
      • SP_CONNECTION_TYPE

        public static final String SP_CONNECTION_TYPE
        Search parameter: connection-type

        Description: Protocol/Profile/Standard to be used with this endpoint connection
        Type: token
        Path: Endpoint.connectionType

        See Also:
        Constant Field Values
      • CONNECTION_TYPE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONNECTION_TYPE
        Fluent Client search parameter constant for connection-type

        Description: Protocol/Profile/Standard to be used with this endpoint connection
        Type: token
        Path: Endpoint.connectionType

      • SP_NAME

        public static final String SP_NAME
        Search parameter: name

        Description: A name that this endpoint can be identified by
        Type: string
        Path: Endpoint.name

        See Also:
        Constant Field Values
      • NAME

        public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME
        Fluent Client search parameter constant for name

        Description: A name that this endpoint can be identified by
        Type: string
        Path: Endpoint.name

      • SP_STATUS

        public static final String SP_STATUS
        Search parameter: status

        Description: The current status of the Endpoint (usually expected to be active)
        Type: token
        Path: Endpoint.status

        See Also:
        Constant Field Values
      • STATUS

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
        Fluent Client search parameter constant for status

        Description: The current status of the Endpoint (usually expected to be active)
        Type: token
        Path: Endpoint.status