Koppeltaal 2.0 Implementation Guide (Full Documentation)
0.15.0 - ci-build
NL
Koppeltaal 2.0 Implementation Guide (Full Documentation)
0.15.0 - ci-build
NL
Koppeltaal 2.0 Implementation Guide (Full Documentation) - Local Development build (v0.15.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://koppeltaal.nl/fhir/StructureDefinition/KT2Endpoint | Version: 0.15.0 | |||
| Draft as of 2023-08-17 |
Realm: 
|
Computable Name: KT2_Endpoint | ||
Copyright/Legal: VZVZ |
||||
The Endpoint resource represents the technical contact point for an application that provides eHealth services. It defines the network address, connection protocols, and communication parameters necessary for systems to connect and interact with healthcare applications within the Koppeltaal ecosystem.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Endpoint |
0..* | Endpoint | The technical details of an endpoint that can be used for electronic services Constraints: dom-2, dom-3, dom-4, dom-5, dom-6 | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
  Slices for extension |
Content/Rules for all slices | |||
   extension:resource-origin |
0..1 | Reference(KT2_Device) | Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
| 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 |
ΣC | 0..1 | Reference(KT2_Organization) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) Constraints: ref-1 |
| 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 | ||||
| Path | Conformance | ValueSet / Code | URI |
| Endpoint.status | required | EndpointStatushttp://hl7.org/fhir/ValueSet/endpoint-status|4.0.1From the FHIR Standard | |
| Endpoint.connectionType | extensible | Fixed Value: hti-smart-on-fhirhttp://vzvz.nl/fhir/ValueSet/endpoint-connection-typeFrom this IG | |
| Endpoint.payloadType | example | Fixed Value: anyhttp://hl7.org/fhir/ValueSet/endpoint-payload-typeFrom the FHIR Standard |
| 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() | |
| ref-1 | error | Endpoint.managingOrganization | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) |
This structure is derived from Endpoint
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Endpoint |
Endpoint | |||
| Slices for extension |
Content/Rules for all slices | |||
| extension:resource-origin |
0..1 | 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 | ||||
| Path | Conformance | ValueSet / Code | URI |
| Endpoint.connectionType | extensible | Fixed Value: hti-smart-on-fhirhttp://vzvz.nl/fhir/ValueSet/endpoint-connection-typeFrom this IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Endpoint |
0..* | Endpoint | The technical details of an endpoint that can be used for electronic services Constraints: dom-2, dom-3, dom-4, dom-5, dom-6 | |||||
| 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.
| |||||
| 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 | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:resource-origin |
0..1 | Reference(KT2_Device) | Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
| 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 |
ΣC | 0..1 | Reference(KT2_Organization) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) Constraints: ref-1 | ||||
| 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 | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Endpoint.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Endpoint.status | required | EndpointStatushttp://hl7.org/fhir/ValueSet/endpoint-status|4.0.1From the FHIR Standard | ||||
| Endpoint.connectionType | extensible | Fixed Value: hti-smart-on-fhirhttp://vzvz.nl/fhir/ValueSet/endpoint-connection-typeFrom this IG | ||||
| Endpoint.payloadType | example | Fixed Value: anyhttp://hl7.org/fhir/ValueSet/endpoint-payload-typeFrom the FHIR Standard |
| 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() | |
| ref-1 | error | Endpoint.managingOrganization | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) |
This structure is derived from Endpoint
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Endpoint |
0..* | Endpoint | The technical details of an endpoint that can be used for electronic services Constraints: dom-2, dom-3, dom-4, dom-5, dom-6 | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
Content/Rules for all slices | |||
| extension:resource-origin |
0..1 | Reference(KT2_Device) | Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
| 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 |
ΣC | 0..1 | Reference(KT2_Organization) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) Constraints: ref-1 |
| 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 | ||||
| Path | Conformance | ValueSet / Code | URI |
| Endpoint.status | required | EndpointStatushttp://hl7.org/fhir/ValueSet/endpoint-status|4.0.1From the FHIR Standard | |
| Endpoint.connectionType | extensible | Fixed Value: hti-smart-on-fhirhttp://vzvz.nl/fhir/ValueSet/endpoint-connection-typeFrom this IG | |
| Endpoint.payloadType | example | Fixed Value: anyhttp://hl7.org/fhir/ValueSet/endpoint-payload-typeFrom the FHIR Standard |
| 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() | |
| ref-1 | error | Endpoint.managingOrganization | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) |
Differential View
This structure is derived from Endpoint
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Endpoint |
Endpoint | |||
| Slices for extension |
Content/Rules for all slices | |||
| extension:resource-origin |
0..1 | 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 | ||||
| Path | Conformance | ValueSet / Code | URI |
| Endpoint.connectionType | extensible | Fixed Value: hti-smart-on-fhirhttp://vzvz.nl/fhir/ValueSet/endpoint-connection-typeFrom this IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Endpoint |
0..* | Endpoint | The technical details of an endpoint that can be used for electronic services Constraints: dom-2, dom-3, dom-4, dom-5, dom-6 | |||||
| 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.
| |||||
| 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 | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:resource-origin |
0..1 | Reference(KT2_Device) | Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
| 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 |
ΣC | 0..1 | Reference(KT2_Organization) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) Constraints: ref-1 | ||||
| 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 | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Endpoint.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Endpoint.status | required | EndpointStatushttp://hl7.org/fhir/ValueSet/endpoint-status|4.0.1From the FHIR Standard | ||||
| Endpoint.connectionType | extensible | Fixed Value: hti-smart-on-fhirhttp://vzvz.nl/fhir/ValueSet/endpoint-connection-typeFrom this IG | ||||
| Endpoint.payloadType | example | Fixed Value: anyhttp://hl7.org/fhir/ValueSet/endpoint-payload-typeFrom the FHIR Standard |
| 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() | |
| ref-1 | error | Endpoint.managingOrganization | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) |
This structure is derived from Endpoint
Other representations of profile: CSV, Excel, Schematron
The connectionType element is fixed to hti-smart-on-fhir from the Koppeltaal endpoint connection type value set. This indicates that all Koppeltaal endpoints use the HTI (Healthcare Token Interface) with SMART on FHIR for authentication and authorization.
Example:
{
"connectionType": {
"system": "http://koppeltaal.nl/CodeSystem/endpoint-connection-type",
"code": "hti-smart-on-fhir"
}
}
When specified, the managingOrganization element must reference a KT2_Organization resource. This indicates which organization manages this endpoint.
Example:
{
"managingOrganization": {
"reference": "Organization/example-org"
}
}
The payloadType element is fixed to any from the endpoint payload type value set, indicating that the endpoint can handle any type of FHIR resource payload.
Example:
{
"payloadType": [{
"coding": [{
"system": "http://terminology.hl7.org/CodeSystem/endpoint-payload-type",
"code": "any"
}]
}]
}
The address element contains the actual URL where the endpoint can be accessed. This should be a fully qualified HTTPS URL.
Example:
{
"address": "https://example-app.com/fhir/launch"
}
The status element indicates the operational status of the endpoint:
active - Endpoint is available for usesuspended - Endpoint is temporarily unavailableerror - Endpoint is in error stateoff - Endpoint is turned offtest - Endpoint is in test mode