public class Endpoint extends DomainResource
| Modifier and Type | Class and Description |
|---|---|
static class |
Endpoint.EndpointStatus |
static class |
Endpoint.EndpointStatusEnumFactory |
| Modifier and Type | Field and Description |
|---|---|
protected UrlType |
address
The uri that describes the actual end-point to connect to.
|
static ca.uhn.fhir.rest.gclient.TokenClientParam |
CONNECTION_TYPE
Fluent Client search parameter constant for connection-type
|
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.
|
protected List<ContactPoint> |
contact
Contact details for a human to contact about the subscription.
|
protected List<StringType> |
header
Additional headers / information to send as part of the notification.
|
protected List<Identifier> |
identifier
Identifier for the organization that is used to identify the endpoint across multiple disparate systems.
|
static ca.uhn.fhir.rest.gclient.TokenClientParam |
IDENTIFIER
Fluent Client search parameter constant for identifier
|
static ca.uhn.fhir.model.api.Include |
INCLUDE_ORGANIZATION
Constant for fluent queries to be used to add include statements.
|
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).
|
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).)
|
protected StringType |
name
A friendly name that this endpoint can be referred to with.
|
static ca.uhn.fhir.rest.gclient.StringClientParam |
NAME
Fluent Client search parameter constant for name
|
static ca.uhn.fhir.rest.gclient.ReferenceClientParam |
ORGANIZATION
Fluent Client search parameter constant for organization
|
static ca.uhn.fhir.rest.gclient.TokenClientParam |
PAYLOAD_TYPE
Fluent Client search parameter constant for payload-type
|
protected List<CodeType> |
payloadMimeType
The mime type to send the payload in - e.g.
|
protected List<CodeableConcept> |
payloadType
The payload type describes the acceptable content that can be communicated on the endpoint.
|
protected Period |
period
The interval during which the endpoint is expected to be operational.
|
static String |
SP_CONNECTION_TYPE
Search parameter: connection-type
|
static String |
SP_IDENTIFIER
Search parameter: identifier
|
static String |
SP_NAME
Search parameter: name
|
static String |
SP_ORGANIZATION
Search parameter: organization
|
static String |
SP_PAYLOAD_TYPE
Search parameter: payload-type
|
static String |
SP_STATUS
Search parameter: status
|
protected Enumeration<Endpoint.EndpointStatus> |
status
active | suspended | error | off | test.
|
static ca.uhn.fhir.rest.gclient.TokenClientParam |
STATUS
Fluent Client search parameter constant for status
|
contained, extension, modifierExtension, textid, implicitRules, language, meta| Constructor and Description |
|---|
Endpoint()
Constructor
|
Endpoint(Enumeration<Endpoint.EndpointStatus> status,
Coding connectionType,
UrlType address)
Constructor
|
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setTextcopyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMetagetStructureFhirVersionEnum, isResource, setIdcastToAddress, 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, setUserDataINNclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetId, getIdElement, getLanguageElement, getUserData, setId, setUserDataprotected List<Identifier> identifier
protected Enumeration<Endpoint.EndpointStatus> status
protected Coding connectionType
protected StringType name
protected Reference managingOrganization
protected Organization managingOrganizationTarget
protected List<ContactPoint> contact
protected Period period
protected List<CodeableConcept> payloadType
protected List<CodeType> payloadMimeType
protected List<StringType> header
public static final String SP_PAYLOAD_TYPE
Description: The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Type: token
Path: Endpoint.payloadType
public static final ca.uhn.fhir.rest.gclient.TokenClientParam PAYLOAD_TYPE
Description: The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Type: token
Path: Endpoint.payloadType
public static final String SP_IDENTIFIER
Description: Identifies this endpoint across multiple systems
Type: token
Path: Endpoint.identifier
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
Description: Identifies this endpoint across multiple systems
Type: token
Path: Endpoint.identifier
public static final String SP_ORGANIZATION
Description: The organization that is managing the endpoint
Type: reference
Path: Endpoint.managingOrganization
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ORGANIZATION
Description: The organization that is managing the endpoint
Type: reference
Path: Endpoint.managingOrganization
public static final ca.uhn.fhir.model.api.Include INCLUDE_ORGANIZATION
public static final String SP_CONNECTION_TYPE
Description: Protocol/Profile/Standard to be used with this endpoint connection
Type: token
Path: Endpoint.connectionType
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONNECTION_TYPE
Description: Protocol/Profile/Standard to be used with this endpoint connection
Type: token
Path: Endpoint.connectionType
public static final String SP_NAME
Description: A name that this endpoint can be identified by
Type: string
Path: Endpoint.name
public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME
Description: A name that this endpoint can be identified by
Type: string
Path: Endpoint.name
public static final String SP_STATUS
Description: The current status of the Endpoint (usually expected to be active)
Type: token
Path: Endpoint.status
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
Description: The current status of the Endpoint (usually expected to be active)
Type: token
Path: Endpoint.status
public Endpoint()
public Endpoint(Enumeration<Endpoint.EndpointStatus> status, Coding connectionType, UrlType address)
public List<Identifier> getIdentifier()
identifier (Identifier for the organization that is used to identify the endpoint across multiple disparate systems.)public Endpoint setIdentifier(List<Identifier> theIdentifier)
this for easy method chainingpublic boolean hasIdentifier()
public Identifier addIdentifier()
public Endpoint addIdentifier(Identifier t)
public Identifier getIdentifierFirstRep()
identifier, creating it if it does not already existpublic Enumeration<Endpoint.EndpointStatus> getStatusElement()
status (active | suspended | error | off | test.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the valuepublic boolean hasStatusElement()
public boolean hasStatus()
public Endpoint setStatusElement(Enumeration<Endpoint.EndpointStatus> value)
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 valuepublic Endpoint.EndpointStatus getStatus()
public Endpoint setStatus(Endpoint.EndpointStatus value)
value - active | suspended | error | off | test.public Coding getConnectionType()
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).)public boolean hasConnectionType()
public Endpoint setConnectionType(Coding value)
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).)public StringType getNameElement()
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 valuepublic boolean hasNameElement()
public boolean hasName()
public Endpoint setNameElement(StringType value)
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 valuepublic String getName()
public Endpoint setName(String value)
value - A friendly name that this endpoint can be referred to with.public Reference getManagingOrganization()
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).)public boolean hasManagingOrganization()
public Endpoint setManagingOrganization(Reference value)
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).)public Organization getManagingOrganizationTarget()
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).)public Endpoint setManagingOrganizationTarget(Organization value)
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).)public List<ContactPoint> getContact()
contact (Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.)public Endpoint setContact(List<ContactPoint> theContact)
this for easy method chainingpublic boolean hasContact()
public ContactPoint addContact()
public Endpoint addContact(ContactPoint t)
public ContactPoint getContactFirstRep()
contact, creating it if it does not already existpublic Period getPeriod()
period (The interval during which the endpoint is expected to be operational.)public boolean hasPeriod()
public Endpoint setPeriod(Period value)
value - period (The interval during which the endpoint is expected to be operational.)public List<CodeableConcept> getPayloadType()
payloadType (The payload type describes the acceptable content that can be communicated on the endpoint.)public Endpoint setPayloadType(List<CodeableConcept> thePayloadType)
this for easy method chainingpublic boolean hasPayloadType()
public CodeableConcept addPayloadType()
public Endpoint addPayloadType(CodeableConcept t)
public CodeableConcept getPayloadTypeFirstRep()
payloadType, creating it if it does not already existpublic List<CodeType> getPayloadMimeType()
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).)public Endpoint setPayloadMimeType(List<CodeType> thePayloadMimeType)
this for easy method chainingpublic boolean hasPayloadMimeType()
public CodeType addPayloadMimeTypeElement()
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).)public Endpoint addPayloadMimeType(String value)
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).)public boolean hasPayloadMimeType(String value)
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).)public UrlType getAddressElement()
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 valuepublic boolean hasAddressElement()
public boolean hasAddress()
public Endpoint setAddressElement(UrlType value)
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 valuepublic String getAddress()
public Endpoint setAddress(String value)
value - The uri that describes the actual end-point to connect to.public List<StringType> getHeader()
header (Additional headers / information to send as part of the notification.)public Endpoint setHeader(List<StringType> theHeader)
this for easy method chainingpublic boolean hasHeader()
public StringType addHeaderElement()
header (Additional headers / information to send as part of the notification.)public Endpoint addHeader(String value)
value - header (Additional headers / information to send as part of the notification.)public boolean hasHeader(String value)
value - header (Additional headers / information to send as part of the notification.)protected void listChildren(List<Property> children)
listChildren in class DomainResourcepublic Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
getNamedProperty in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
getProperty in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
setProperty in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
setProperty in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
makeProperty in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
getTypesForProperty in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
addChild in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic String fhirType()
fhirType in interface org.hl7.fhir.instance.model.api.IBasefhirType in class DomainResourcepublic Endpoint copy()
copy in class DomainResourcepublic void copyValues(Endpoint dst)
public boolean equalsDeep(Base other_)
equalsDeep in class DomainResourcepublic boolean equalsShallow(Base other_)
equalsShallow in class DomainResourcepublic boolean isEmpty()
isEmpty in interface org.hl7.fhir.instance.model.api.IBaseisEmpty in class DomainResourcepublic ResourceType getResourceType()
getResourceType in class ResourceCopyright © 2014–2021 Health Level 7. All rights reserved.