Provider
Class ElectronicServiceEndpoint

Describes the location and the capabilties of an electronic system with which communications can be established for the purposes of exchanging clinical or administrative data. This class is an amalgam of data elements identified by the ONC S&I Initiatives and by FHIR.

"This class captures information on a unique electronic service. It is defined to support information interchange requirements that are focused on exchanging or querying for specific information on an electronic address." - ONC S&I Clinical Element Data Dictionary (CEDD), March 2012.
Electronic Service Information = "All information reasonably necessary to define an electronic destination’s ability to receive and consume a specific type of information (e.g. discharge summary, patient summary, laboratory report, query for patient/provider/healthcare data). The information should include the type of information (e.g. patient summary or query) the destination’s Electronic Address, the Messaging Framework supported (e.g. SMTP, HTTP/SOAP), Security information supported or required (e.g. digital certificate) and specific payload definitions (e.g. CCD C32 V2.5). In addition, this information may include labels which help identify the type of recipient (e.g. medical records department)." - ONC S&I Query for Electronic Service Information Including Electronic Address Use Case Initiative Glossary.

"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." - HL7 FHIR, Endpoint

Attributes
String address address

"The address of the Electronic Service" - ONC S&I Clinical Element Data Dictionary (CEDD), March 2012.
"The uri that describes the actual end-point to connect to." - HL7 FHIR, Endpoint.address

«CS» Code connectionType 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)." - HL7 FHIR, Endpoint.connectionType

«TEL» ContactPoint contact contact

"Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting." - HL7 FHIR, Endpoint.contact

String header header

"Additional headers / information to send as part of the notification." - HL7 FHIR, Endpoint.header

«II» Id identifier identifier

"An identifier assigned by the provider directory whose purpose is to uniquely identify a unique ESI for an individual, organization, individual-organization relationship." - ONC S&I Clinical Element Data Dictionary (CEDD), March 2012.
"Identifier for the organization that is used to identify the endpoint across multiple disparate systems." - HL7 FHIR, Endpoint.identifier

«CS» Code integrationProfile integrationProfile

"Identifies the integration profile which describes the transport and valid contents" - ONC S&I Clinical Element Data Dictionary (CEDD), March 2012.

«CS» Code integrationProfileOptions integrationProfileOptions

"Options defined for the specific Integration Profile" - ONC S&I Clinical Element Data Dictionary (CEDD), March 2012.

String integrationProfileVersion integrationProfileVersion

"The version(s) of the integration profile supported" - ONC S&I Clinical Element Data Dictionary (CEDD), March 2012.

Organization managingOrganization managingOrganization

"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)." - HL7 FHIR, Endpoint.managingOrganization

String name name

A moniker which identifies this endpoint, suitable for display to human users.
"A friendly name that this endpoint can be referred to with." - HL7 FHIR, Endpoint.name

«CS» Code payloadMimeType 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)." - HL7 FHIR, Endpoint.payloadMimeType

«CS» Code payloadType payloadType

"The payload type describes the acceptable content that can be communicated on the endpoint." - HL7 FHIR, Endpoint.payloadType

«IVL_TS» Period period period

"The interval during which the endpoint is expected to be operational." - HL7 FHIR, Endpoint.period

Integer preferredMethod preferredMethod

"Integer between 0 and 99 indicating the preferred order of the service, where 0 is the most preferred service and 99 is the least preferred" - ONC S&I Clinical Element Data Dictionary (CEDD), March 2012.

ProviderDirectoryContentProfile providerDirectoryContentProfile providerDirectoryContentProfile

Pointer to Content Profile(s) supported by the electronic health record destination. A content profile may be necessary to support those services which demand a content wrapper.

ProviderDirectorySecurityProfile providerDirectorySecurityProfile providerDirectorySecurityProfile

"Pointer to Security Profile(s) supported by the service.

«CS» Code status status

"active | suspended | error | off | test." - HL7 FHIR, Endpoint.status


Properties:

Alias
Classifier Behavior
Is Abstractfalse
Is Activefalse
Is Leaffalse
Keywords
NameElectronicServiceEndpoint
Name Expression
NamespaceProvider
Owned Template Signature
OwnerProvider
Owning Template Parameter
PackageProvider
Qualified NameFHIM::Provider::ElectronicServiceEndpoint
Representation
Stereotype
Template Parameter
VisibilityPublic

Attribute Details

 address
Public String address

"The address of the Electronic Service" - ONC S&I Clinical Element Data Dictionary (CEDD), March 2012.
"The uri that describes the actual end-point to connect to." - HL7 FHIR, Endpoint.address

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassElectronicServiceEndpoint
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
Nameaddress
Name Expression
NamespaceElectronicServiceEndpoint
Opposite
OwnerElectronicServiceEndpoint
Owning Association
Owning Template Parameter
Qualified NameFHIM::Provider::ElectronicServiceEndpoint::address
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 connectionType
Public «CS» Code 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)." - HL7 FHIR, Endpoint.connectionType

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassElectronicServiceEndpoint
Terminologies[
HL7_FHIR_R4 Endpoint Connection Type http://hl7.org/fhir/ValueSet/endpoint-connection-type
]
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
NameconnectionType
Name Expression
NamespaceElectronicServiceEndpoint
Opposite
OwnerElectronicServiceEndpoint
Owning Association
Owning Template Parameter
Qualified NameFHIM::Provider::ElectronicServiceEndpoint::connectionType
StereotypeValueSetConstraints
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 contact
Public «TEL» ContactPoint contact

"Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting." - HL7 FHIR, Endpoint.contact

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassElectronicServiceEndpoint
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
Namecontact
Name Expression
NamespaceElectronicServiceEndpoint
Opposite
OwnerElectronicServiceEndpoint
Owning Association
Owning Template Parameter
Qualified NameFHIM::Provider::ElectronicServiceEndpoint::contact
Stereotype
Template Parameter
Type«TEL» ContactPoint
Upper*
Upper Value(*)
VisibilityPublic


 header
Public String header

"Additional headers / information to send as part of the notification." - HL7 FHIR, Endpoint.header

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassElectronicServiceEndpoint
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
Nameheader
Name Expression
NamespaceElectronicServiceEndpoint
Opposite
OwnerElectronicServiceEndpoint
Owning Association
Owning Template Parameter
Qualified NameFHIM::Provider::ElectronicServiceEndpoint::header
Stereotype
Template Parameter
TypeString
Upper*
Upper Value(*)
VisibilityPublic


 identifier
Public «II» Id identifier

"An identifier assigned by the provider directory whose purpose is to uniquely identify a unique ESI for an individual, organization, individual-organization relationship." - ONC S&I Clinical Element Data Dictionary (CEDD), March 2012.
"Identifier for the organization that is used to identify the endpoint across multiple disparate systems." - HL7 FHIR, Endpoint.identifier

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassElectronicServiceEndpoint
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
Nameidentifier
Name Expression
NamespaceElectronicServiceEndpoint
Opposite
OwnerElectronicServiceEndpoint
Owning Association
Owning Template Parameter
Qualified NameFHIM::Provider::ElectronicServiceEndpoint::identifier
Stereotype
Template Parameter
Type«II» Id
Upper*
Upper Value(*)
VisibilityPublic


 integrationProfile
Public «CS» Code integrationProfile

"Identifies the integration profile which describes the transport and valid contents" - ONC S&I Clinical Element Data Dictionary (CEDD), March 2012.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassElectronicServiceEndpoint
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
NameintegrationProfile
Name Expression
NamespaceElectronicServiceEndpoint
Opposite
OwnerElectronicServiceEndpoint
Owning Association
Owning Template Parameter
Qualified NameFHIM::Provider::ElectronicServiceEndpoint::integrationProfile
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 integrationProfileOptions
Public «CS» Code integrationProfileOptions

"Options defined for the specific Integration Profile" - ONC S&I Clinical Element Data Dictionary (CEDD), March 2012.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassElectronicServiceEndpoint
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
NameintegrationProfileOptions
Name Expression
NamespaceElectronicServiceEndpoint
Opposite
OwnerElectronicServiceEndpoint
Owning Association
Owning Template Parameter
Qualified NameFHIM::Provider::ElectronicServiceEndpoint::integrationProfileOptions
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 integrationProfileVersion
Public String integrationProfileVersion

"The version(s) of the integration profile supported" - ONC S&I Clinical Element Data Dictionary (CEDD), March 2012.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassElectronicServiceEndpoint
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
NameintegrationProfileVersion
Name Expression
NamespaceElectronicServiceEndpoint
Opposite
OwnerElectronicServiceEndpoint
Owning Association
Owning Template Parameter
Qualified NameFHIM::Provider::ElectronicServiceEndpoint::integrationProfileVersion
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 managingOrganization
Public Organization managingOrganization

"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)." - HL7 FHIR, Endpoint.managingOrganization

Constraints:
Properties:

AggregationNone
Alias
Associationendpoint_managingOrganization
Association End
ClassElectronicServiceEndpoint
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamemanagingOrganization
Name Expression
NamespaceElectronicServiceEndpoint
Opposite
OwnerElectronicServiceEndpoint
Owning Association
Owning Template Parameter
Qualified NameFHIM::Provider::ElectronicServiceEndpoint::managingOrganization
Stereotype
Template Parameter
TypeOrganization
Upper1
Upper Value(1)
VisibilityPublic


 name
Public String name

A moniker which identifies this endpoint, suitable for display to human users.
"A friendly name that this endpoint can be referred to with." - HL7 FHIR, Endpoint.name

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassElectronicServiceEndpoint
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Namename
Name Expression
NamespaceElectronicServiceEndpoint
Opposite
OwnerElectronicServiceEndpoint
Owning Association
Owning Template Parameter
Qualified NameFHIM::Provider::ElectronicServiceEndpoint::name
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 payloadMimeType
Public «CS» Code 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)." - HL7 FHIR, Endpoint.payloadMimeType

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassElectronicServiceEndpoint
Terminologies[
HL7_FHIR_R4 MimeType http://hl7.org/fhir/ValueSet/mimetypes
]
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NamepayloadMimeType
Name Expression
NamespaceElectronicServiceEndpoint
Opposite
OwnerElectronicServiceEndpoint
Owning Association
Owning Template Parameter
Qualified NameFHIM::Provider::ElectronicServiceEndpoint::payloadMimeType
StereotypeValueSetConstraints
Template Parameter
Type«CS» Code
Upper*
Upper Value(*)
VisibilityPublic


 payloadType
Public «CS» Code payloadType

"The payload type describes the acceptable content that can be communicated on the endpoint." - HL7 FHIR, Endpoint.payloadType

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassElectronicServiceEndpoint
Terminologies[
HL7_FHIR_R4 Endpoint Payload Type http://hl7.org/fhir/ValueSet/endpoint-payload-type
]
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1..*
NamepayloadType
Name Expression
NamespaceElectronicServiceEndpoint
Opposite
OwnerElectronicServiceEndpoint
Owning Association
Owning Template Parameter
Qualified NameFHIM::Provider::ElectronicServiceEndpoint::payloadType
StereotypeValueSetConstraints
Template Parameter
Type«CS» Code
Upper*
Upper Value(*)
VisibilityPublic


 period
Public «IVL_TS» Period period

"The interval during which the endpoint is expected to be operational." - HL7 FHIR, Endpoint.period

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassElectronicServiceEndpoint
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Nameperiod
Name Expression
NamespaceElectronicServiceEndpoint
Opposite
OwnerElectronicServiceEndpoint
Owning Association
Owning Template Parameter
Qualified NameFHIM::Provider::ElectronicServiceEndpoint::period
Stereotype
Template Parameter
Type«IVL_TS» Period
Upper1
Upper Value(1)
VisibilityPublic


 preferredMethod
Public Integer preferredMethod

"Integer between 0 and 99 indicating the preferred order of the service, where 0 is the most preferred service and 99 is the least preferred" - ONC S&I Clinical Element Data Dictionary (CEDD), March 2012.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassElectronicServiceEndpoint
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
NamepreferredMethod
Name Expression
NamespaceElectronicServiceEndpoint
Opposite
OwnerElectronicServiceEndpoint
Owning Association
Owning Template Parameter
Qualified NameFHIM::Provider::ElectronicServiceEndpoint::preferredMethod
Stereotype
Template Parameter
TypeInteger
Upper1
Upper Value(1)
VisibilityPublic


 providerDirectoryContentProfile
Public ProviderDirectoryContentProfile providerDirectoryContentProfile

Pointer to Content Profile(s) supported by the electronic health record destination. A content profile may be necessary to support those services which demand a content wrapper.

Constraints:
Properties:

AggregationNone
Alias
AssociationelectronicServiceInformation_providerDirectoryContentProfile
Association End
ClassElectronicServiceEndpoint
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NameproviderDirectoryContentProfile
Name Expression
NamespaceElectronicServiceEndpoint
Opposite
OwnerElectronicServiceEndpoint
Owning Association
Owning Template Parameter
Qualified NameFHIM::Provider::ElectronicServiceEndpoint::providerDirectoryContentProfile
Stereotype
Template Parameter
TypeProviderDirectoryContentProfile
Upper*
Upper Value(*)
VisibilityPublic


 providerDirectorySecurityProfile
Public ProviderDirectorySecurityProfile providerDirectorySecurityProfile

"Pointer to Security Profile(s) supported by the service.

Constraints:
Properties:

AggregationNone
Alias
AssociationelectronicServiceInformation_providerDirectorySecurityProfile
Association End
ClassElectronicServiceEndpoint
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NameproviderDirectorySecurityProfile
Name Expression
NamespaceElectronicServiceEndpoint
Opposite
OwnerElectronicServiceEndpoint
Owning Association
Owning Template Parameter
Qualified NameFHIM::Provider::ElectronicServiceEndpoint::providerDirectorySecurityProfile
Stereotype
Template Parameter
TypeProviderDirectorySecurityProfile
Upper*
Upper Value(*)
VisibilityPublic


 status
Public «CS» Code status

"active | suspended | error | off | test." - HL7 FHIR, Endpoint.status

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassElectronicServiceEndpoint
Terminologies[
HL7_FHIR_R4 EndpointStatus http://hl7.org/fhir/ValueSet/endpoint-status
]
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
Namestatus
Name Expression
NamespaceElectronicServiceEndpoint
Opposite
OwnerElectronicServiceEndpoint
Owning Association
Owning Template Parameter
Qualified NameFHIM::Provider::ElectronicServiceEndpoint::status
StereotypeValueSetConstraints
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic