Skip to main content

HS.FHIR.vSTU3.Model.Resource.Endpoint

deprecated class HS.FHIR.vSTU3.Model.Resource.Endpoint extends HS.FHIR.vSTU3.Model.Base.DomainResource

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
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.
If the element is present, it must have either a @value, an @id, or extensions

Property Inventory

Method Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute. NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.
parameter XMLNAME = Endpoint;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.

Properties

property address as HS.FHIR.vSTU3.Model.Datatype.Uri (XMLNAME = "address", XMLPROJECTION = "ELEMENT") [ Required ];
The uri that describes the actual end-point to connect to.
Property methods: addressGet(), addressGetSwizzled(), addressIsValid(), addressNewObject(), addressSet()
property connectionType as HS.FHIR.vSTU3.Model.Base.Coding (XMLNAME = "connectionType", XMLPROJECTION = "ELEMENT") [ Required ];
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).
Property methods: connectionTypeGet(), connectionTypeGetSwizzled(), connectionTypeIsValid(), connectionTypeNewObject(), connectionTypeSet()
property contact as list of HS.FHIR.vSTU3.Model.Base.ContactPoint (XMLNAME = "contact", XMLPROJECTION = "ELEMENT");
Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.
Property methods: contactBuildValueArray(), contactCollectionToDisplay(), contactCollectionToOdbc(), contactDisplayToCollection(), contactGet(), contactGetObject(), contactGetObjectId(), contactGetSwizzled(), contactIsValid(), contactOdbcToCollection(), contactSet(), contactSetObject(), contactSetObjectId()
Additional headers / information to send as part of the notification.
Property methods: headerBuildValueArray(), headerCollectionToDisplay(), headerCollectionToOdbc(), headerDisplayToCollection(), headerGet(), headerGetObject(), headerGetObjectId(), headerGetSwizzled(), headerIsValid(), headerOdbcToCollection(), headerSet(), headerSetObject(), headerSetObjectId()
property identifier as list of HS.FHIR.vSTU3.Model.Base.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifier for the organization that is used to identify the endpoint across multiple disparate systems.
Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property managingOrganization as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "managingOrganization", XMLPROJECTION = "ELEMENT");
The organization that manages this endpoint (even if technically another organisation is hosting this in the cloud, it is the organisation associated with the data).
Property methods: managingOrganizationGet(), managingOrganizationGetSwizzled(), managingOrganizationIsValid(), managingOrganizationNewObject(), managingOrganizationSet()
property name as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "name", XMLPROJECTION = "ELEMENT");
A friendly name that this endpoint can be referred to with.
Property methods: nameGet(), nameGetSwizzled(), nameIsValid(), nameNewObject(), nameSet()
property payloadMimeType as list of HS.FHIR.vSTU3.Model.Datatype.Code (XMLNAME = "payloadMimeType", XMLPROJECTION = "ELEMENT");
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).
Property methods: payloadMimeTypeBuildValueArray(), payloadMimeTypeCollectionToDisplay(), payloadMimeTypeCollectionToOdbc(), payloadMimeTypeDisplayToCollection(), payloadMimeTypeGet(), payloadMimeTypeGetObject(), payloadMimeTypeGetObjectId(), payloadMimeTypeGetSwizzled(), payloadMimeTypeIsValid(), payloadMimeTypeOdbcToCollection(), payloadMimeTypeSet(), payloadMimeTypeSetObject(), payloadMimeTypeSetObjectId()
property payloadType as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "payloadType", XMLPROJECTION = "ELEMENT");
The payload type describes the acceptable content that can be communicated on the endpoint.
Property methods: payloadTypeBuildValueArray(), payloadTypeCollectionToDisplay(), payloadTypeCollectionToOdbc(), payloadTypeDisplayToCollection(), payloadTypeGet(), payloadTypeGetObject(), payloadTypeGetObjectId(), payloadTypeGetSwizzled(), payloadTypeIsValid(), payloadTypeOdbcToCollection(), payloadTypeSet(), payloadTypeSetObject(), payloadTypeSetObjectId()
property period as HS.FHIR.vSTU3.Model.Base.Period (XMLNAME = "period", XMLPROJECTION = "ELEMENT");
The interval during which the endpoint is expected to be operational.
Property methods: periodGet(), periodGetSwizzled(), periodIsValid(), periodNewObject(), periodSet()
property status as HS.FHIR.vSTU3.Model.Base.EndpointStatus (XMLNAME = "status", XMLPROJECTION = "ELEMENT") [ Required ];
active | suspended | error | off | test.
Property methods: statusGet(), statusGetSwizzled(), statusIsValid(), statusNewObject(), statusSet()

Methods

deprecated method SetAddress(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "address" property.
deprecated method SetConnectionType(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "connectionType" property.
deprecated method SetContact(pValue As %String = "", pSystem As %String = "", pUse As %String = "", pRank As %String = "", pStart As %String = "", pEnd As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "contact" property.
deprecated method SetHeader(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "header" property.
deprecated method SetIdentifier(pValue As %String = "", pSystem As %String = "", pUse As %String = "", pTypeCode As %String = "", pTypeSystem As %String = "", pTypeDisplay As %String = "", pTypeText As %String = "", pId As %String = "", pStart As %String = "", pEnd As %String = "", pAssignerReference As %String = "", pAssignerDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "identifier" property.
deprecated method SetManagingOrganization(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "managingOrganization" property.
deprecated method SetName(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "name" property.
deprecated method SetPayloadMimeType(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "payloadMimeType" property.
deprecated method SetPayloadType(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "payloadType" property.
deprecated method SetPeriod(pStart As %String = "", pEnd As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "period" property.
deprecated method SetStatus(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "status" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab