FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

8.9 Resource Endpoint - Content

Responsible Owner: Patient Administration icon Work Group NormativeSecurity Category: Business Compartments: No defined compartments

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

Note to Balloters: Key changes made since FHIR 6.0.0-ballot5:

  • Non-compatible Changes
    • FHIR-57939 icon: The hoursOfOperation property cardinality was changed from * to 1. This should be put back to *
  • Compatible, Substantive Changes
    • FHIR-59544 icon: Endpoint does not allow discovery by url - new search parameter
    • FHIR-55915 icon: Endpoint.connectionType is mandatory but without an unknown or notavailable
  • Non-substantive Changes
    • FHIR-57757 icon: Endpoint needs clarification of ContactPoint and .contact use-case

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)

The endpoint is distinct from a capability statement in that the CapabilityStatement statement describes the entire capability of a system (and in the metadata case, just this 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 system's capabilities, and might not be a FHIR endpoint).

ContactPoint describes how to reach a person, for example, via phone, email, fax, for human-mediated communication. It's embedded in resources like Patient, Practitioner, and Organization.

Endpoint is a full resource describing a system-to-system connection - an API or messaging interface, with protocol, address, etc., for automated exchange.

A ContactPoint and an Endpoint can coexist on the same resource. An Organization might list a phone number (ContactPoint) for patients to call, alongside an API address (Endpoint) for automated referrals.

  • 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)

Structure

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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 | test | suspended | error | off | entered-in-error | unknown
Binding: Endpoint Status (Required)
... connectionType Σ 1..* CodeableConcept Protocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Type (Example)

... 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)

... managingOrganization Σ 0..1 Reference(Organization) Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... contact 0..* ContactPoint Who to contact for troubleshooting or maintenance

... period Σ 0..1 Period Interval the endpoint is expected to be operational
... availability 0..* Availability Times the endpoint is expected to be available (including exceptions)

... 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)

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

.... 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 connection type


doco Documentation for this format icon

UML Diagram (Legend)

Endpoint (DomainResource)Identifier for the organization that is used to identify the endpoint across multiple disparate systemsidentifier : Identifier [0..*]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] « 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 : CodeableConcept [1..*] « null (Strength=Example)EndpointConnectionType?? »A friendly name that this endpoint can be referred to withname : 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 provides technical management services for this endpoint. This would be the organization that acts as the public help desk for when the endpoint is not functioning. It does NOT necessarily represent the organization who is the steward of data being provided/accepted by the endpointmanagingOrganization : Reference [0..1] « Organization »Contact details for a human to contact about the endpoint. The primary use of this for system administrator troubleshootingcontact : ContactPoint [0..*]The interval during which the endpoint is expected to be operationalperiod : Period [0..1]The times the endpoint is expected to be available, including transient downtimes and any exceptionsavailability : Availability [0..*]The uri that describes the actual end-point to connect toaddress : url [1..1]Additional headers / information to send when connecting to the endpointheader : string [0..*]PayloadThe payload type describes the acceptable content that can be communicated on the endpointtype : CodeableConcept [0..*] « null (Strength=Example)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)mimeType : code [0..*] « The mime type of an attachment. Any valid mime type is allowed. (Strength=Required)MimeTypes! »The FHIR profile that is expected at this endpoint. It describes the 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/appropriateprofileCanonical : canonical [0..*] « »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 an OID (in the Uri)profileUri : uri [0..*]The set of payloads that are provided/available at this endpointpayload[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>
 <status value="[code]"/><!-- 1..1 active | limited | test | suspended | error | off | entered-in-error | unknown -->
 <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 Who to contact for troubleshooting or maintenance --></contact>
 <period><!-- 0..1 Period Interval the endpoint is expected to be operational --></period>
 <availability><!-- 0..* 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 connection type -->
</Endpoint>

JSON Template

{doco
  "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 | test | suspended | error | off | entered-in-error | unknown
  "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 }], // Who to contact for troubleshooting or maintenance
  "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 connection type
}

Turtle Template

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


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

  # 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 | test | suspended | error | off | entered-in-error | unknown
  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..* Who to contact for troubleshooting or maintenance
  fhir:period [ Period ] ; # 0..1 Interval the endpoint is expected to be operational
  fhir:availability  ( [ Availability ] ... ) ; # 0..* 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 connection type
]

Changes from R5 to R6

Endpoint
Endpoint.status
  • Add codes limited, test, unknown
Endpoint.availability
  • Added Element
Endpoint.payload.profileCanonical
  • Added Element
Endpoint.payload.profileUri
  • Added Element

Changes from R4 and R4B to R6

Endpoint
Endpoint.status
  • Add codes limited, unknown
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

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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 | test | suspended | error | off | entered-in-error | unknown
Binding: Endpoint Status (Required)
... connectionType Σ 1..* CodeableConcept Protocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Type (Example)

... 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)

... managingOrganization Σ 0..1 Reference(Organization) Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... contact 0..* ContactPoint Who to contact for troubleshooting or maintenance

... period Σ 0..1 Period Interval the endpoint is expected to be operational
... availability 0..* Availability Times the endpoint is expected to be available (including exceptions)

... 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)

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

.... 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 connection type


doco Documentation for this format icon

UML Diagram (Legend)

Endpoint (DomainResource)Identifier for the organization that is used to identify the endpoint across multiple disparate systemsidentifier : Identifier [0..*]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] « 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 : CodeableConcept [1..*] « null (Strength=Example)EndpointConnectionType?? »A friendly name that this endpoint can be referred to withname : 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 provides technical management services for this endpoint. This would be the organization that acts as the public help desk for when the endpoint is not functioning. It does NOT necessarily represent the organization who is the steward of data being provided/accepted by the endpointmanagingOrganization : Reference [0..1] « Organization »Contact details for a human to contact about the endpoint. The primary use of this for system administrator troubleshootingcontact : ContactPoint [0..*]The interval during which the endpoint is expected to be operationalperiod : Period [0..1]The times the endpoint is expected to be available, including transient downtimes and any exceptionsavailability : Availability [0..*]The uri that describes the actual end-point to connect toaddress : url [1..1]Additional headers / information to send when connecting to the endpointheader : string [0..*]PayloadThe payload type describes the acceptable content that can be communicated on the endpointtype : CodeableConcept [0..*] « null (Strength=Example)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)mimeType : code [0..*] « The mime type of an attachment. Any valid mime type is allowed. (Strength=Required)MimeTypes! »The FHIR profile that is expected at this endpoint. It describes the 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/appropriateprofileCanonical : canonical [0..*] « »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 an OID (in the Uri)profileUri : uri [0..*]The set of payloads that are provided/available at this endpointpayload[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>
 <status value="[code]"/><!-- 1..1 active | limited | test | suspended | error | off | entered-in-error | unknown -->
 <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 Who to contact for troubleshooting or maintenance --></contact>
 <period><!-- 0..1 Period Interval the endpoint is expected to be operational --></period>
 <availability><!-- 0..* 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 connection type -->
</Endpoint>

JSON Template

{doco
  "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 | test | suspended | error | off | entered-in-error | unknown
  "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 }], // Who to contact for troubleshooting or maintenance
  "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 connection type
}

Turtle Template

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


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

  # 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 | test | suspended | error | off | entered-in-error | unknown
  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..* Who to contact for troubleshooting or maintenance
  fhir:period [ Period ] ; # 0..1 Interval the endpoint is expected to be operational
  fhir:availability  ( [ Availability ] ... ) ; # 0..* 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 connection type
]

Changes from R5 to R6

Endpoint
Endpoint.status
  • Add codes limited, test, unknown
Endpoint.availability
  • Added Element
Endpoint.payload.profileCanonical
  • Added Element
Endpoint.payload.profileUri
  • Added Element

Changes from R4 and R4B to R6

Endpoint
Endpoint.status
  • Add codes limited, unknown
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

See the Full Difference for further information

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

 

Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis, and See the Extensions for this resource.

Path ValueSet Type Documentation
Endpoint.status EndpointStatus (a valid code from http://hl7.org/fhir/endpoint-status) Required

The status of the endpoint.

Endpoint.connectionType EndpointConnectionType Example

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 (a valid code from http://hl7.org/fhir/endpoint-environment) Extensible

The environment type of the endpoint.

Endpoint.payload.type EndpointPayloadType Example

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

Endpoint.payload.mimeType MimeTypes (a valid code from urn:ietf:bcp:13) Required

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

  • 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.

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)

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
address uri The technical base address for connecting to this endpoint Endpoint.address
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.payload.type
status token The current status of the Endpoint (usually expected to be active) Endpoint.status