
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
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classstatic enumstatic classNested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base
Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected UrlTypeThe uri that describes the actual end-point to connect to.static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for connection-typeprotected List<CodeableConcept> A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way.protected List<ContactPoint> Contact details for a human to contact about the endpoint.protected StringTypeThe description of the endpoint and what it is for (typically used as supplemental information in an endpoint directory describing its usage/purpose).protected List<CodeableConcept> The type of environment(s) exposed at this endpoint (dev, prod, test, etc.).protected List<StringType> Additional headers / information to send as part of the notification.protected List<Identifier> Identifier for the organization that is used to identify the endpoint across multiple disparate systems.static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for identifierstatic final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.protected ReferenceThe organization that manages this endpoint (even if technically another organization is hosting this in the cloud, it is the organization associated with the data).protected StringTypeA friendly name that this endpoint can be referred to with.static final ca.uhn.fhir.rest.gclient.StringClientParamFluent Client search parameter constant for namestatic final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for organizationprotected List<Endpoint.EndpointPayloadComponent> The set of payloads that are provided/available at this endpoint.static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for payload-typeprotected PeriodThe interval during which the endpoint is expected to be operational.static final StringSearch parameter: connection-typestatic final StringSearch parameter: identifierstatic final StringSearch parameter: namestatic final StringSearch parameter: organizationstatic final StringSearch parameter: payload-typestatic final StringSearch parameter: statusprotected Enumeration<Endpoint.EndpointStatus> The endpoint status represents the general expected availability of an endpoint.static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for statusFields inherited from class org.hl7.fhir.r5.model.DomainResource
contained, extension, modifierExtension, SP_TEXT, text, TEXTFields inherited from class org.hl7.fhir.r5.model.Resource
id, implicitRules, language, metaFields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAGFields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET -
Constructor Summary
ConstructorsConstructorDescriptionEndpoint()ConstructorEndpoint(Endpoint.EndpointStatus status, CodeableConcept connectionType, String address) Constructor -
Method Summary
Modifier and TypeMethodDescriptioncopy()voidcopyValues(Endpoint dst) booleanequalsDeep(Base other_) booleanequalsShallow(Base other_) fhirType()getName()getNamedProperty(int _hash, String _name, boolean _checkValid) Base[]getProperty(int hash, String name, boolean checkValid) String[]getTypesForProperty(int hash, String name) booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanhasName()booleanbooleanbooleanbooleanbooleanbooleanisEmpty()protected voidlistChildren(List<Property> children) makeProperty(int hash, String name) voidremoveChild(String name, Base value) setAddress(String value) setAddressElement(UrlType value) setConnectionType(List<CodeableConcept> theConnectionType) setContact(List<ContactPoint> theContact) setDescription(String value) setDescriptionElement(StringType value) setEnvironmentType(List<CodeableConcept> theEnvironmentType) setHeader(List<StringType> theHeader) setIdentifier(List<Identifier> theIdentifier) setManagingOrganization(Reference value) setNameElement(StringType value) setPayload(List<Endpoint.EndpointPayloadComponent> thePayload) setProperty(int hash, String name, Base value) setProperty(String name, Base value) setStatus(Endpoint.EndpointStatus value) protected EndpointMethods inherited from class org.hl7.fhir.r5.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getExtensionString, getExtensionString, getModifierExtension, getModifierExtensionsByUrl, getStandardsStatus, getText, hasContained, hasExtension, hasExtension, hasExtension, hasModifierExtension, hasPrimitiveExtension, hasText, setContained, setExtension, setModifierExtension, setStandardsStatus, setTextMethods inherited from class org.hl7.fhir.r5.model.Resource
copyValues, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, getSourcePackage, getWebPath, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, hasSourcePackage, hasWebPath, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta, setSourcePackage, setWebPathMethods inherited from class org.hl7.fhir.r5.model.BaseResource
getStructureFhirVersionEnum, isResource, setIdMethods inherited from class org.hl7.fhir.r5.model.Base
addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, executeFunction, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, setUserData, setUserDataINN, setXhtmlMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserDataMethods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatCommentMethods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, isDeleted, setId
-
Field Details
-
identifier
Identifier for the organization that is used to identify the endpoint across multiple disparate systems. -
status
The endpoint status represents the general expected availability of an endpoint. -
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
A friendly name that this endpoint can be referred to with. -
description
The description of the endpoint and what it is for (typically used as supplemental information in an endpoint directory describing its usage/purpose). -
environmentType
The type of environment(s) exposed at this endpoint (dev, prod, test, etc.). -
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). -
contact
Contact details for a human to contact about the endpoint. The primary use of this for system administrator troubleshooting. -
period
The interval during which the endpoint is expected to be operational. -
payload
The set of payloads that are provided/available at this endpoint. -
address
The uri that describes the actual end-point to connect to. -
header
Additional headers / information to send as part of the notification. -
SP_CONNECTION_TYPE
Search parameter: connection-typeDescription: Protocol/Profile/Standard to be used with this endpoint connection
Type: token
Path: Endpoint.connectionType
- See Also:
-
CONNECTION_TYPE
Fluent Client search parameter constant for connection-typeDescription: Protocol/Profile/Standard to be used with this endpoint connection
Type: token
Path: Endpoint.connectionType
-
SP_IDENTIFIER
Search parameter: identifierDescription: Identifies this endpoint across multiple systems
Type: token
Path: Endpoint.identifier
- See Also:
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Identifies this endpoint across multiple systems
Type: token
Path: Endpoint.identifier
-
SP_NAME
Search parameter: nameDescription: A name that this endpoint can be identified by
Type: string
Path: Endpoint.name
- See Also:
-
NAME
Fluent Client search parameter constant for nameDescription: A name that this endpoint can be identified by
Type: string
Path: Endpoint.name
-
SP_ORGANIZATION
Search parameter: organizationDescription: The organization that is managing the endpoint
Type: reference
Path: Endpoint.managingOrganization
- See Also:
-
ORGANIZATION
Fluent Client search parameter constant for organizationDescription: The organization that is managing the endpoint
Type: reference
Path: Endpoint.managingOrganization
-
INCLUDE_ORGANIZATION
Constant for fluent queries to be used to add include statements. Specifies the path value of "Endpoint:organization". -
SP_PAYLOAD_TYPE
Search parameter: payload-typeDescription: The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Type: token
Path: Endpoint.payload.type
- See Also:
-
PAYLOAD_TYPE
Fluent Client search parameter constant for payload-typeDescription: The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Type: token
Path: Endpoint.payload.type
-
SP_STATUS
Search parameter: statusDescription: The current status of the Endpoint (usually expected to be active)
Type: token
Path: Endpoint.status
- See Also:
-
STATUS
Fluent Client search parameter constant for statusDescription: The current status of the Endpoint (usually expected to be active)
Type: token
Path: Endpoint.status
-
-
Constructor Details
-
Endpoint
public Endpoint()Constructor -
Endpoint
Constructor
-
-
Method Details
-
getIdentifier
- Returns:
identifier(Identifier for the organization that is used to identify the endpoint across multiple disparate systems.)
-
setIdentifier
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasIdentifier
-
addIdentifier
-
addIdentifier
-
getIdentifierFirstRep
- Returns:
- The first repetition of repeating field
identifier, creating it if it does not already exist {3}
-
getStatusElement
- Returns:
status(The endpoint status represents the general expected availability of an endpoint.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
hasStatusElement
-
hasStatus
-
setStatusElement
- Parameters:
value-status(The endpoint status represents the general expected availability of an endpoint.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
- Returns:
- The endpoint status represents the general expected availability of an endpoint.
-
setStatus
- Parameters:
value- The endpoint status represents the general expected availability of an endpoint.
-
getConnectionType
- Returns:
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).)
-
setConnectionType
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasConnectionType
-
addConnectionType
-
addConnectionType
-
getConnectionTypeFirstRep
- Returns:
- The first repetition of repeating field
connectionType, creating it if it does not already exist {3}
-
getNameElement
- Returns:
name(A friendly name that this endpoint can be referred to with.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
-
hasNameElement
-
hasName
-
setNameElement
- Parameters:
value-name(A friendly name that this endpoint can be referred to with.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
-
getName
- Returns:
- A friendly name that this endpoint can be referred to with.
-
setName
- Parameters:
value- A friendly name that this endpoint can be referred to with.
-
getDescriptionElement
- Returns:
description(The description of the endpoint and what it is for (typically used as supplemental information in an endpoint directory describing its usage/purpose).). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
hasDescriptionElement
-
hasDescription
-
setDescriptionElement
- Parameters:
value-description(The description of the endpoint and what it is for (typically used as supplemental information in an endpoint directory describing its usage/purpose).). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
getDescription
- Returns:
- The description of the endpoint and what it is for (typically used as supplemental information in an endpoint directory describing its usage/purpose).
-
setDescription
- Parameters:
value- The description of the endpoint and what it is for (typically used as supplemental information in an endpoint directory describing its usage/purpose).
-
getEnvironmentType
- Returns:
environmentType(The type of environment(s) exposed at this endpoint (dev, prod, test, etc.).)
-
setEnvironmentType
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasEnvironmentType
-
addEnvironmentType
-
addEnvironmentType
-
getEnvironmentTypeFirstRep
- Returns:
- The first repetition of repeating field
environmentType, creating it if it does not already exist {3}
-
getManagingOrganization
- Returns:
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).)
-
hasManagingOrganization
-
setManagingOrganization
- Parameters:
value-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).)
-
getContact
- Returns:
contact(Contact details for a human to contact about the endpoint. The primary use of this for system administrator troubleshooting.)
-
setContact
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasContact
-
addContact
-
addContact
-
getContactFirstRep
- Returns:
- The first repetition of repeating field
contact, creating it if it does not already exist {3}
-
getPeriod
- Returns:
period(The interval during which the endpoint is expected to be operational.)
-
hasPeriod
-
setPeriod
- Parameters:
value-period(The interval during which the endpoint is expected to be operational.)
-
getPayload
- Returns:
payload(The set of payloads that are provided/available at this endpoint.)
-
setPayload
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasPayload
-
addPayload
-
addPayload
-
getPayloadFirstRep
- Returns:
- The first repetition of repeating field
payload, creating it if it does not already exist {3}
-
getAddressElement
- Returns:
address(The uri that describes the actual end-point to connect to.). This is the underlying object with id, value and extensions. The accessor "getAddress" gives direct access to the value
-
hasAddressElement
-
hasAddress
-
setAddressElement
- Parameters:
value-address(The uri that describes the actual end-point to connect to.). This is the underlying object with id, value and extensions. The accessor "getAddress" gives direct access to the value
-
getAddress
- Returns:
- The uri that describes the actual end-point to connect to.
-
setAddress
- Parameters:
value- The uri that describes the actual end-point to connect to.
-
getHeader
- Returns:
header(Additional headers / information to send as part of the notification.)
-
setHeader
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasHeader
-
addHeaderElement
- Returns:
header(Additional headers / information to send as part of the notification.)
-
addHeader
- Parameters:
value-header(Additional headers / information to send as part of the notification.)
-
hasHeader
- Parameters:
value-header(Additional headers / information to send as part of the notification.)
-
listChildren
- Overrides:
listChildrenin classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makePropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource- Returns:
- the FHIR type name of the instance (not the java class name)
-
copy
- Specified by:
copyin classDomainResource
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
- Specified by:
getResourceTypein classResource
-