8.9 Resource Endpoint - Content

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 Binding: Endpoint Status ( Required )
connectionType	Σ	1..1 1..*	Coding CodeableConcept	Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint Connection Type ( Extensible Example )
name	Σ	0..1	string	A name that this endpoint can be identified by
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	Contact details for source (e.g. troubleshooting)
period	Σ	0..1	Period	Interval the endpoint is expected to be operational
payloadType 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) Binding: MimeType Mime Types ( 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

See the Extensions for this resource

<

<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>
 <
 <</connectionType>

 <status value="[code]"/><!-- 1..1 active | suspended | error | off | entered-in-error | test -->
 <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>

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

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

{
  "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 | suspended | error | off | entered-in-error | test
  "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
  "
  "

  "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)
  }],

  "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:;

[ 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:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:

  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Identifies this endpoint across multiple systems
  fhir:status [ code ] ; # 1..1 active | suspended | error | off | entered-in-error | test
  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: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: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 R3 from both R4 and R4B

See the Full Difference for further information

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

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

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 Binding: Endpoint Status ( Required )
connectionType	Σ	1..1 1..*	Coding CodeableConcept	Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint Connection Type ( Extensible Example )
name	Σ	0..1	string	A name that this endpoint can be identified by
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	Contact details for source (e.g. troubleshooting)
period	Σ	0..1	Period	Interval the endpoint is expected to be operational
payloadType 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) Binding: MimeType Mime Types ( 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

See the Extensions for this resource

<

<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>
 <
 <</connectionType>

 <status value="[code]"/><!-- 1..1 active | suspended | error | off | entered-in-error | test -->
 <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>

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

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

{
  "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 | suspended | error | off | entered-in-error | test
  "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
  "
  "

  "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)
  }],

  "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:;

[ 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:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:

  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Identifies this endpoint across multiple systems
  fhir:status [ code ] ; # 1..1 active | suspended | error | off | entered-in-error | test
  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: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: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 Release 3 from both R4 and R4B

See the Full Difference for further information

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

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