Class Endpoint
- java.lang.Object
-
- org.hl7.fhir.r4.model.Base
-
- org.hl7.fhir.r4.model.BaseResource
-
- org.hl7.fhir.r4.model.Resource
-
- org.hl7.fhir.r4.model.DomainResource
-
- org.hl7.fhir.r4.model.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
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classEndpoint.EndpointStatusstatic classEndpoint.EndpointStatusEnumFactory
-
Field Summary
Fields Modifier and Type Field Description protected UrlTypeaddressThe uri that describes the actual end-point to connect to.static ca.uhn.fhir.rest.gclient.TokenClientParamCONNECTION_TYPEFluent Client search parameter constant for connection-typeprotected CodingconnectionTypeA 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>contactContact details for a human to contact about the subscription.protected List<StringType>headerAdditional headers / information to send as part of the notification.protected List<Identifier>identifierIdentifier for the organization that is used to identify the endpoint across multiple disparate systems.static ca.uhn.fhir.rest.gclient.TokenClientParamIDENTIFIERFluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.IncludeINCLUDE_ORGANIZATIONConstant for fluent queries to be used to add include statements.protected ReferencemanagingOrganizationThe 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 OrganizationmanagingOrganizationTargetThe 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 StringTypenameA friendly name that this endpoint can be referred to with.static ca.uhn.fhir.rest.gclient.StringClientParamNAMEFluent Client search parameter constant for namestatic ca.uhn.fhir.rest.gclient.ReferenceClientParamORGANIZATIONFluent Client search parameter constant for organizationstatic ca.uhn.fhir.rest.gclient.TokenClientParamPAYLOAD_TYPEFluent Client search parameter constant for payload-typeprotected List<CodeType>payloadMimeTypeThe mime type to send the payload in - e.g.protected List<CodeableConcept>payloadTypeThe payload type describes the acceptable content that can be communicated on the endpoint.protected PeriodperiodThe interval during which the endpoint is expected to be operational.static StringSP_CONNECTION_TYPESearch parameter: connection-typestatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_NAMESearch parameter: namestatic StringSP_ORGANIZATIONSearch parameter: organizationstatic StringSP_PAYLOAD_TYPESearch parameter: payload-typestatic StringSP_STATUSSearch parameter: statusprotected Enumeration<Endpoint.EndpointStatus>statusactive | suspended | error | off | test.static ca.uhn.fhir.rest.gclient.TokenClientParamSTATUSFluent Client search parameter constant for status-
Fields 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
-
-
Constructor Summary
Constructors Constructor Description Endpoint()ConstructorEndpoint(Enumeration<Endpoint.EndpointStatus> status, Coding connectionType, UrlType address)Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, 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, 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, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, 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
-
-
-
-
Field Detail
-
identifier
protected List<Identifier> identifier
Identifier for the organization that is used to identify the endpoint across multiple disparate systems.
-
status
protected Enumeration<Endpoint.EndpointStatus> status
active | suspended | error | off | test.
-
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 organization is hosting this in the cloud, it is the organization 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 organization is hosting this in the cloud, it is the organization 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).
-
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-typeDescription: 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-typeDescription: 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: identifierDescription: 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 identifierDescription: Identifies this endpoint across multiple systems
Type: token
Path: Endpoint.identifier
-
SP_ORGANIZATION
public static final String SP_ORGANIZATION
Search parameter: organizationDescription: 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 organizationDescription: 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-typeDescription: 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-typeDescription: 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: nameDescription: 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 nameDescription: A name that this endpoint can be identified by
Type: string
Path: Endpoint.name
-
SP_STATUS
public static final String SP_STATUS
Search parameter: statusDescription: 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 statusDescription: The current status of the Endpoint (usually expected to be active)
Type: token
Path: Endpoint.status
-
-
Constructor Detail
-
Endpoint
public Endpoint()
Constructor
-
Endpoint
public Endpoint(Enumeration<Endpoint.EndpointStatus> status, Coding connectionType, UrlType address)
Constructor
-
-
Method Detail
-
getIdentifier
public List<Identifier> getIdentifier()
- Returns:
identifier(Identifier for the organization that is used to identify the endpoint across multiple disparate systems.)
-
setIdentifier
public Endpoint setIdentifier(List<Identifier> theIdentifier)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasIdentifier
public boolean hasIdentifier()
-
addIdentifier
public Identifier addIdentifier()
-
addIdentifier
public Endpoint addIdentifier(Identifier t)
-
getIdentifierFirstRep
public Identifier getIdentifierFirstRep()
- Returns:
- The first repetition of repeating field
identifier, creating it if it does not already exist
-
getStatusElement
public Enumeration<Endpoint.EndpointStatus> 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
public boolean hasStatusElement()
-
hasStatus
public boolean hasStatus()
-
setStatusElement
public Endpoint setStatusElement(Enumeration<Endpoint.EndpointStatus> value)
- 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
public Endpoint.EndpointStatus getStatus()
- Returns:
- active | suspended | error | off | test.
-
setStatus
public Endpoint setStatus(Endpoint.EndpointStatus value)
- Parameters:
value- active | suspended | error | off | test.
-
getConnectionType
public Coding 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
public boolean hasConnectionType()
-
setConnectionType
public Endpoint setConnectionType(Coding value)
- 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
public StringType 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
public boolean hasNameElement()
-
hasName
public boolean hasName()
-
setNameElement
public Endpoint setNameElement(StringType value)
- 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
public String getName()
- Returns:
- A friendly name that this endpoint can be referred to with.
-
setName
public Endpoint setName(String value)
- Parameters:
value- A friendly name that this endpoint can be referred to with.
-
getManagingOrganization
public Reference 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
public boolean hasManagingOrganization()
-
setManagingOrganization
public Endpoint setManagingOrganization(Reference value)
- 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
public Organization getManagingOrganizationTarget()
- Returns:
managingOrganizationThe 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
public Endpoint setManagingOrganizationTarget(Organization value)
- Parameters:
value-managingOrganizationThe 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
public List<ContactPoint> getContact()
- Returns:
contact(Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.)
-
setContact
public Endpoint setContact(List<ContactPoint> theContact)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasContact
public boolean hasContact()
-
addContact
public ContactPoint addContact()
-
addContact
public Endpoint addContact(ContactPoint t)
-
getContactFirstRep
public ContactPoint getContactFirstRep()
- Returns:
- The first repetition of repeating field
contact, creating it if it does not already exist
-
getPeriod
public Period getPeriod()
- Returns:
period(The interval during which the endpoint is expected to be operational.)
-
hasPeriod
public boolean hasPeriod()
-
setPeriod
public Endpoint setPeriod(Period value)
- Parameters:
value-period(The interval during which the endpoint is expected to be operational.)
-
getPayloadType
public List<CodeableConcept> getPayloadType()
- Returns:
payloadType(The payload type describes the acceptable content that can be communicated on the endpoint.)
-
setPayloadType
public Endpoint setPayloadType(List<CodeableConcept> thePayloadType)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasPayloadType
public boolean hasPayloadType()
-
addPayloadType
public CodeableConcept addPayloadType()
-
addPayloadType
public Endpoint addPayloadType(CodeableConcept t)
-
getPayloadTypeFirstRep
public CodeableConcept getPayloadTypeFirstRep()
- Returns:
- The first repetition of repeating field
payloadType, creating it if it does not already exist
-
getPayloadMimeType
public List<CodeType> 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
public Endpoint setPayloadMimeType(List<CodeType> thePayloadMimeType)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasPayloadMimeType
public boolean hasPayloadMimeType()
-
addPayloadMimeTypeElement
public CodeType 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
public Endpoint addPayloadMimeType(String value)
- 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
public boolean hasPayloadMimeType(String value)
- 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
public UrlType 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
public boolean hasAddressElement()
-
hasAddress
public boolean hasAddress()
-
setAddressElement
public Endpoint setAddressElement(UrlType value)
- 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
public String getAddress()
- Returns:
- The uri that describes the actual end-point to connect to.
-
setAddress
public Endpoint setAddress(String value)
- Parameters:
value- The uri that describes the actual end-point to connect to.
-
getHeader
public List<StringType> getHeader()
- Returns:
header(Additional headers / information to send as part of the notification.)
-
setHeader
public Endpoint setHeader(List<StringType> theHeader)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasHeader
public boolean hasHeader()
-
addHeaderElement
public StringType addHeaderElement()
- Returns:
header(Additional headers / information to send as part of the notification.)
-
addHeader
public Endpoint addHeader(String value)
- Parameters:
value-header(Additional headers / information to send as part of the notification.)
-
hasHeader
public boolean hasHeader(String value)
- Parameters:
value-header(Additional headers / information to send as part of the notification.)
-
listChildren
protected void listChildren(List<Property> children)
- 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
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- 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
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
public Endpoint copy()
- Specified by:
copyin classDomainResource
-
copyValues
public void copyValues(Endpoint dst)
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-