Implementation Guide
23.1.0 - R4 APIs

Publish Box goes here

Resource Profile: Profile - Athena Endpoint

Official URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-endpoint-profile Version: 23.1.0
Active as of 2022-03-01 Computable Name: AthenaEndpoint

Defines constraints and extensions on the Endpoint resource as supported by Athena Products.

This Endpoint profile is part of the set of resource profiles supported by the API Server used with the athenaPractice and athenaFlow products. It further describes read and search capabilities of these products. Note: The create and update operations are NOT supported for this resource.

Overview

An endpoint describes the technical details of a location that can be connected to for the delivery/retrieval of information. Sufficient information is required to ensure that a connection can be made securely, and appropriate data transmitted as defined by the endpoint owner.

Scope and Usage

This profile is used to define the content that will be returned by the API Server in response to requests to access Endpoint resources. All elements listed in the differential profile view are Supported, which means that the API Server is capable of supplying these fields from the product database when they have been populated via the product or its APIs.

Source

The Endpoint resource is derived from the DOCTORFACILITY, USR tables in athenaPractice and USR table in athenaFlow. Specific detail can be found in the Mappings tab in the profile detail page.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Endpoint

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..* Endpoint The technical details of an endpoint that can be used for electronic services
... id 1..1 id Logical id of this artifact
... meta S 0..1 Meta Metadata about the resource
.... Slices for profile 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:Athena Endpoint Profile S 1..1 canonical() Profiles this resource claims to conform to
Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-endpoint-profile
... status S 1..1 code active
... name S 1..1 string A name that this endpoint can be identified by
... managingOrganization S 0..1 Reference(Organization) Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... payloadType S 1..1 CodeableConcept urn:hl7-org:sdwg:ccda-structuredBody:2.1
... payloadMimeType S 1..* code text/xml
... address S 1..1 url The technical base address for connecting to this endpoint

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..* Endpoint The technical details of an endpoint that can be used for electronic services
... id Σ 1..1 id Logical id of this artifact
... meta SΣ 0..1 Meta Metadata about the resource
.... Slices for profile Σ 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:Athena Endpoint Profile SΣ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-endpoint-profile
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... status ?!SΣ 1..1 code active
Binding: EndpointStatus (required): The status of the endpoint.

... connectionType SΣ 1..1 Coding direct-project
Binding: EndpointConnectionType (extensible)
... name SΣ 1..1 string A name that this endpoint can be identified by
... managingOrganization SΣ 0..1 Reference(Organization) Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... payloadType SΣ 1..1 CodeableConcept urn:hl7-org:sdwg:ccda-structuredBody:2.1
Binding: EndpointPayloadType (example)
... payloadMimeType SΣ 1..* code text/xml
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


... address SΣ 1..1 url The technical base address for connecting to this endpoint

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Endpoint.statusrequiredEndpointStatus
http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1
from the FHIR Standard
Endpoint.connectionTypeextensibleEndpointConnectionType
http://hl7.org/fhir/ValueSet/endpoint-connection-type
from the FHIR Standard
Endpoint.payloadTypeexampleEndpointPayloadType
http://hl7.org/fhir/ValueSet/endpoint-payload-type
from the FHIR Standard
Endpoint.payloadMimeTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..* Endpoint The technical details of an endpoint that can be used for electronic services
... id Σ 1..1 id Logical id of this artifact
... meta SΣ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... Slices for profile Σ 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:Athena Endpoint Profile SΣ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-endpoint-profile
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Identifies this endpoint across multiple systems
... status ?!SΣ 1..1 code active
Binding: EndpointStatus (required): The status of the endpoint.

... connectionType SΣ 1..1 Coding direct-project
Binding: EndpointConnectionType (extensible)
... name SΣ 1..1 string A name that this endpoint can be identified by
... managingOrganization SΣ 0..1 Reference(Organization) Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... contact 0..* ContactPoint Contact details for source (e.g. troubleshooting)
... period Σ 0..1 Period Interval the endpoint is expected to be operational
... payloadType SΣ 1..1 CodeableConcept urn:hl7-org:sdwg:ccda-structuredBody:2.1
Binding: EndpointPayloadType (example)
... payloadMimeType SΣ 1..* code text/xml
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


... address SΣ 1..1 url The technical base address for connecting to this endpoint
... header 0..* string Usage depends on the channel type

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Endpoint.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Endpoint.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Endpoint.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Endpoint.statusrequiredEndpointStatus
http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1
from the FHIR Standard
Endpoint.connectionTypeextensibleEndpointConnectionType
http://hl7.org/fhir/ValueSet/endpoint-connection-type
from the FHIR Standard
Endpoint.payloadTypeexampleEndpointPayloadType
http://hl7.org/fhir/ValueSet/endpoint-payload-type
from the FHIR Standard
Endpoint.payloadMimeTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard

This structure is derived from Endpoint

Summary

Mandatory: 7 elements(2 nested mandatory elements)
Must-Support: 9 elements
Fixed: 1 element

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Endpoint.meta.profile

Differential View

This structure is derived from Endpoint

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..* Endpoint The technical details of an endpoint that can be used for electronic services
... id 1..1 id Logical id of this artifact
... meta S 0..1 Meta Metadata about the resource
.... Slices for profile 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:Athena Endpoint Profile S 1..1 canonical() Profiles this resource claims to conform to
Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-endpoint-profile
... status S 1..1 code active
... name S 1..1 string A name that this endpoint can be identified by
... managingOrganization S 0..1 Reference(Organization) Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... payloadType S 1..1 CodeableConcept urn:hl7-org:sdwg:ccda-structuredBody:2.1
... payloadMimeType S 1..* code text/xml
... address S 1..1 url The technical base address for connecting to this endpoint

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..* Endpoint The technical details of an endpoint that can be used for electronic services
... id Σ 1..1 id Logical id of this artifact
... meta SΣ 0..1 Meta Metadata about the resource
.... Slices for profile Σ 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:Athena Endpoint Profile SΣ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-endpoint-profile
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... status ?!SΣ 1..1 code active
Binding: EndpointStatus (required): The status of the endpoint.

... connectionType SΣ 1..1 Coding direct-project
Binding: EndpointConnectionType (extensible)
... name SΣ 1..1 string A name that this endpoint can be identified by
... managingOrganization SΣ 0..1 Reference(Organization) Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... payloadType SΣ 1..1 CodeableConcept urn:hl7-org:sdwg:ccda-structuredBody:2.1
Binding: EndpointPayloadType (example)
... payloadMimeType SΣ 1..* code text/xml
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


... address SΣ 1..1 url The technical base address for connecting to this endpoint

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Endpoint.statusrequiredEndpointStatus
http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1
from the FHIR Standard
Endpoint.connectionTypeextensibleEndpointConnectionType
http://hl7.org/fhir/ValueSet/endpoint-connection-type
from the FHIR Standard
Endpoint.payloadTypeexampleEndpointPayloadType
http://hl7.org/fhir/ValueSet/endpoint-payload-type
from the FHIR Standard
Endpoint.payloadMimeTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..* Endpoint The technical details of an endpoint that can be used for electronic services
... id Σ 1..1 id Logical id of this artifact
... meta SΣ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... Slices for profile Σ 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:Athena Endpoint Profile SΣ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-endpoint-profile
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Identifies this endpoint across multiple systems
... status ?!SΣ 1..1 code active
Binding: EndpointStatus (required): The status of the endpoint.

... connectionType SΣ 1..1 Coding direct-project
Binding: EndpointConnectionType (extensible)
... name SΣ 1..1 string A name that this endpoint can be identified by
... managingOrganization SΣ 0..1 Reference(Organization) Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... contact 0..* ContactPoint Contact details for source (e.g. troubleshooting)
... period Σ 0..1 Period Interval the endpoint is expected to be operational
... payloadType SΣ 1..1 CodeableConcept urn:hl7-org:sdwg:ccda-structuredBody:2.1
Binding: EndpointPayloadType (example)
... payloadMimeType SΣ 1..* code text/xml
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


... address SΣ 1..1 url The technical base address for connecting to this endpoint
... header 0..* string Usage depends on the channel type

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Endpoint.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Endpoint.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Endpoint.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Endpoint.statusrequiredEndpointStatus
http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1
from the FHIR Standard
Endpoint.connectionTypeextensibleEndpointConnectionType
http://hl7.org/fhir/ValueSet/endpoint-connection-type
from the FHIR Standard
Endpoint.payloadTypeexampleEndpointPayloadType
http://hl7.org/fhir/ValueSet/endpoint-payload-type
from the FHIR Standard
Endpoint.payloadMimeTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard

This structure is derived from Endpoint

Summary

Mandatory: 7 elements(2 nested mandatory elements)
Must-Support: 9 elements
Fixed: 1 element

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Endpoint.meta.profile

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Supported Interactions

The Interactions supported by this resource are listed below.

Search Parameters

Search parameters are executed as specified in the HL7 FHIR RESTful API implementation definition. To search for Subscription resources, an application shall perform an HTTP GET, specifying the query parameters associated with the resource.

GET [base]/fhir/Endpoint?{search-parameters}{&_count=[max-results]&_format=[json|xml]&_summary=[true|text|data]}

Where:

Name Description
[base] Specifies the base URL of the FHIR Server, e.g., https://cpsapisandbox.virenceaz.com:9443/demoAPIServer
[_count] Specifies the maximum number of search results to return in a single query. Note: The count of results does not limit the number of additional resources returned via the _include parameter. No more than max-results Endpoint resources which match the search criteria will be returned. The API Server has default and maximum limits for the value that can be specified for this parameter. These limits may vary depending upon the client application vendors participation level in the Virence Partner program. Note: The API Server support the HL7 FHIR Paging capability.
[_format] Specifies the format of the output and may be xml or json. When present, the _format value overrides the value of the Accept header in the request.
[_summary] Filters the output to include only narrative elements (_summary=text), summary elements (_summary=true) or to omit the generated narrative (_summary=data). Note: If the generated html narrative for the resource is not going to be used by the call, using _summary=data provides improved API response times, especially when returning larger result sets.
_id (token) The ID of the resource
connection-type (token) Protocol/Profile/Standard to be used with this endpoint connection.
name (string) A name that this endpoint can be identified by
organization (reference) The organization that is managing the endpoint
payload-type (token) The type of content that may be used at this endpoint (e.g. XDS Discharge summaries).
status (token) The current status of the Endpoint (usually expected to be active).
HTTP Response Codes

The following HTTP response codes are returned by this API call:

200 OK The query was performed and any results found are contained within the body of the HTTP response. Note: The search API will return 200 OK when the query itself is successful, regardless of whether or not any matching results were found.
401 Unauthorized Authorization is required for this request, and either the Authorization header is missing or the supplied user credentials in the Authorization header are not valid or have expired. The body of the HTTP response will contain an OperationOutcome resource that indicates that Authorization is required.
500 Server Error The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.