FHIR Release 3 (STU) CI-Build

This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0 . For a full list Continuous Integration Build of available versions, see FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon . Page versions: R5 R4B R4 R3

8.9 Resource Endpoint - Content

Responsible Owner: Patient Administration icon Work Group   Normative Maturity Level : 2   Trial Use Security Category : Business Compartments : Not linked to any No defined compartments

The technical details of an endpoint that can be used for electronic services, such as for web services providing XDS.b or XDS.b, a REST endpoint for another FHIR server. server, or a s/Mime email address. This may include any security context information.

8.9.1 Scope and Usage

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. This is not a description of details of the current system, as found in CapabilityStatement , but of another (potentially external) system.
These may be locally hosted services, regional services, or national service.

These resources are typically used to identify where to locate endpoint details for:

  • Questionnaires: Where to send information (currently an SDC extension with just the address)
  • ValueSet: Where related Terminology Services can be found (where not local)
  • Subscription: The destination to send the subscribed data (or to pull)
  • Messaging: (currently defined in the Message Header, but only as the address)
  • Referrals: Where to send referral requests
    (linked to the services directory resources - Organization/Location/Practitioner/HealthcareService)
  • Referrals - Templates: Where to locate referral templates (Questionnaires)
    (linked to the services directory resources - Organization/Location/Practitioner/HealthcareService)
  • CarePlans: Where a shared CarePlan can be found
  • Scheduling: Where to lookup to discover schedules/availability information
    (linked to the services directory resources - Organization/Location/Practitioner/HealthcareService)
  • Scheduling: Where to lookup to send appointment requests
    (linked to the services directory resources - Organization/Location/Practitioner/HealthcareService)
  • Patient/Person: Location of Master Patient/Person Indexes
  • Service Provider Directories: Location of related directories (parent/child/federated)
  • DICOM/imaging: Location of where to query, retrieve or store imaging content and metadata (QIDO-RS, WADO-RS, WADO-URI, STOW-RS)

8.9.2 Boundaries and Relationships

8.9.2.1 CapabilityStatement

The endpoint is distinct from a capability statement in that the CapabilityStatement statement describes the entire capability of a server system (and in the metadata case, just this server) system)
Where the endpoint resource describes the technical details for how to connect, and for what purposes (which could be a small sub-set of the server's system's capabilities, and may might not be a FHIR endpoint).

8.9.2.2 ContactPoint

Endpoints are used to facilitate system to system communication, providing the details of the addressing of the system, purpose of use, protocols required/provided, and any other details required to communicate between the systems. (such as configuration parameters, require headers ...) The address value in the endpoint can only be used in the context of the provided details.

E.g. If the endpoint has a URL for an XDS service, using that in a browser by a user is meaningless.

E.g.2 If the endpoint has a US Direct address, using this to send a normal email message will not work, as they are not true email addresses (even though they appear to be)

A ContactPoint contains contact information, such as a phone number, web address that a user can directly interact with, no additional information would be required to use the value. The value is generally used to communicate with an entity directly, not a system.

8.9.3 Background and Context

8.9.3.1 Expected Implementations

  • Any solution where there are distributed FHIR servers deployed and need discovery/configuration
  • Systems advertising connectivity information in a DICOM environment
  • (Refer to the scope and usage section for common uses)
This resource is referenced by HealthcareService

8.9.4 References to this Resource

8.9.4 8.9.5 Resource Content

Structure

1..1 1..1
Name Flags Card. Type Description & Constraints      Filter: Filters doco
. . Endpoint N DomainResource The technical details of an endpoint that can be used for electronic services

Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
. . . identifier Σ 0..* Identifier Identifies this endpoint across multiple systems

. . . status ?! Σ 1..1 code active | limited | suspended | error | off | entered-in-error | test
EndpointStatus Binding: Endpoint Status ( Required )
. . . connectionType Σ 1..* Coding CodeableConcept Protocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Type ( Extensible Example )

. . managingOrganization . description Σ 0..1 string Additional details about the endpoint that could be displayed as further information to identify the description beyond its name
... environmentType Σ 0..* CodeableConcept 0..1 The type of environment(s) exposed at this endpoint
Binding: Endpoint Environment ( Extensible )

. . . managingOrganization Σ 0..1 Reference ( Organization ) Organization that manages this endpoint (may (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 availability 0..1 Σ Availability Times the endpoint is expected to be available (including exceptions)
1..*
. . . payload 0..* BackboneElement Set of payloads that are provided by this endpoint

.... type Σ 0..* CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: Endpoint Payload Type ( Example )

. . . payloadMimeType . mimeType Σ 0..* code Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
MimeType Binding: Mime Types ( Required )

. . . address . profileCanonical 0..* Σ canonical () The profile that is expected at this endpoint

. . . . profileUri 0..* uri The non-fhir based profile that is expected at this endpoint

. . . address Σ 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 icon

See the Extensions for this resource

UML Diagram ( Legend )

Endpoint ( DomainResource ) Identifier for the organization that is used to identify the endpoint across multiple disparate systems identifier : Identifier [0..*] active | suspended | error | off | test The endpoint status represents whether the endpoint can currently be used for connections or why it can't be used (this element modifies the meaning of other elements) status : code [1..1] « The status of the endpoint null (Strength=Required) EndpointStatus ! » 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) connectionType : Coding CodeableConcept [1..1] [1..*] « (Strength=Extensible) null (Strength=Example) Endpoint Connection Type EndpointConnectionType + ?? » A friendly name that this endpoint can be referred to with name : string [0..1] The description of the endpoint and what it is for (typically used as supplemental information in an endpoint directory describing its usage/purpose) description : string [0..1] The type of environment(s) exposed at this endpoint (dev, prod, test, etc.) environmentType : CodeableConcept [0..*] « null (Strength=Extensible) EndpointEnvironment + » The organization that manages provides technical management services for this endpoint. This would be the organization that acts as the public help desk for when the endpoint (even if technically another organisation is hosting this in not functioning. It does NOT necessarily represent the cloud, it organization who is the organisation associated with steward of data being provided/accepted by the data) endpoint managingOrganization : Reference [0..1] « Organization » Contact details for a human to contact about the subscription. endpoint. The primary use of this for system administrator troubleshooting contact : ContactPoint [0..*] The interval during which the endpoint is expected to be operational period : Period [0..1] The times the endpoint is expected to be available, including transient downtimes and any exceptions availability : Availability [0..1] The uri that describes the actual end-point to connect to address : url [1..1] Additional headers / information to send as part of the notification header : string [0..*] Payload The payload type describes the acceptable content that can be communicated on the endpoint payloadType type : CodeableConcept [1..*] [0..*] « null (Strength=Example) Endpoint Payload Type EndpointPayloadType ?? » 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) payloadMimeType mimeType : code [0..*] « The mime type of an attachment. Any valid mime type is allowed. (Strength=Required) MimeType MimeTypes ! » The uri FHIR profile that is expected at this endpoint. It describes the actual end-point to connect to resources that are handled, or even simply which resource types -e.g. Vital Sign Observations or QuestionnaireResponse. The `profileUri` may be used when a FHIR Structure Definition is not available/appropriate address profileCanonical : uri canonical [1..1] [0..*] « » Additional headers / information to send The profile (as a uri) that is expected at this endpoint when not represented using a FHIR profile. e.g. CDA Template ID expressed as part of an OID (in the notification Uri) header profileUri : string uri [0..*] The set of payloads that are provided/available at this endpoint payload [0..*]

XML Template 

<

<Endpoint xmlns="http://hl7.org/fhir"> doco

 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Identifies this endpoint across multiple systems --></identifier>
 <
 <</connectionType>
 <
 <</managingOrganization>
 <</contact>

 <status value="[code]"/><!-- 1..1 active | limited | suspended | error | off | entered-in-error -->
 <connectionType><!-- 1..* CodeableConcept Protocol/Profile/Standard to be used with this endpoint connection --></connectionType>
 <name value="[string]"/><!-- 0..1 A name that this endpoint can be identified by -->
 <description value="[string]"/><!-- 0..1 Additional details about the endpoint that could be displayed as further information to identify the description beyond its name -->
 <environmentType><!-- 0..* CodeableConcept The type of environment(s) exposed at this endpoint --></environmentType>
 <managingOrganization><!-- 0..1 Reference(Organization) Organization that manages this endpoint (might not be the organization that exposes the endpoint) --></managingOrganization>
 <contact><!-- 0..* ContactPoint Contact details for source (e.g. troubleshooting) --></contact>

 <period><!-- 0..1 Period Interval the endpoint is expected to be operational --></period>
 <</payloadType>
 <
 <
 <

 <availability><!-- 0..1 Availability Times the endpoint is expected to be available (including exceptions) --></availability>
 <payload>  <!-- 0..* Set of payloads that are provided by this endpoint -->
  <type><!-- 0..* CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) --></type>
  <mimeType value="[code]"/><!-- 0..* Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) -->
  <profileCanonical value="[canonical]"/><!-- 0..* The profile that is expected at this endpoint -->
  <profileUri value="[uri]"/><!-- 0..* The non-fhir based profile that is expected at this endpoint -->
 </payload>
 <address value="[url]"/><!-- 1..1 The technical base address for connecting to this endpoint -->
 <header value="[string]"/><!-- 0..* Usage depends on the channel type -->

</Endpoint>

JSON Template 

{doco
  "resourceType" : "",

  "resourceType" : "Endpoint",

  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "

  "identifier" : [{ Identifier }], // Identifies this endpoint across multiple systems
  "status" : "<code>", // R!  active | limited | suspended | error | off | entered-in-error
  "connectionType" : [{ CodeableConcept }], // R!  Protocol/Profile/Standard to be used with this endpoint connection
  "name" : "<string>", // A name that this endpoint can be identified by
  "description" : "<string>", // Additional details about the endpoint that could be displayed as further information to identify the description beyond its name
  "environmentType" : [{ CodeableConcept }], // The type of environment(s) exposed at this endpoint
  "managingOrganization" : { Reference(Organization) }, // Organization that manages this endpoint (might not be the organization that exposes the endpoint)
  "contact" : [{ ContactPoint }], // Contact details for source (e.g. troubleshooting)
  "period" : { Period }, // Interval the endpoint is expected to be operational
  "availability" : { Availability }, // Times the endpoint is expected to be available (including exceptions)
  "payload" : [{ // Set of payloads that are provided by this endpoint
    "type" : [{ CodeableConcept }], // The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
    "mimeType" : ["<code>"], // Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
    "profileCanonical" : ["<canonical>"], // The profile that is expected at this endpoint
    "profileUri" : ["<uri>"] // The non-fhir based profile that is expected at this endpoint
  }],
  "address" : "<url>", // R!  The technical base address for connecting to this endpoint
  "header" : ["<string>"] // Usage depends on the channel type

}

Turtle Template 

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:;

[ a fhir:Endpoint;

  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from 
  # from 
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:

  # from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language
  # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir:modifierExtension
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Identifies this endpoint across multiple systems
  fhir:status [ code ] ; # 1..1 active | limited | suspended | error | off | entered-in-error
  fhir:connectionType  ( [ CodeableConcept ] ... ) ; # 1..* Protocol/Profile/Standard to be used with this endpoint connection
  fhir:name [ string ] ; # 0..1 A name that this endpoint can be identified by
  fhir:description [ string ] ; # 0..1 Additional details about the endpoint that could be displayed as further information to identify the description beyond its name
  fhir:environmentType  ( [ CodeableConcept ] ... ) ; # 0..* The type of environment(s) exposed at this endpoint
  fhir:managingOrganization [ Reference(Organization) ] ; # 0..1 Organization that manages this endpoint (might not be the organization that exposes the endpoint)
  fhir:contact  ( [ ContactPoint ] ... ) ; # 0..* Contact details for source (e.g. troubleshooting)
  fhir:period [ Period ] ; # 0..1 Interval the endpoint is expected to be operational
  fhir:availability [ Availability ] ; # 0..1 Times the endpoint is expected to be available (including exceptions)
  fhir:payload ( [ # 0..* Set of payloads that are provided by this endpoint
    fhir:type  ( [ CodeableConcept ] ... ) ; # 0..* The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
    fhir:mimeType  ( [ code ] ... ) ; # 0..* Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
    fhir:profileCanonical  ( [ canonical ] ... ) ; # 0..* The profile that is expected at this endpoint
    fhir:profileUri  ( [ uri ] ... ) ; # 0..* The non-fhir based profile that is expected at this endpoint
  ] ... ) ;
  fhir:address [ url ] ; # 1..1 The technical base address for connecting to this endpoint
  fhir:header  ( [ string ] ... ) ; # 0..* Usage depends on the channel type

]

Changes since DSTU2 from both R4 and R4B

Endpoint
Endpoint.status
  • Remove code test
  • Add code limited
Endpoint.connectionType
  • Max Cardinality changed from 1 to *
  • Type changed from Coding to CodeableConcept
  • Remove Binding `http://hl7.org/fhir/ValueSet/endpoint-connection-type` (extensible)
Endpoint.description
  • Added Element
Endpoint.environmentType
  • Added Element
Endpoint.availability
  • Added Element
Endpoint.payload
  • Added Element
Endpoint.payload.type
  • Moved from Endpoint.payloadType to type
  • Min Cardinality changed from 1 to 0
Endpoint.payload.mimeType
  • Moved from Endpoint.payloadMimeType to mimeType
Endpoint.payload.profileCanonical
  • Added Element
Endpoint.payload.profileUri
  • Added Element

This resource did not exist in Release 2 See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON .

Structure

1..1 1..1
Name Flags Card. Type Description & Constraints      Filter: Filters doco
. . Endpoint N DomainResource The technical details of an endpoint that can be used for electronic services

Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
. . . identifier Σ 0..* Identifier Identifies this endpoint across multiple systems

. . . status ?! Σ 1..1 code active | limited | suspended | error | off | entered-in-error | test
EndpointStatus Binding: Endpoint Status ( Required )
. . . connectionType Σ 1..* Coding CodeableConcept Protocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Type ( Extensible Example )

. . managingOrganization . description Σ 0..1 string Additional details about the endpoint that could be displayed as further information to identify the description beyond its name
... environmentType Σ 0..* CodeableConcept The type of environment(s) exposed at this endpoint
Binding: Endpoint Environment ( Extensible )

0..1
. . . managingOrganization Σ 0..1 Reference ( Organization ) Organization that manages this endpoint (may (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 availability 0..1 Σ Availability Times the endpoint is expected to be available (including exceptions)
1..*
. . . payload 0..* BackboneElement Set of payloads that are provided by this endpoint

.... type Σ 0..* CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: Endpoint Payload Type ( Example )

. . . payloadMimeType . mimeType Σ 0..* code Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
MimeType Binding: Mime Types ( Required )

. . . address . profileCanonical 0..* Σ canonical () The profile that is expected at this endpoint

. . . . profileUri 0..* uri The non-fhir based profile that is expected at this endpoint

... address Σ 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 icon

See the Extensions for this resource

UML Diagram ( Legend )

Endpoint ( DomainResource ) Identifier for the organization that is used to identify the endpoint across multiple disparate systems identifier : Identifier [0..*] active | suspended | error | off | test The endpoint status represents whether the endpoint can currently be used for connections or why it can't be used (this element modifies the meaning of other elements) status : code [1..1] « The status of the endpoint null (Strength=Required) EndpointStatus ! » 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) connectionType : Coding CodeableConcept [1..1] [1..*] « (Strength=Extensible) null (Strength=Example) Endpoint Connection Type EndpointConnectionType + ?? » A friendly name that this endpoint can be referred to with name : string [0..1] The description of the endpoint and what it is for (typically used as supplemental information in an endpoint directory describing its usage/purpose) description : string [0..1] The type of environment(s) exposed at this endpoint (dev, prod, test, etc.) environmentType : CodeableConcept [0..*] « null (Strength=Extensible) EndpointEnvironment + » The organization that manages provides technical management services for this endpoint. This would be the organization that acts as the public help desk for when the endpoint (even if technically another organisation is hosting this in not functioning. It does NOT necessarily represent the cloud, it organization who is the organisation associated with steward of data being provided/accepted by the data) endpoint managingOrganization : Reference [0..1] « Organization » Contact details for a human to contact about the subscription. endpoint. The primary use of this for system administrator troubleshooting contact : ContactPoint [0..*] The interval during which the endpoint is expected to be operational period : Period [0..1] The times the endpoint is expected to be available, including transient downtimes and any exceptions availability : Availability [0..1] The uri that describes the actual end-point to connect to address : url [1..1] Additional headers / information to send as part of the notification header : string [0..*] Payload The payload type describes the acceptable content that can be communicated on the endpoint payloadType type : CodeableConcept [1..*] [0..*] « null (Strength=Example) Endpoint Payload Type EndpointPayloadType ?? » 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) payloadMimeType mimeType : code [0..*] « The mime type of an attachment. Any valid mime type is allowed. (Strength=Required) MimeType MimeTypes ! » The uri FHIR profile that is expected at this endpoint. It describes the actual end-point to connect to resources that are handled, or even simply which resource types -e.g. Vital Sign Observations or QuestionnaireResponse. The `profileUri` may be used when a FHIR Structure Definition is not available/appropriate address profileCanonical : uri canonical [1..1] [0..*] « » Additional headers / information to send The profile (as a uri) that is expected at this endpoint when not represented using a FHIR profile. e.g. CDA Template ID expressed as part of an OID (in the notification Uri) header profileUri : string uri [0..*] The set of payloads that are provided/available at this endpoint payload [0..*]

XML Template 

<

<Endpoint xmlns="http://hl7.org/fhir"> doco

 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Identifies this endpoint across multiple systems --></identifier>
 <
 <</connectionType>
 <
 <</managingOrganization>
 <</contact>

 <status value="[code]"/><!-- 1..1 active | limited | suspended | error | off | entered-in-error -->
 <connectionType><!-- 1..* CodeableConcept Protocol/Profile/Standard to be used with this endpoint connection --></connectionType>
 <name value="[string]"/><!-- 0..1 A name that this endpoint can be identified by -->
 <description value="[string]"/><!-- 0..1 Additional details about the endpoint that could be displayed as further information to identify the description beyond its name -->
 <environmentType><!-- 0..* CodeableConcept The type of environment(s) exposed at this endpoint --></environmentType>
 <managingOrganization><!-- 0..1 Reference(Organization) Organization that manages this endpoint (might not be the organization that exposes the endpoint) --></managingOrganization>
 <contact><!-- 0..* ContactPoint Contact details for source (e.g. troubleshooting) --></contact>

 <period><!-- 0..1 Period Interval the endpoint is expected to be operational --></period>
 <</payloadType>
 <
 <
 <

 <availability><!-- 0..1 Availability Times the endpoint is expected to be available (including exceptions) --></availability>
 <payload>  <!-- 0..* Set of payloads that are provided by this endpoint -->
  <type><!-- 0..* CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) --></type>
  <mimeType value="[code]"/><!-- 0..* Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) -->
  <profileCanonical value="[canonical]"/><!-- 0..* The profile that is expected at this endpoint -->
  <profileUri value="[uri]"/><!-- 0..* The non-fhir based profile that is expected at this endpoint -->
 </payload>
 <address value="[url]"/><!-- 1..1 The technical base address for connecting to this endpoint -->
 <header value="[string]"/><!-- 0..* Usage depends on the channel type -->

</Endpoint>

JSON Template 

{doco
  "resourceType" : "",

  "resourceType" : "Endpoint",

  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "
  "

  "identifier" : [{ Identifier }], // Identifies this endpoint across multiple systems
  "status" : "<code>", // R!  active | limited | suspended | error | off | entered-in-error
  "connectionType" : [{ CodeableConcept }], // R!  Protocol/Profile/Standard to be used with this endpoint connection
  "name" : "<string>", // A name that this endpoint can be identified by
  "description" : "<string>", // Additional details about the endpoint that could be displayed as further information to identify the description beyond its name
  "environmentType" : [{ CodeableConcept }], // The type of environment(s) exposed at this endpoint
  "managingOrganization" : { Reference(Organization) }, // Organization that manages this endpoint (might not be the organization that exposes the endpoint)
  "contact" : [{ ContactPoint }], // Contact details for source (e.g. troubleshooting)
  "period" : { Period }, // Interval the endpoint is expected to be operational
  "availability" : { Availability }, // Times the endpoint is expected to be available (including exceptions)
  "payload" : [{ // Set of payloads that are provided by this endpoint
    "type" : [{ CodeableConcept }], // The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
    "mimeType" : ["<code>"], // Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
    "profileCanonical" : ["<canonical>"], // The profile that is expected at this endpoint
    "profileUri" : ["<uri>"] // The non-fhir based profile that is expected at this endpoint
  }],
  "address" : "<url>", // R!  The technical base address for connecting to this endpoint
  "header" : ["<string>"] // Usage depends on the channel type

}

Turtle Template 

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:;

[ a fhir:Endpoint;

  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from 
  # from 
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:

  # from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language
  # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir:modifierExtension
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Identifies this endpoint across multiple systems
  fhir:status [ code ] ; # 1..1 active | limited | suspended | error | off | entered-in-error
  fhir:connectionType  ( [ CodeableConcept ] ... ) ; # 1..* Protocol/Profile/Standard to be used with this endpoint connection
  fhir:name [ string ] ; # 0..1 A name that this endpoint can be identified by
  fhir:description [ string ] ; # 0..1 Additional details about the endpoint that could be displayed as further information to identify the description beyond its name
  fhir:environmentType  ( [ CodeableConcept ] ... ) ; # 0..* The type of environment(s) exposed at this endpoint
  fhir:managingOrganization [ Reference(Organization) ] ; # 0..1 Organization that manages this endpoint (might not be the organization that exposes the endpoint)
  fhir:contact  ( [ ContactPoint ] ... ) ; # 0..* Contact details for source (e.g. troubleshooting)
  fhir:period [ Period ] ; # 0..1 Interval the endpoint is expected to be operational
  fhir:availability [ Availability ] ; # 0..1 Times the endpoint is expected to be available (including exceptions)
  fhir:payload ( [ # 0..* Set of payloads that are provided by this endpoint
    fhir:type  ( [ CodeableConcept ] ... ) ; # 0..* The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
    fhir:mimeType  ( [ code ] ... ) ; # 0..* Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
    fhir:profileCanonical  ( [ canonical ] ... ) ; # 0..* The profile that is expected at this endpoint
    fhir:profileUri  ( [ uri ] ... ) ; # 0..* The non-fhir based profile that is expected at this endpoint
  ] ... ) ;
  fhir:address [ url ] ; # 1..1 The technical base address for connecting to this endpoint
  fhir:header  ( [ string ] ... ) ; # 0..* Usage depends on the channel type

]

Changes since DSTU2 from both R4 and R4B

Endpoint
Endpoint.status
  • Remove code test
  • Add code limited
Endpoint.connectionType
  • Max Cardinality changed from 1 to *
  • Type changed from Coding to CodeableConcept
  • Remove Binding `http://hl7.org/fhir/ValueSet/endpoint-connection-type` (extensible)
Endpoint.description
  • Added Element
Endpoint.environmentType
  • Added Element
Endpoint.availability
  • Added Element
Endpoint.payload
  • Added Element
Endpoint.payload.type
  • Moved from Endpoint.payloadType to type
  • Min Cardinality changed from 1 to 0
Endpoint.payload.mimeType
  • Moved from Endpoint.payloadMimeType to mimeType
Endpoint.payload.profileCanonical
  • Added Element
Endpoint.payload.profileUri
  • Added Element

This resource did not exist in Release 2 See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON .

 

Alternate Additional definitions: Master Definition ( XML , + JSON ), , XML Schema / Schematron (for ) + JSON Schema , ShEx (for Turtle ) + see the extensions , the spreadsheet version & the dependency analysis

8.9.4.1 8.9.5.1 Terminology Bindings

Endpoint.connectionType Endpoint.payloadMimeType
Path Definition ValueSet Type Reference Documentation
Endpoint.status EndpointStatus Required

The status of the endpoint endpoint.

Endpoint.connectionType EndpointConnectionType Required Example EndpointStatus

This is an example value set defined by the FHIR project, that could be used to represent possible connection type profile values.

Endpoint.environmentType EndpointEnvironment Extensible Endpoint Connection Type

The environment type of the endpoint.

Endpoint.payloadType Endpoint.payload.type EndpointPayloadType Example Endpoint Payload Type

This is an example value set defined by the FHIR project, that could be used to represent possible payload document types.

Endpoint.payload.mimeType The mime type of an attachment. Any MimeTypes (a valid mime type is allowed. code from urn:ietf:bcp:13 ) Required BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)

This value set includes all possible codes from BCP-13 (see http://tools.ietf.org/html/bcp13)

8.9.6 Notes

  • The IHE connection types that were defined in R4 have been moved to IHE defined profiles and vocabulary at https://profiles.ihe.net/ITI/mCSD icon
  • Endpoint.period is meant to represent the general planned period of time when the Endpoint may be used, for example when an endpoint is being commissioned or decommissioned. It is not meant to account for temporary downtimes or other short terms changes of availability.
    For example, if an Endpoint is only available during business hours (9-5), the lack of availability during the night would not be reflected in Endpoint.period.

8.9.6.1 Payload Advertising

The Endpoint.payload.type is intended to be a description of the semantic content, for example, does this endpoint support exchanging care plans, discharge summaries, referrals, appointment bookings, etc. The "how" that content is exchanged is described elsewhere, via the mimeType (what format) and connectionType (what exchange method).

The Endpoint.profileCanonical / profileUri describes the detailed type of content that is handles/available at the endpoint. (Such as canonicals of FHIR resource profiles, or other non-fhir based profile references)

8.9.5 8.9.7 Search Parameters

Search parameters for this resource. See also the full list of search parameters for this resource , and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name Type Description Expression In Common
connection-type token Protocol/Profile/Standard to be used with this endpoint connection Endpoint.connectionType
identifier token Identifies this endpoint across multiple systems Endpoint.identifier
name string A name that this endpoint can be identified by Endpoint.name
organization reference The organization that is managing the endpoint Endpoint.managingOrganization
( Organization )
payload-profile reference The profiles (FHIR or non-FHIR) that might be used at this endpoint Endpoint.payload.profileCanonical | Endpoint.payload.profileUri
payload-type token The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Endpoint.payloadType Endpoint.payload.type
status token The current status of the Endpoint (usually expected to be active) Endpoint.status