Data Model Libraries
    Preparing search index...

    Class Endpoint

    Endpoint Class

    The technical details of an endpoint that can be used for electronic services, such as for web services providing XDS.b, a REST endpoint for another FHIR server, or a s/Mime email address. This may include any security context information.

    FHIR Specification

    • Short: The technical details of an endpoint that can be used for electronic services
    • Definition: The technical details of an endpoint that can be used for electronic services, such as for web services providing XDS.b, a REST endpoint for another FHIR server, or a s/Mime email address. This may include any security context information.
    • FHIR Version: 5.0.0

    FHIR Endpoint

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? endpointStatusEnum status connectionType name? description? environmentType? managingOrganization? contact? period? payload? address header?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getConnectionType setConnectionType addConnectionType hasConnectionType getNameElement setNameElement hasNameElement getName setName hasName getDescriptionElement setDescriptionElement hasDescriptionElement getDescription setDescription hasDescription getEnvironmentType setEnvironmentType addEnvironmentType hasEnvironmentType getManagingOrganization setManagingOrganization hasManagingOrganization getContact setContact addContact hasContact getPeriod setPeriod hasPeriod getPayload setPayload addPayload hasPayload getAddressElement setAddressElement hasAddressElement getAddress setAddress hasAddress getHeaderElement setHeaderElement addHeaderElement hasHeaderElement getHeader setHeader addHeader hasHeader fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initConnectionType initEnvironmentType initContact initPayload initHeader

    Constructors

    Properties

    identifier?: Identifier[]

    Endpoint.identifier Element

    FHIR Specification

    • Short: Identifies this endpoint across multiple systems
    • Definition: Identifier for the organization that is used to identify the endpoint across multiple disparate systems.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    endpointStatusEnum: EndpointStatusEnum

    FHIR CodeSystem: EndpointStatus

    EndpointStatusEnum

    status: null | EnumCodeType

    Endpoint.status Element

    FHIR Specification

    • Short: active | suspended | error | off | entered-in-error | test
    • Definition: The endpoint status represents the general expected availability of an endpoint.
    • Comment: This element is labeled as a modifier because the status contains codes that mark the endpoint as not currently valid. Temporary downtimes or other unexpected short-term changes in availability would not be represented in this property.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    • isSummary: true

    CodeSystem Enumeration: EndpointStatusEnum

    connectionType: null | CodeableConcept[]

    Endpoint.connectionType Element

    FHIR Specification

    • Short: Protocol/Profile/Standard to be used with this endpoint connection
    • Definition: 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).
    • Comment: For additional connectivity details for the protocol, extensions will be used at this point, as in the XDS example. If there are multiple payload types or mimetypes they are all applicable for all connection types, and all have the same status.
    • FHIR Type: CodeableConcept
    • Cardinality: 1..*
    • isModifier: false
    • isSummary: true
    name?: StringType

    Endpoint.name Element

    FHIR Specification

    • Short: A name that this endpoint can be identified by
    • Definition: A friendly name that this endpoint can be referred to with.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    description?: StringType

    Endpoint.description Element

    FHIR Specification

    • Short: Additional details about the endpoint that could be displayed as further information to identify the description beyond its name
    • Definition: The description of the endpoint and what it is for (typically used as supplemental information in an endpoint directory describing its usage/purpose).
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    environmentType?: CodeableConcept[]

    Endpoint.environmentType Element

    FHIR Specification

    • Short: The type of environment(s) exposed at this endpoint
    • Definition: The type of environment(s) exposed at this endpoint (dev, prod, test, etc.).
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    managingOrganization?: Reference

    Endpoint.managingOrganization Element

    FHIR Specification

    • Short: Organization that manages this endpoint (might not be the organization that exposes the endpoint)
    • Definition: 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).
    • Comment: This property is not typically used when searching for Endpoint resources for usage. The typical usage is via the reference from an applicable Organization/Location/Practitioner resource, which is where the context is provided. Multiple Locations may reference a single endpoint, and don't have to be within the same organization resource, but most likely within the same organizational hierarchy.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    contact?: ContactPoint[]

    Endpoint.contact Element

    FHIR Specification

    • Short: Contact details for source (e.g. troubleshooting)
    • Definition: Contact details for a human to contact about the endpoint. The primary use of this for system administrator troubleshooting.
    • FHIR Type: ContactPoint
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    period?: Period

    Endpoint.period Element

    FHIR Specification

    • Short: Interval the endpoint is expected to be operational
    • Definition: The interval during which the endpoint is expected to be operational.
    • Comment: Temporary downtimes or other short-term changes in availability would not be represented in this property.
    • FHIR Type: Period
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    payload?: EndpointPayloadComponent[]

    Endpoint.payload Element

    FHIR Specification

    • Short: Set of payloads that are provided by this endpoint
    • Definition: The set of payloads that are provided/available at this endpoint.
    • Comment: Note that not all mimetypes or types will be listed under the one endpoint resource, there may be multiple instances that information for cases where other header data such as the endpoint address, active status/period etc. is different.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    address: null | UrlType

    Endpoint.address Element

    FHIR Specification

    • Short: The technical base address for connecting to this endpoint
    • Definition: The uri that describes the actual end-point to connect to.
    • Comment: For rest-hook, and websocket, the end-point must be an http: or https: URL; for email, a mailto: url, for sms, a tel: url, and for message the endpoint can be in any form of url the server understands (usually, http: or mllp:). The URI is allowed to be relative; in which case, it is relative to the server end-point (since there may be more than one, clients should avoid using relative URIs) This address will be to the service base, without any parameters, or sub-services or resources tacked on. E.g. for a WADO-RS endpoint, the url should be "https://pacs.hospital.org/wado-rs" and not "https://pacs.hospital.org/wado-rs/studies/1.2.250.1.59.40211.12345678.678910/series/1.2.250.1.59.40211.789001276.14556172.67789/instances/...".
    • FHIR Type: url
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    header?: StringType[]

    Endpoint.header Element

    FHIR Specification

    • Short: Usage depends on the channel type
    • Definition: Additional headers / information to send as part of the notification.
    • Comment: Exactly what these mean depends on the channel type. The can convey additional information to the recipient and/or meet security requirements.
    • FHIR Type: string
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

    • Parse the provided Endpoint JSON to instantiate the Endpoint data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR Endpoint

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to Endpoint

      Returns undefined | Endpoint

      Endpoint data model or undefined for Endpoint

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided ManagingOrganization object value to the managingOrganization property.

      Parameters

      • value: undefined | Reference

        the managingOrganization object value

      Returns this

      this

      @ReferenceTargets('Endpoint.managingOrganization', ['Organization',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetConnectionTypesetConnectionTypeaddConnectionTypehasConnectionTypegetNameElementsetNameElementhasNameElementgetNamesetNamehasNamegetDescriptionElementsetDescriptionElementhasDescriptionElementgetDescriptionsetDescriptionhasDescriptiongetEnvironmentTypesetEnvironmentTypeaddEnvironmentTypehasEnvironmentTypegetManagingOrganizationsetManagingOrganizationhasManagingOrganizationgetContactsetContactaddContacthasContactgetPeriodsetPeriodhasPeriodgetPayloadsetPayloadaddPayloadhasPayloadgetAddressElementsetAddressElementhasAddressElementgetAddresssetAddresshasAddressgetHeaderElementsetHeaderElementaddHeaderElementhasHeaderElementgetHeadersetHeaderaddHeaderhasHeaderfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitConnectionTypeinitEnvironmentTypeinitContactinitPayloadinitHeader