HL7 Europe Imaging Study Report, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 0.1.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/oijauregui/ehdsimaging/tree/master and changes regularly. See the Directory of published versions
Official URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/EndpointEu | Version: 0.1.0-ballot | |||
Standards status: Draft | Maturity Level: 1 | Computable Name: EndpointEu | ||
Copyright/Legal: Used by permission of HL7 Europe, all rights reserved Creative Commons License |
The FHIR endpoint resource with EU specific references.
Usages:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Endpoint | The technical details of an endpoint that can be used for electronic services | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
?!Σ | 1..1 | code | active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint. |
![]() ![]() ![]() |
Σ | 1..* | CodeableConcept | Protocol/Profile/Standard to be used with this endpoint connection Binding: EndpointConnectionType (example) |
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization (EU base)) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) |
![]() ![]() ![]() |
Σ | 1..1 | url | The technical base address for connecting to this endpoint |
![]() |
Path | Conformance | ValueSet | URI |
Endpoint.status | required | EndpointStatushttp://hl7.org/fhir/ValueSet/endpoint-status|5.0.0 From the FHIR Standard | |
Endpoint.connectionType | example | EndpointConnectionTypehttp://hl7.org/fhir/ValueSet/endpoint-connection-type From 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Endpoint | The technical details of an endpoint that can be used for electronic services | |
![]() ![]() ![]() |
0..1 | Reference(Organization (EU base)) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) | |
![]() |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | Endpoint | The technical details of an endpoint that can be used for electronic services | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | Identifies this endpoint across multiple systems | ||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint. | ||||
![]() ![]() ![]() |
Σ | 1..* | CodeableConcept | Protocol/Profile/Standard to be used with this endpoint connection Binding: EndpointConnectionType (example) | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | A name that this endpoint can be identified by | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Additional details about the endpoint that could be displayed as further information to identify the description beyond its name | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | The type of environment(s) exposed at this endpoint Binding: EndpointEnvironment (extensible) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization (EU base)) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) | ||||
![]() ![]() ![]() |
0..* | ContactPoint | Contact details for source (e.g. troubleshooting) | |||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Interval the endpoint is expected to be operational | ||||
![]() ![]() ![]() |
0..* | BackboneElement | Set of payloads that are provided by this endpoint | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: EndpointPayloadType (example) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | code | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) | ||||
![]() ![]() ![]() |
Σ | 1..1 | url | The technical base address for connecting to this endpoint | ||||
![]() ![]() ![]() |
0..* | string | Usage depends on the channel type | |||||
![]() |
Path | Conformance | ValueSet | URI |
Endpoint.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 From the FHIR Standard | |
Endpoint.status | required | EndpointStatushttp://hl7.org/fhir/ValueSet/endpoint-status|5.0.0 From the FHIR Standard | |
Endpoint.connectionType | example | EndpointConnectionTypehttp://hl7.org/fhir/ValueSet/endpoint-connection-type From the FHIR Standard | |
Endpoint.environmentType | extensible | EndpointEnvironmenthttp://hl7.org/fhir/ValueSet/endpoint-environment From the FHIR Standard | |
Endpoint.payload.type | example | EndpointPayloadTypehttp://hl7.org/fhir/ValueSet/endpoint-payload-type From the FHIR Standard | |
Endpoint.payload.mimeType | required | MimeTypes(a valid code from urn:ietf:bcp:13 )http://hl7.org/fhir/ValueSet/mimetypes|5.0.0 From 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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() |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Endpoint | The technical details of an endpoint that can be used for electronic services | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
?!Σ | 1..1 | code | active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint. |
![]() ![]() ![]() |
Σ | 1..* | CodeableConcept | Protocol/Profile/Standard to be used with this endpoint connection Binding: EndpointConnectionType (example) |
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization (EU base)) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) |
![]() ![]() ![]() |
Σ | 1..1 | url | The technical base address for connecting to this endpoint |
![]() |
Path | Conformance | ValueSet | URI |
Endpoint.status | required | EndpointStatushttp://hl7.org/fhir/ValueSet/endpoint-status|5.0.0 From the FHIR Standard | |
Endpoint.connectionType | example | EndpointConnectionTypehttp://hl7.org/fhir/ValueSet/endpoint-connection-type From 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Endpoint | The technical details of an endpoint that can be used for electronic services | |
![]() ![]() ![]() |
0..1 | Reference(Organization (EU base)) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) | |
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | Endpoint | The technical details of an endpoint that can be used for electronic services | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | Identifies this endpoint across multiple systems | ||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint. | ||||
![]() ![]() ![]() |
Σ | 1..* | CodeableConcept | Protocol/Profile/Standard to be used with this endpoint connection Binding: EndpointConnectionType (example) | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | A name that this endpoint can be identified by | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Additional details about the endpoint that could be displayed as further information to identify the description beyond its name | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | The type of environment(s) exposed at this endpoint Binding: EndpointEnvironment (extensible) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization (EU base)) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) | ||||
![]() ![]() ![]() |
0..* | ContactPoint | Contact details for source (e.g. troubleshooting) | |||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Interval the endpoint is expected to be operational | ||||
![]() ![]() ![]() |
0..* | BackboneElement | Set of payloads that are provided by this endpoint | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: EndpointPayloadType (example) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | code | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) | ||||
![]() ![]() ![]() |
Σ | 1..1 | url | The technical base address for connecting to this endpoint | ||||
![]() ![]() ![]() |
0..* | string | Usage depends on the channel type | |||||
![]() |
Path | Conformance | ValueSet | URI |
Endpoint.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 From the FHIR Standard | |
Endpoint.status | required | EndpointStatushttp://hl7.org/fhir/ValueSet/endpoint-status|5.0.0 From the FHIR Standard | |
Endpoint.connectionType | example | EndpointConnectionTypehttp://hl7.org/fhir/ValueSet/endpoint-connection-type From the FHIR Standard | |
Endpoint.environmentType | extensible | EndpointEnvironmenthttp://hl7.org/fhir/ValueSet/endpoint-environment From the FHIR Standard | |
Endpoint.payload.type | example | EndpointPayloadTypehttp://hl7.org/fhir/ValueSet/endpoint-payload-type From the FHIR Standard | |
Endpoint.payload.mimeType | required | MimeTypes(a valid code from urn:ietf:bcp:13 )http://hl7.org/fhir/ValueSet/mimetypes|5.0.0 From 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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() |
Other representations of profile: CSV, Excel, Schematron