Koppeltaal 2.0 Implementation Guide (Full Documentation) - Local Development build (v1.4.5-beta.002) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON

Resource Profile: KT2_Endpoint

The (FHIR) Endpoint (resource) is a representation of a technical contact point of an application that offers one or more eHealth services for a healthcare provider.

Usages:

• Refer to this Profile: KT2_EndpointExtension and KT2_Organization
• Examples for this Profile: nu.nl

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Endpoint		0..*	Endpoint	The technical details of an endpoint that can be used for electronic services
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:resource-origin		0..*	Reference(KT2_Device)	Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint.
connectionType	Σ	1..1	Coding	Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint connection type ValueSet (extensible) Fixed Value: As shown (HTI Smart on FHIR)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://vzvz.nl/fhir/CodeSystem/koppeltaal-endpoint-connection-type
version		0..0	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: hti-smart-on-fhir
display		0..0	string	Representation defined by the system
userSelected		0..0	boolean	If this coding was chosen directly by the user
managingOrganization	Σ	0..1	Reference(KT2_Organization)	Organization that manages this endpoint (might not be the organization that exposes the endpoint)
payloadType	Σ	1..*	CodeableConcept	The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: EndpointPayloadType (example) Fixed Value: As shown (Any)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
coding		1..1	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/endpoint-payload-type
version		0..0	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: any
display		0..0	string	Representation defined by the system
userSelected		0..0	boolean	If this coding was chosen directly by the user
text		0..0	string	Plain text representation of the concept
address	Σ	1..1	url	The technical base address for connecting to this endpoint
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Endpoint.status	required	EndpointStatus http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1 From the FHIR Standard
Endpoint.connectionType	extensible	Fixed Value: hti-smart-on-fhir http://vzvz.nl/fhir/ValueSet/endpoint-connection-type From this IG
Endpoint.payloadType	example	Fixed Value: any http://hl7.org/fhir/ValueSet/endpoint-payload-type From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Endpoint	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Endpoint	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Endpoint	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Endpoint	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Endpoint	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Endpoint

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Endpoint			Endpoint
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:resource-origin		0..*	Reference(KT2_Device)	Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin
connectionType		1..1	Coding	Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint connection type ValueSet (extensible) Fixed Value: As shown (HTI Smart on FHIR)
system		1..1	uri	Identity of the terminology system Fixed Value: http://vzvz.nl/fhir/CodeSystem/koppeltaal-endpoint-connection-type
code		1..1	code	Symbol in syntax defined by the system Fixed Value: hti-smart-on-fhir
managingOrganization		0..1	Reference(KT2_Organization)	Organization that manages this endpoint (might not be the organization that exposes the endpoint)
contact		0..0
period		0..0
payloadType		1..*	CodeableConcept	The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Fixed Value: As shown (Any)
coding		1..1	Coding	Code defined by a terminology system Fixed Value: (Complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/endpoint-payload-type
code		1..1	code	Symbol in syntax defined by the system Fixed Value: any
payloadMimeType		0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
Endpoint.connectionType	extensible	Fixed Value: hti-smart-on-fhir http://vzvz.nl/fhir/ValueSet/endpoint-connection-type From this IG

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Endpoint		0..*	Endpoint	The technical details of an endpoint that can be used for electronic services
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:resource-origin		0..*	Reference(KT2_Device)	Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Identifies this endpoint across multiple systems
status	?!Σ	1..1	code	active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint.
connectionType	Σ	1..1	Coding	Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint connection type ValueSet (extensible) Fixed Value: As shown (HTI Smart on FHIR)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://vzvz.nl/fhir/CodeSystem/koppeltaal-endpoint-connection-type
version		0..0	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: hti-smart-on-fhir
display		0..0	string	Representation defined by the system
userSelected		0..0	boolean	If this coding was chosen directly by the user
name	Σ	0..1	string	A name that this endpoint can be identified by
managingOrganization	Σ	0..1	Reference(KT2_Organization)	Organization that manages this endpoint (might not be the organization that exposes the endpoint)
payloadType	Σ	1..*	CodeableConcept	The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: EndpointPayloadType (example) Fixed Value: As shown (Any)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
coding		1..1	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/endpoint-payload-type
version		0..0	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: any
display		0..0	string	Representation defined by the system
userSelected		0..0	boolean	If this coding was chosen directly by the user
text		0..0	string	Plain text representation of the concept
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

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Endpoint.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Endpoint.status	required	EndpointStatus http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1 From the FHIR Standard
Endpoint.connectionType	extensible	Fixed Value: hti-smart-on-fhir http://vzvz.nl/fhir/ValueSet/endpoint-connection-type From this IG
Endpoint.payloadType	example	Fixed Value: any http://hl7.org/fhir/ValueSet/endpoint-payload-type From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Endpoint	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Endpoint	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Endpoint	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Endpoint	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Endpoint	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Endpoint

Summary

Fixed: 2 elements
Prohibited: 3 elements

Structures

This structure refers to these other structures:

• KT2_Organization (http://koppeltaal.nl/fhir/StructureDefinition/KT2Organization)

Extensions

This structure refers to these extensions:

• http://koppeltaal.nl/fhir/StructureDefinition/resource-origin

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Endpoint		0..*	Endpoint	The technical details of an endpoint that can be used for electronic services
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:resource-origin		0..*	Reference(KT2_Device)	Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint.
connectionType	Σ	1..1	Coding	Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint connection type ValueSet (extensible) Fixed Value: As shown (HTI Smart on FHIR)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://vzvz.nl/fhir/CodeSystem/koppeltaal-endpoint-connection-type
version		0..0	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: hti-smart-on-fhir
display		0..0	string	Representation defined by the system
userSelected		0..0	boolean	If this coding was chosen directly by the user
managingOrganization	Σ	0..1	Reference(KT2_Organization)	Organization that manages this endpoint (might not be the organization that exposes the endpoint)
payloadType	Σ	1..*	CodeableConcept	The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: EndpointPayloadType (example) Fixed Value: As shown (Any)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
coding		1..1	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/endpoint-payload-type
version		0..0	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: any
display		0..0	string	Representation defined by the system
userSelected		0..0	boolean	If this coding was chosen directly by the user
text		0..0	string	Plain text representation of the concept
address	Σ	1..1	url	The technical base address for connecting to this endpoint
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Endpoint.status	required	EndpointStatus http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1 From the FHIR Standard
Endpoint.connectionType	extensible	Fixed Value: hti-smart-on-fhir http://vzvz.nl/fhir/ValueSet/endpoint-connection-type From this IG
Endpoint.payloadType	example	Fixed Value: any http://hl7.org/fhir/ValueSet/endpoint-payload-type From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Endpoint	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Endpoint	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Endpoint	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Endpoint	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Endpoint	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Differential View

This structure is derived from Endpoint

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Endpoint			Endpoint
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:resource-origin		0..*	Reference(KT2_Device)	Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin
connectionType		1..1	Coding	Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint connection type ValueSet (extensible) Fixed Value: As shown (HTI Smart on FHIR)
system		1..1	uri	Identity of the terminology system Fixed Value: http://vzvz.nl/fhir/CodeSystem/koppeltaal-endpoint-connection-type
code		1..1	code	Symbol in syntax defined by the system Fixed Value: hti-smart-on-fhir
managingOrganization		0..1	Reference(KT2_Organization)	Organization that manages this endpoint (might not be the organization that exposes the endpoint)
contact		0..0
period		0..0
payloadType		1..*	CodeableConcept	The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Fixed Value: As shown (Any)
coding		1..1	Coding	Code defined by a terminology system Fixed Value: (Complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/endpoint-payload-type
code		1..1	code	Symbol in syntax defined by the system Fixed Value: any
payloadMimeType		0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
Endpoint.connectionType	extensible	Fixed Value: hti-smart-on-fhir http://vzvz.nl/fhir/ValueSet/endpoint-connection-type From this IG

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Endpoint		0..*	Endpoint	The technical details of an endpoint that can be used for electronic services
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:resource-origin		0..*	Reference(KT2_Device)	Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Identifies this endpoint across multiple systems
status	?!Σ	1..1	code	active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint.
connectionType	Σ	1..1	Coding	Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint connection type ValueSet (extensible) Fixed Value: As shown (HTI Smart on FHIR)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://vzvz.nl/fhir/CodeSystem/koppeltaal-endpoint-connection-type
version		0..0	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: hti-smart-on-fhir
display		0..0	string	Representation defined by the system
userSelected		0..0	boolean	If this coding was chosen directly by the user
name	Σ	0..1	string	A name that this endpoint can be identified by
managingOrganization	Σ	0..1	Reference(KT2_Organization)	Organization that manages this endpoint (might not be the organization that exposes the endpoint)
payloadType	Σ	1..*	CodeableConcept	The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: EndpointPayloadType (example) Fixed Value: As shown (Any)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
coding		1..1	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/endpoint-payload-type
version		0..0	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: any
display		0..0	string	Representation defined by the system
userSelected		0..0	boolean	If this coding was chosen directly by the user
text		0..0	string	Plain text representation of the concept
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

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Endpoint.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Endpoint.status	required	EndpointStatus http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1 From the FHIR Standard
Endpoint.connectionType	extensible	Fixed Value: hti-smart-on-fhir http://vzvz.nl/fhir/ValueSet/endpoint-connection-type From this IG
Endpoint.payloadType	example	Fixed Value: any http://hl7.org/fhir/ValueSet/endpoint-payload-type From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Endpoint	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Endpoint	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Endpoint	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Endpoint	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Endpoint	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Endpoint

Summary

Fixed: 2 elements
Prohibited: 3 elements

Structures

This structure refers to these other structures:

• KT2_Organization (http://koppeltaal.nl/fhir/StructureDefinition/KT2Organization)

Extensions

This structure refers to these extensions:

• http://koppeltaal.nl/fhir/StructureDefinition/resource-origin

Other representations of profile: CSV, Excel, Schematron