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
Modifier and TypeClassDescriptionstatic enum
static class
-
Field Summary
Modifier and TypeFieldDescriptionprotected UrlType
The uri that describes the actual end-point to connect to.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for connection-typeprotected Coding
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 subscription.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.TokenClientParam
Fluent Client search parameter constant for identifierstatic final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.protected Reference
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).protected Organization
The actual object that is the target of the reference (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).)protected StringType
A friendly name that this endpoint can be referred to with.static final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for namestatic final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for organizationstatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for payload-typeThe mime type to send the payload in - e.g.protected List
<CodeableConcept> The payload type describes the acceptable content that can be communicated on the endpoint.protected Period
The interval during which the endpoint is expected to be operational.static final String
Search parameter: connection-typestatic final String
Search parameter: identifierstatic final String
Search parameter: namestatic final String
Search parameter: organizationstatic final String
Search parameter: payload-typestatic final String
Search parameter: statusprotected Enumeration
<Endpoint.EndpointStatus> active | suspended | error | off | test.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for statusFields inherited from class org.hl7.fhir.r4.model.DomainResource
contained, extension, modifierExtension, text
Fields inherited from class org.hl7.fhir.r4.model.Resource
id, implicitRules, language, meta
Fields 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_TAG
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
ConstructorDescriptionEndpoint()
ConstructorEndpoint
(Enumeration<Endpoint.EndpointStatus> status, Coding connectionType, UrlType address) Constructor -
Method Summary
Modifier and TypeMethodDescriptionaddPayloadMimeType
(String value) copy()
void
copyValues
(Endpoint dst) boolean
equalsDeep
(Base other_) boolean
equalsShallow
(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) boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasName()
boolean
boolean
boolean
hasPayloadMimeType
(String value) boolean
boolean
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setAddress
(String value) setAddressElement
(UrlType value) setConnectionType
(Coding value) setContact
(List<ContactPoint> theContact) setHeader
(List<StringType> theHeader) setIdentifier
(List<Identifier> theIdentifier) setManagingOrganization
(Reference value) setNameElement
(StringType value) setPayloadMimeType
(List<CodeType> thePayloadMimeType) setPayloadType
(List<CodeableConcept> thePayloadType) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setStatus
(Endpoint.EndpointStatus value) protected Endpoint
Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
Methods inherited from class org.hl7.fhir.r4.model.Resource
copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
Methods inherited from class org.hl7.fhir.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment
Methods 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
active | suspended | error | off | test. -
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. -
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). -
managingOrganizationTarget
The actual object that is the target of the reference (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 subscription. The primary use of this for system administrator troubleshooting. -
period
The interval during which the endpoint is expected to be operational. -
payloadType
The payload type describes the acceptable content that can be communicated on the endpoint. -
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
The uri that describes the actual end-point to connect to. -
header
Additional headers / information to send as part of the notification. -
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.payloadType
- 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.payloadType
-
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_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_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_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_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
public Endpoint(Enumeration<Endpoint.EndpointStatus> status, Coding connectionType, UrlType address) 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
this
for easy method chaining
-
hasIdentifier
-
addIdentifier
-
addIdentifier
-
getIdentifierFirstRep
- Returns:
- The first repetition of repeating field
identifier
, creating it if it does not already exist
-
getStatusElement
- Returns:
status
(active | suspended | error | off | test.). 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
(active | suspended | error | off | test.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
- Returns:
- active | suspended | error | off | test.
-
setStatus
- Parameters:
value
- active | suspended | error | off | test.
-
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).)
-
hasConnectionType
-
setConnectionType
- Parameters:
value
-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).)
-
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.
-
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).)
-
getManagingOrganizationTarget
- Returns:
managingOrganization
The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (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).)
-
setManagingOrganizationTarget
- Parameters:
value
-managingOrganization
The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (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 subscription. The primary use of this for system administrator troubleshooting.)
-
setContact
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasContact
-
addContact
-
addContact
-
getContactFirstRep
- Returns:
- The first repetition of repeating field
contact
, creating it if it does not already exist
-
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.)
-
getPayloadType
- Returns:
payloadType
(The payload type describes the acceptable content that can be communicated on the endpoint.)
-
setPayloadType
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasPayloadType
-
addPayloadType
-
addPayloadType
-
getPayloadTypeFirstRep
- Returns:
- The first repetition of repeating field
payloadType
, creating it if it does not already exist
-
getPayloadMimeType
- Returns:
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).)
-
setPayloadMimeType
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasPayloadMimeType
-
addPayloadMimeTypeElement
- Returns:
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).)
-
addPayloadMimeType
- Parameters:
value
-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).)
-
hasPayloadMimeType
- Parameters:
value
-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).)
-
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
this
for 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:
listChildren
in classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
- Specified by:
copy
in classDomainResource
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
- Specified by:
getResourceType
in classResource
-