R4 Draft for Comment

This page is part of the FHIR Specification (v3.2.0: R4 Ballot 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

8.9 Resource Endpoint - Content

Patient Administration

Work Group

Maturity Level: 2

Trial Use

Compartments: Not linked to any defined compartments

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.

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)

8.9.2 Boundaries and Relationships

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

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
(Refer to the scope and usage section for common uses)

This resource is referenced by HealthcareService, ImagingStudy, Location, Organization, OrganizationRole, PractitionerRole and ProductPlan

Structure

Name	Flags	Card.	Type	Description & Constraints
Endpoint	TU		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 \| suspended \| error \| off \| entered-in-error \| test EndpointStatus (Required)
connectionType	Σ	1..1	Coding	Protocol/Profile/Standard to be used with this endpoint connection Endpoint Connection Type (Extensible)
name	Σ	0..1	string	A name that this endpoint can be identified by
managingOrganization	Σ	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	Σ	1..*	CodeableConcept	The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Endpoint Payload Type (Example)
payloadMimeType	Σ	0..*	code	Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) MimeType (Required)
address	Σ	1..1	uri	The technical base address for connecting to this endpoint
header		0..*	string	Usage depends on the channel type
Documentation for this format

UML Diagram (Legend)

XML Template

<Endpoint xmlns="http://hl7.org/fhir"> 
 <!-- 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 | suspended | error | off | entered-in-error | test -->
 <connectionType><!-- 1..1 Coding 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 -->
 <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><!-- 1..* CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) --></payloadType>
 <payloadMimeType value="[code]"/><!-- 0..* Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)  -->
 <address value="[uri]"/><!-- 1..1 The technical base address for connecting to this endpoint -->
 <header value="[string]"/><!-- 0..* Usage depends on the channel type -->
</Endpoint>

JSON Template

{
  "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 | suspended | error | off | entered-in-error | test
  "connectionType" : { Coding }, // R!  Protocol/Profile/Standard to be used with this endpoint connection
  "name" : "<string>", // A name that this endpoint can be identified by
  "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
  "payloadType" : [{ CodeableConcept }], // R!  The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
  "payloadMimeType" : ["<code>"], // Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) 
  "address" : "<uri>", // 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/> .


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

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:Endpoint.identifier [ Identifier ], ... ; # 0..* Identifies this endpoint across multiple systems
  fhir:Endpoint.status [ code ]; # 1..1 active | suspended | error | off | entered-in-error | test
  fhir:Endpoint.connectionType [ Coding ]; # 1..1 Protocol/Profile/Standard to be used with this endpoint connection
  fhir:Endpoint.name [ string ]; # 0..1 A name that this endpoint can be identified by
  fhir:Endpoint.managingOrganization [ Reference(Organization) ]; # 0..1 Organization that manages this endpoint (might not be the organization that exposes the endpoint)
  fhir:Endpoint.contact [ ContactPoint ], ... ; # 0..* Contact details for source (e.g. troubleshooting)
  fhir:Endpoint.period [ Period ]; # 0..1 Interval the endpoint is expected to be operational
  fhir:Endpoint.payloadType [ CodeableConcept ], ... ; # 1..* The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
  fhir:Endpoint.payloadMimeType [ code ], ... ; # 0..* Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
  fhir:Endpoint.address [ uri ]; # 1..1 The technical base address for connecting to this endpoint
  fhir:Endpoint.header [ string ], ... ; # 0..* Usage depends on the channel type
]

Changes since DSTU2

This resource did not exist in Release 2

This analysis is available as XML or JSON.

Structure

Name	Flags	Card.	Type	Description & Constraints
Endpoint	TU		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 \| suspended \| error \| off \| entered-in-error \| test EndpointStatus (Required)
connectionType	Σ	1..1	Coding	Protocol/Profile/Standard to be used with this endpoint connection Endpoint Connection Type (Extensible)
name	Σ	0..1	string	A name that this endpoint can be identified by
managingOrganization	Σ	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	Σ	1..*	CodeableConcept	The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Endpoint Payload Type (Example)
payloadMimeType	Σ	0..*	code	Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) MimeType (Required)
address	Σ	1..1	uri	The technical base address for connecting to this endpoint
header		0..*	string	Usage depends on the channel type
Documentation for this format

UML Diagram (Legend)

XML Template

<Endpoint xmlns="http://hl7.org/fhir"> 
 <!-- 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 | suspended | error | off | entered-in-error | test -->
 <connectionType><!-- 1..1 Coding 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 -->
 <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><!-- 1..* CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) --></payloadType>
 <payloadMimeType value="[code]"/><!-- 0..* Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)  -->
 <address value="[uri]"/><!-- 1..1 The technical base address for connecting to this endpoint -->
 <header value="[string]"/><!-- 0..* Usage depends on the channel type -->
</Endpoint>

JSON Template

{
  "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 | suspended | error | off | entered-in-error | test
  "connectionType" : { Coding }, // R!  Protocol/Profile/Standard to be used with this endpoint connection
  "name" : "<string>", // A name that this endpoint can be identified by
  "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
  "payloadType" : [{ CodeableConcept }], // R!  The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
  "payloadMimeType" : ["<code>"], // Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) 
  "address" : "<uri>", // 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/> .


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

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:Endpoint.identifier [ Identifier ], ... ; # 0..* Identifies this endpoint across multiple systems
  fhir:Endpoint.status [ code ]; # 1..1 active | suspended | error | off | entered-in-error | test
  fhir:Endpoint.connectionType [ Coding ]; # 1..1 Protocol/Profile/Standard to be used with this endpoint connection
  fhir:Endpoint.name [ string ]; # 0..1 A name that this endpoint can be identified by
  fhir:Endpoint.managingOrganization [ Reference(Organization) ]; # 0..1 Organization that manages this endpoint (might not be the organization that exposes the endpoint)
  fhir:Endpoint.contact [ ContactPoint ], ... ; # 0..* Contact details for source (e.g. troubleshooting)
  fhir:Endpoint.period [ Period ]; # 0..1 Interval the endpoint is expected to be operational
  fhir:Endpoint.payloadType [ CodeableConcept ], ... ; # 1..* The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
  fhir:Endpoint.payloadMimeType [ code ], ... ; # 0..* Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
  fhir:Endpoint.address [ uri ]; # 1..1 The technical base address for connecting to this endpoint
  fhir:Endpoint.header [ string ], ... ; # 0..* Usage depends on the channel type
]

Changes since DSTU2

This resource did not exist in Release 2

This analysis is available as XML or JSON.

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

8.9.4.1 Terminology Bindings

Path	Definition	Type	Reference
Endpoint.status	The status of the endpoint	Required	EndpointStatus
Endpoint.connectionType		Extensible	Endpoint Connection Type
Endpoint.payloadType		Example	Endpoint Payload Type
Endpoint.payloadMimeType	The mime type of an attachment. Any valid mime type is allowed.	Required	BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)

Path

Definition

Type

Reference

Endpoint.status

The status of the endpoint

Required

EndpointStatus

Endpoint.connectionType

Extensible

Endpoint Connection Type

Endpoint.payloadType

Example

Endpoint Payload Type

Endpoint.payloadMimeType

The mime type of an attachment. Any valid mime type is allowed.

Required

BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)

8.9.5 Search Parameters

Search parameters for 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-type	token	The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)	Endpoint.payloadType
status	token	The current status of the Endpoint (usually expected to be active)	Endpoint.status