HL7 Europe Imaging Study Report
0.1.0-ballot - ci-build 150

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

Resource Profile: IM Image Viewer Endpoint

Official URL: http://hl7.eu/fhir/imaging-r4/StructureDefinition/ImImageIidViewerEndpoint Version: 0.1.0-ballot
Standards status: Draft Maturity Level: 1 Computable Name: ImImageIidViewerEndpoint

Copyright/Legal: Used by permission of HL7 Europe, all rights reserved Creative Commons License

This profile defines a placeholder for an Endpoint for a viewer that can be used to access the study, serie it is present on. The application is based on IHE-IID.

Usages:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Endpoint 0..* EndpointEu 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
... 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.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.eu/fhir/imaging-r4/CodeSystem/codesystem-endpoint-terminology
.... version 0..1 string Version of the system - if relevant
.... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ihe-iid
.... display 1..1 string Representation defined by the system
Fixed Value: IHE IID endpoint
.... userSelected 0..1 boolean If this coding was chosen directly by the user
... payloadType Σ 1..1 CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: EndpointPayloadType (example)
.... text Σ 0..1 string Plain text representation of the concept
Required Pattern: IHE IID
... Slices for payloadMimeType Σ 1..* code Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Slice: Unordered, Open by value:$this
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
.... payloadMimeType:text-html Σ 1..1 code Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.

Required Pattern: text/html
... address Σ 1..1 url The technical base address for connecting to this endpoint

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Endpoint.statusrequiredEndpointStatus
http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1
From the FHIR Standard
Endpoint.connectionTypeextensiblePattern Value: ihe-iid("IHE IID endpoint")
http://hl7.org/fhir/ValueSet/endpoint-connection-type
From the FHIR Standard
Endpoint.payloadTypeexampleEndpointPayloadType
http://hl7.org/fhir/ValueSet/endpoint-payload-type
From the FHIR Standard
Endpoint.payloadMimeTyperequiredMime Types(a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
From the FHIR Standard
Endpoint.payloadMimeType:text-htmlrequiredPattern Value: text/html
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEndpointIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEndpointIf 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-4errorEndpointIf 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-5errorEndpointIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEndpointA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from EndpointEu

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Endpoint EndpointEu
... connectionType 1..1 Coding Protocol/Profile/Standard to be used with this endpoint connection
Required Pattern: At least the following
.... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.eu/fhir/imaging-r4/CodeSystem/codesystem-endpoint-terminology
.... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ihe-iid
.... display 1..1 string Representation defined by the system
Fixed Value: IHE IID endpoint
... payloadType 1..1 CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
.... text 0..1 string Plain text representation of the concept
Required Pattern: IHE IID
... Slices for payloadMimeType 1..* code Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Slice: Unordered, Open by value:$this
.... payloadMimeType:text-html 1..1 code Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Required Pattern: text/html

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Endpoint 0..* EndpointEu 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
... 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
... extension 0..* Extension Additional content defined by implementations
... 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: EndpointConnectionType (extensible)
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.eu/fhir/imaging-r4/CodeSystem/codesystem-endpoint-terminology
.... version 0..1 string Version of the system - if relevant
.... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ihe-iid
.... display 1..1 string Representation defined by the system
Fixed Value: IHE IID endpoint
.... userSelected 0..1 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(Organization (EU base)) 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..1 CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: EndpointPayloadType (example)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
Required Pattern: IHE IID
... Slices for payloadMimeType Σ 1..* code Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Slice: Unordered, Open by value:$this
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
.... payloadMimeType:text-html Σ 1..1 code Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.

Required Pattern: text/html
... address Σ 1..1 url The technical base address for connecting to this endpoint
... header 0..* string Usage depends on the channel type

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Endpoint.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Endpoint.statusrequiredEndpointStatus
http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1
From the FHIR Standard
Endpoint.connectionTypeextensiblePattern Value: ihe-iid("IHE IID endpoint")
http://hl7.org/fhir/ValueSet/endpoint-connection-type
From the FHIR Standard
Endpoint.payloadTypeexampleEndpointPayloadType
http://hl7.org/fhir/ValueSet/endpoint-payload-type
From the FHIR Standard
Endpoint.payloadMimeTyperequiredMime Types(a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
From the FHIR Standard
Endpoint.payloadMimeType:text-htmlrequiredPattern Value: text/html
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEndpointIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEndpointIf 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-4errorEndpointIf 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-5errorEndpointIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEndpointA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from EndpointEu

Summary

Mandatory: 2 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Endpoint.payloadMimeType

Maturity: 1

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Endpoint 0..* EndpointEu 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
... 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.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.eu/fhir/imaging-r4/CodeSystem/codesystem-endpoint-terminology
.... version 0..1 string Version of the system - if relevant
.... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ihe-iid
.... display 1..1 string Representation defined by the system
Fixed Value: IHE IID endpoint
.... userSelected 0..1 boolean If this coding was chosen directly by the user
... payloadType Σ 1..1 CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: EndpointPayloadType (example)
.... text Σ 0..1 string Plain text representation of the concept
Required Pattern: IHE IID
... Slices for payloadMimeType Σ 1..* code Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Slice: Unordered, Open by value:$this
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
.... payloadMimeType:text-html Σ 1..1 code Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.

Required Pattern: text/html
... address Σ 1..1 url The technical base address for connecting to this endpoint

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Endpoint.statusrequiredEndpointStatus
http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1
From the FHIR Standard
Endpoint.connectionTypeextensiblePattern Value: ihe-iid("IHE IID endpoint")
http://hl7.org/fhir/ValueSet/endpoint-connection-type
From the FHIR Standard
Endpoint.payloadTypeexampleEndpointPayloadType
http://hl7.org/fhir/ValueSet/endpoint-payload-type
From the FHIR Standard
Endpoint.payloadMimeTyperequiredMime Types(a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
From the FHIR Standard
Endpoint.payloadMimeType:text-htmlrequiredPattern Value: text/html
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEndpointIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEndpointIf 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-4errorEndpointIf 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-5errorEndpointIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEndpointA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from EndpointEu

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Endpoint EndpointEu
... connectionType 1..1 Coding Protocol/Profile/Standard to be used with this endpoint connection
Required Pattern: At least the following
.... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.eu/fhir/imaging-r4/CodeSystem/codesystem-endpoint-terminology
.... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ihe-iid
.... display 1..1 string Representation defined by the system
Fixed Value: IHE IID endpoint
... payloadType 1..1 CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
.... text 0..1 string Plain text representation of the concept
Required Pattern: IHE IID
... Slices for payloadMimeType 1..* code Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Slice: Unordered, Open by value:$this
.... payloadMimeType:text-html 1..1 code Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Required Pattern: text/html

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Endpoint 0..* EndpointEu 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
... 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
... extension 0..* Extension Additional content defined by implementations
... 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: EndpointConnectionType (extensible)
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.eu/fhir/imaging-r4/CodeSystem/codesystem-endpoint-terminology
.... version 0..1 string Version of the system - if relevant
.... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ihe-iid
.... display 1..1 string Representation defined by the system
Fixed Value: IHE IID endpoint
.... userSelected 0..1 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(Organization (EU base)) 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..1 CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: EndpointPayloadType (example)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
Required Pattern: IHE IID
... Slices for payloadMimeType Σ 1..* code Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Slice: Unordered, Open by value:$this
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
.... payloadMimeType:text-html Σ 1..1 code Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.

Required Pattern: text/html
... address Σ 1..1 url The technical base address for connecting to this endpoint
... header 0..* string Usage depends on the channel type

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Endpoint.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Endpoint.statusrequiredEndpointStatus
http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1
From the FHIR Standard
Endpoint.connectionTypeextensiblePattern Value: ihe-iid("IHE IID endpoint")
http://hl7.org/fhir/ValueSet/endpoint-connection-type
From the FHIR Standard
Endpoint.payloadTypeexampleEndpointPayloadType
http://hl7.org/fhir/ValueSet/endpoint-payload-type
From the FHIR Standard
Endpoint.payloadMimeTyperequiredMime Types(a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
From the FHIR Standard
Endpoint.payloadMimeType:text-htmlrequiredPattern Value: text/html
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEndpointIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEndpointIf 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-4errorEndpointIf 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-5errorEndpointIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEndpointA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from EndpointEu

Summary

Mandatory: 2 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Endpoint.payloadMimeType

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron