8.9 资源之 终结点 - 简介

8.9.1 Scope and Usage

终结点描述了一个位置的技术细节，可以通过连接到该位置来传递/检索信息。 需要足够的信息来 欲确保安全地建立连接并按照终结点所有者的定义来传输正确的数据就需要大量的信息支撑。 这不是像能力声明那样针对当前系统进行详细描述，而是对另一个（可能是外部）系统的详细描述。
这些可能是本地主机服务、区域服务或国家服务。

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 for imaging content and metadata (QIDO-RS, WADO-RS, or WADO-URI)

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

• Structure
• UML
• XML
• JSON
• Turtle
• R3 Diff
• All

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	url	The technical base address for connecting to this endpoint
header		0..*	string	Usage depends on the channel type
Documentation for this format

<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="[url]"/><!-- 1..1 The technical base address for connecting to this endpoint -->
 <header value="[string]"/><!-- 0..* Usage depends on the channel type -->
</Endpoint>

{
  "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" : "<url>", // R!  The technical base address for connecting to this endpoint
  "header" : ["<string>"] // Usage depends on the channel type
}

@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 [ url ]; # 1..1 The technical base address for connecting to this endpoint
  fhir:Endpoint.header [ string ], ... ; # 0..* Usage depends on the channel type
]

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	url	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="[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

{
  "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" : "<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/> .


[ 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 [ url ]; # 1..1 The technical base address for connecting to this endpoint
  fhir:Endpoint.header [ string ], ... ; # 0..* Usage depends on the channel type
]

Changes since Release 3

Endpoint
Endpoint.status	Change value set from http://hl7.org/fhir/ValueSet/endpoint-status to http://hl7.org/fhir/ValueSet/endpoint-status|4.0.0
Endpoint.connectionType	Change code system for extensibly bound codes from "http://hl7.org/fhir/endpoint-connection-type" to "http://terminology.hl7.org/CodeSystem/endpoint-connection-type"
Endpoint.payloadMimeType	Change value set from http://hl7.org/fhir/ValueSet/mimetypes to http://hl7.org/fhir/ValueSet/mimetypes|4.0.0
Endpoint.address	Type changed from uri to url

See the Full Difference for further information

This analysis is available as XML or JSON.

See R3 <--> R4 Conversion Maps (status = 3 tests that all execute ok. All tests pass round-trip testing and all r3 resources are valid.)