Skip to main content


class HS.FHIR.DTL.vR4.Model.Resource.Endpoint extends HS.FHIR.DTL.vR4.Model.Base.DomainResource

The technical details of an endpoint that can be used for electronic services.

Property Inventory


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.
parameter XMLTYPE = Endpoint;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type.

The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.


property address as %String (MAXLEN = 1000000, XMLNAME = "address", XMLPROJECTION = "ATTRIBUTE") [ Required ];

The technical base address for connecting to this endpoint.

TO DO: Unrecognized value type for the FHIR4 model

Property methods: addressDisplayToLogical(), addressGet(), addressIsValid(), addressLogicalToDisplay(), addressLogicalToOdbc(), addressNormalize(), addressSet()
property connectionType as HS.FHIR.DTL.vR4.Model.Datatype.Coding (XMLNAME = "connectionType", XMLPROJECTION = "ELEMENT") [ Required ];

Protocol/Profile/Standard to be used with this endpoint connection.

endpoint-connection-type is the REQUIRED FHIR4 ValueSet for codes, but if you need to express meanings not found in endpoint-connection-type, you may formally EXTEND endpoint-connection-type to add codes to it.

Property methods: connectionTypeGet(), connectionTypeGetSwizzled(), connectionTypeIsValid(), connectionTypeNewObject(), connectionTypeSet()
property contact as list of HS.FHIR.DTL.vR4.Model.Datatype.ContactPoint (XMLNAME = "contact", XMLPROJECTION = "ELEMENT");

Contact details for source (e.g. troubleshooting)

Property methods: contactBuildValueArray(), contactCollectionToDisplay(), contactCollectionToOdbc(), contactDisplayToCollection(), contactGet(), contactGetObject(), contactGetObjectId(), contactGetSwizzled(), contactIsValid(), contactOdbcToCollection(), contactSet(), contactSetObject(), contactSetObjectId()

Usage depends on the channel type.

Property methods: headerBuildValueArray(), headerCollectionToDisplay(), headerCollectionToOdbc(), headerDisplayToCollection(), headerDisplayToLogical(), headerGet(), headerGetObject(), headerGetObjectId(), headerGetSwizzled(), headerIsValid(), headerLogicalToDisplay(), headerLogicalToOdbc(), headerNormalize(), headerOdbcToCollection(), headerSet(), headerSetObject(), headerSetObjectId()
property identifier as list of HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");

Identifies this endpoint across multiple systems.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property managingOrganization as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "managingOrganization", XMLPROJECTION = "ELEMENT");

Organization that manages this endpoint (might not be the organization that exposes the endpoint)


Property methods: managingOrganizationGet(), managingOrganizationGetSwizzled(), managingOrganizationIsValid(), managingOrganizationNewObject(), managingOrganizationSet()
property name as %String (MAXLEN = 1000000, XMLNAME = "name", XMLPROJECTION = "ATTRIBUTE");

A name that this endpoint can be identified by.

Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
property payloadMimeType as list of %String (MAXLEN = 1000000, XMLNAME = "payloadMimeType", XMLPROJECTION = "ELEMENT");

Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)

mimetypes|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend mimetypes|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: payloadMimeTypeBuildValueArray(), payloadMimeTypeCollectionToDisplay(), payloadMimeTypeCollectionToOdbc(), payloadMimeTypeDisplayToCollection(), payloadMimeTypeDisplayToLogical(), payloadMimeTypeGet(), payloadMimeTypeGetObject(), payloadMimeTypeGetObjectId(), payloadMimeTypeGetSwizzled(), payloadMimeTypeIsValid(), payloadMimeTypeLogicalToDisplay(), payloadMimeTypeLogicalToOdbc(), payloadMimeTypeNormalize(), payloadMimeTypeOdbcToCollection(), payloadMimeTypeSet(), payloadMimeTypeSetObject(), payloadMimeTypeSetObjectId()
property payloadType as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "payloadType", XMLPROJECTION = "ELEMENT") [ Required ];

The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)

any FHIR4 code may be used; endpoint-payload-type shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: payloadTypeBuildValueArray(), payloadTypeCollectionToDisplay(), payloadTypeCollectionToOdbc(), payloadTypeDisplayToCollection(), payloadTypeGet(), payloadTypeGetObject(), payloadTypeGetObjectId(), payloadTypeGetSwizzled(), payloadTypeIsValid(), payloadTypeOdbcToCollection(), payloadTypeSet(), payloadTypeSetObject(), payloadTypeSetObjectId()
property period as HS.FHIR.DTL.vR4.Model.Datatype.Period (XMLNAME = "period", XMLPROJECTION = "ELEMENT");

Interval the endpoint is expected to be operational.

Property methods: periodGet(), periodGetSwizzled(), periodIsValid(), periodNewObject(), periodSet()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];

active | suspended | error | off | entered-in-error | test

endpoint-status|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend endpoint-status|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab