| Provider UML Documentation |
Summary:AttributesProperties | Detail:Attributes |
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 |
"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 |
"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 details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting." - HL7 FHIR, Endpoint.contact |
String | header |
"Additional headers / information to send as part of the notification." - HL7 FHIR, Endpoint.header |
«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 |
«CS» Code | 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 |
"Options defined for the specific Integration Profile" - ONC S&I Clinical Element Data Dictionary (CEDD), March 2012. |
String | integrationProfileVersion |
"The version(s) of the integration profile supported" - ONC S&I Clinical Element Data Dictionary (CEDD), March 2012. |
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 |
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 |
«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 |
«CS» Code | payloadType |
"The payload type describes the acceptable content that can be communicated on the endpoint." - HL7 FHIR, Endpoint.payloadType |
«IVL_TS» Period | period |
"The interval during which the endpoint is expected to be operational." - HL7 FHIR, Endpoint.period |
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. |
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 | |
«CS» Code | status |
"active | suspended | error | off | test." - HL7 FHIR, Endpoint.status |
Properties:
Alias | |
Classifier Behavior | |
Is Abstract | false |
Is Active | false |
Is Leaf | false |
Keywords | |
Name | ElectronicServiceEndpoint |
Name Expression | |
Namespace | Provider |
Owned Template Signature | |
Owner | Provider |
Owning Template Parameter | |
Package | Provider |
Qualified Name | FHIM::Provider::ElectronicServiceEndpoint |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
Attribute Details |
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
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ElectronicServiceEndpoint |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | address |
Name Expression | |
Namespace | ElectronicServiceEndpoint |
Opposite | |
Owner | ElectronicServiceEndpoint |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Provider::ElectronicServiceEndpoint::address |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ElectronicServiceEndpoint |
Terminologies | [ HL7_FHIR_R4 Endpoint Connection Type http://hl7.org/fhir/ValueSet/endpoint-connection-type ] |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | connectionType |
Name Expression | |
Namespace | ElectronicServiceEndpoint |
Opposite | |
Owner | ElectronicServiceEndpoint |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Provider::ElectronicServiceEndpoint::connectionType |
Stereotype | ValueSetConstraints |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ElectronicServiceEndpoint |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | contact |
Name Expression | |
Namespace | ElectronicServiceEndpoint |
Opposite | |
Owner | ElectronicServiceEndpoint |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Provider::ElectronicServiceEndpoint::contact |
Stereotype | |
Template Parameter | |
Type | «TEL» ContactPoint |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public String header
"Additional headers / information to send as part of the notification." - HL7 FHIR, Endpoint.header
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ElectronicServiceEndpoint |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | header |
Name Expression | |
Namespace | ElectronicServiceEndpoint |
Opposite | |
Owner | ElectronicServiceEndpoint |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Provider::ElectronicServiceEndpoint::header |
Stereotype | |
Template Parameter | |
Type | String |
Upper | * |
Upper Value | (*) |
Visibility | Public |
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
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ElectronicServiceEndpoint |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | identifier |
Name Expression | |
Namespace | ElectronicServiceEndpoint |
Opposite | |
Owner | ElectronicServiceEndpoint |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Provider::ElectronicServiceEndpoint::identifier |
Stereotype | |
Template Parameter | |
Type | «II» Id |
Upper | * |
Upper Value | (*) |
Visibility | Public |
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.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ElectronicServiceEndpoint |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | integrationProfile |
Name Expression | |
Namespace | ElectronicServiceEndpoint |
Opposite | |
Owner | ElectronicServiceEndpoint |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Provider::ElectronicServiceEndpoint::integrationProfile |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code integrationProfileOptions
"Options defined for the specific Integration Profile" - ONC S&I Clinical Element Data Dictionary (CEDD), March 2012.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ElectronicServiceEndpoint |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | integrationProfileOptions |
Name Expression | |
Namespace | ElectronicServiceEndpoint |
Opposite | |
Owner | ElectronicServiceEndpoint |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Provider::ElectronicServiceEndpoint::integrationProfileOptions |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public String integrationProfileVersion
"The version(s) of the integration profile supported" - ONC S&I Clinical Element Data Dictionary (CEDD), March 2012.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ElectronicServiceEndpoint |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | integrationProfileVersion |
Name Expression | |
Namespace | ElectronicServiceEndpoint |
Opposite | |
Owner | ElectronicServiceEndpoint |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Provider::ElectronicServiceEndpoint::integrationProfileVersion |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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
Aggregation | None |
Alias | |
Association | endpoint_managingOrganization |
Association End | |
Class | ElectronicServiceEndpoint |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | managingOrganization |
Name Expression | |
Namespace | ElectronicServiceEndpoint |
Opposite | |
Owner | ElectronicServiceEndpoint |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Provider::ElectronicServiceEndpoint::managingOrganization |
Stereotype | |
Template Parameter | |
Type | Organization |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ElectronicServiceEndpoint |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | name |
Name Expression | |
Namespace | ElectronicServiceEndpoint |
Opposite | |
Owner | ElectronicServiceEndpoint |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Provider::ElectronicServiceEndpoint::name |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ElectronicServiceEndpoint |
Terminologies | [ HL7_FHIR_R4 MimeType http://hl7.org/fhir/ValueSet/mimetypes ] |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | payloadMimeType |
Name Expression | |
Namespace | ElectronicServiceEndpoint |
Opposite | |
Owner | ElectronicServiceEndpoint |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Provider::ElectronicServiceEndpoint::payloadMimeType |
Stereotype | ValueSetConstraints |
Template Parameter | |
Type | «CS» Code |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «CS» Code payloadType
"The payload type describes the acceptable content that can be communicated on the endpoint." - HL7 FHIR, Endpoint.payloadType
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ElectronicServiceEndpoint |
Terminologies | [ HL7_FHIR_R4 Endpoint Payload Type http://hl7.org/fhir/ValueSet/endpoint-payload-type ] |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1..* |
Name | payloadType |
Name Expression | |
Namespace | ElectronicServiceEndpoint |
Opposite | |
Owner | ElectronicServiceEndpoint |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Provider::ElectronicServiceEndpoint::payloadType |
Stereotype | ValueSetConstraints |
Template Parameter | |
Type | «CS» Code |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «IVL_TS» Period period
"The interval during which the endpoint is expected to be operational." - HL7 FHIR, Endpoint.period
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ElectronicServiceEndpoint |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | period |
Name Expression | |
Namespace | ElectronicServiceEndpoint |
Opposite | |
Owner | ElectronicServiceEndpoint |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Provider::ElectronicServiceEndpoint::period |
Stereotype | |
Template Parameter | |
Type | «IVL_TS» Period |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ElectronicServiceEndpoint |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | preferredMethod |
Name Expression | |
Namespace | ElectronicServiceEndpoint |
Opposite | |
Owner | ElectronicServiceEndpoint |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Provider::ElectronicServiceEndpoint::preferredMethod |
Stereotype | |
Template Parameter | |
Type | Integer |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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.
Aggregation | None |
Alias | |
Association | electronicServiceInformation_providerDirectoryContentProfile |
Association End | |
Class | ElectronicServiceEndpoint |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | providerDirectoryContentProfile |
Name Expression | |
Namespace | ElectronicServiceEndpoint |
Opposite | |
Owner | ElectronicServiceEndpoint |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Provider::ElectronicServiceEndpoint::providerDirectoryContentProfile |
Stereotype | |
Template Parameter | |
Type | ProviderDirectoryContentProfile |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public ProviderDirectorySecurityProfile providerDirectorySecurityProfile
Aggregation | None |
Alias | |
Association | electronicServiceInformation_providerDirectorySecurityProfile |
Association End | |
Class | ElectronicServiceEndpoint |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | providerDirectorySecurityProfile |
Name Expression | |
Namespace | ElectronicServiceEndpoint |
Opposite | |
Owner | ElectronicServiceEndpoint |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Provider::ElectronicServiceEndpoint::providerDirectorySecurityProfile |
Stereotype | |
Template Parameter | |
Type | ProviderDirectorySecurityProfile |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «CS» Code status
"active | suspended | error | off | test." - HL7 FHIR, Endpoint.status
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ElectronicServiceEndpoint |
Terminologies | [ HL7_FHIR_R4 EndpointStatus http://hl7.org/fhir/ValueSet/endpoint-status ] |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | status |
Name Expression | |
Namespace | ElectronicServiceEndpoint |
Opposite | |
Owner | ElectronicServiceEndpoint |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Provider::ElectronicServiceEndpoint::status |
Stereotype | ValueSetConstraints |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
| Provider UML Documentation |
Summary:AttributesProperties | Detail:Attributes |