EU MADO Web Viewer Endpoint - EU Imaging Manifest and Access (IHE-MADO additions) v1.0.0-ballot

This page is part of the EU Manifest-based Access to DICOM Objects (EU-MADO) (v1.0.0-ballot: STU 1 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: EU MADO Web Viewer Endpoint

Official URL: http://hl7.eu/fhir/imaging-manifest/StructureDefinition/EuMadoWebViewerEndpoint	Version: 1.0.0-ballot	Highlight text changes?
Standards status: Draft	Maturity Level: 1	Computable Name: EuMadoWebViewerEndpoint
Copyright/Legal: Copyright HL7 Europe. Licensed under Creative Commons public domain (CC0 1.0).

This profile refines the MadoWebViewerEndpoint with EU specific elements for the MADO EU FHIR Imaging Study Manifest. It represents the web viewer endpoint in compliance with the MADO specifications.

Usages:

Use this Profile: MADO EU FHIR Imaging Study Manifest Bundle
Refer to this Profile: MADO EU Imaging Study
Examples for this Profile: Endpoint/endpoint-webviewer

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

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

Description & Constraints Filter:

Endpoint 0..* MadoWebViewerEndpoint The technical details of an endpoint that can be used for electronic services

Endpoint.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created

Endpoint.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored

connectionType

1..1

Coding

Protocol/Profile/Standard to be used with this endpoint connection
Binding: EndpointConnectionType (extensible)
Required Pattern:

{
  "system" : "https://profiles.ihe.net/RAD/MADO/CodeSystem/MadoEndpointConnectionTypes",
  "code" : "web-viewer"
}

Endpoint.Slices for payloadType This element is included in summaries. 1..* CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Slice: Unordered, Open by value:coding.code, value:coding.system
Binding: EndpointPayloadType (example)

Endpoint.Slices for payloadType.payloadType:type-none This element is included in summaries. 1..1 CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: EndpointPayloadType (example)

Endpoint.Slices for payloadType.payloadType:type-none.Slices for coding This element is included in summaries. 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:code, value:system

Endpoint.Slices for payloadType.payloadType:type-none.Slices for coding Content/Rules for all slices

Endpoint.Slices for payloadType.payloadType:type-none.Slices for coding.coding:none This element is included in summaries. 1..1 Coding Code defined by a terminology system

Endpoint.Slices for payloadType.payloadType:type-none.Slices for coding.coding:none.system This element is included in summaries. 0..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/endpoint-payload-type (no extensions allowed)

Endpoint.Slices for payloadType.payloadType:type-none.Slices for coding.coding:none.code This element is included in summaries. 0..1 code Symbol in syntax defined by the system
Fixed Value: none (no extensions allowed)

Endpoint.Slices for payloadMimeType This element is included in summaries. 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.

Endpoint.Slices for payloadMimeType.payloadMimeType:html This element is included in summaries. 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 (extensions allowed)

address

1..1

url

The technical base address for connecting to this endpoint

Obligations

Actor

SHALL:populate

Content Creator/Document Source (Imaging Manifest)

Documentation for this format

Name	Content Creator/Document Source (Imaging Manifest)
Endpoint
Endpoint / Slices for payloadType
Endpoint / Slices for payloadMimeType
Endpoint / address	SHALL:populate
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Endpoint.status	Base	required	EndpointStatus	📍4.0.1	FHIR Std.
Endpoint.connectionType	Base	extensible	Endpoint Connection Type	📍4.0.1	FHIR Std.
Endpoint.payloadType	Base	example	Endpoint Payload Type	📍4.0.1	FHIR Std.
Endpoint.payloadType:type-none	Base	example	Endpoint Payload Type	📍4.0.1	FHIR Std.
Endpoint.payloadMimeType	Base	required	MimeType	📍4.0.1	FHIR Std.
Endpoint.payloadMimeType:html	Base	required	MimeType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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 MadoWebViewerEndpoint

Description & Constraints Filter:

Endpoint

MadoWebViewerEndpoint

address

1..1

url

The technical base address for connecting to this endpoint

Obligations

Actor

SHALL:populate

Content Creator/Document Source (Imaging Manifest)

Documentation for this format

Name	Content Creator/Document Source (Imaging Manifest)
Endpoint
Endpoint / address	SHALL:populate
Documentation for this format

Description & Constraints Filter:

Endpoint 0..* MadoWebViewerEndpoint The technical details of an endpoint that can be used for electronic services

Endpoint.id This element is included in summaries. 0..1 id Logical id of this artifact

Endpoint.meta This element is included in summaries. 0..1 Meta Metadata about the resource

Endpoint.implicitRules This element is a modifier element. This element is included in summaries. 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

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

Endpoint.contained 0..* Resource Contained, inline Resources

Endpoint.extension 0..* Extension Additional content defined by implementations

Endpoint.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored

Endpoint.identifier This element is included in summaries. 0..* Identifier Identifies this endpoint across multiple systems

connectionType

1..1

Coding

Protocol/Profile/Standard to be used with this endpoint connection
Binding: EndpointConnectionType (extensible)
Required Pattern:

{
  "system" : "https://profiles.ihe.net/RAD/MADO/CodeSystem/MadoEndpointConnectionTypes",
  "code" : "web-viewer"
}

Endpoint.name This element is included in summaries. 0..1 string A name that this endpoint can be identified by

Endpoint.managingOrganization This element is included in summaries. 0..1 Reference(Organization) Organization that manages this endpoint (might not be the organization that exposes the endpoint)

Endpoint.contact 0..* ContactPoint Contact details for source (e.g. troubleshooting)

Endpoint.period This element is included in summaries. 0..1 Period Interval the endpoint is expected to be operational

Endpoint.Slices for payloadType.payloadType:type-none.id 0..1 string Unique id for inter-element referencing

Endpoint.Slices for payloadType.payloadType:type-none.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url

Endpoint.Slices for payloadType.payloadType:type-none.Slices for coding Content/Rules for all slices

Endpoint.Slices for payloadType.payloadType:type-none.Slices for coding.coding:none This element is included in summaries. 1..1 Coding Code defined by a terminology system

Endpoint.Slices for payloadType.payloadType:type-none.Slices for coding.coding:none.id 0..1 string Unique id for inter-element referencing

Endpoint.Slices for payloadType.payloadType:type-none.Slices for coding.coding:none.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url

Endpoint.Slices for payloadType.payloadType:type-none.Slices for coding.coding:none.version This element is included in summaries. 0..1 string Version of the system - if relevant

Endpoint.Slices for payloadType.payloadType:type-none.Slices for coding.coding:none.display This element is included in summaries. 0..1 string Representation defined by the system

Endpoint.Slices for payloadType.payloadType:type-none.Slices for coding.coding:none.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user

Endpoint.Slices for payloadType.payloadType:type-none.text This element is included in summaries. 0..1 string Plain text representation of the concept

address

1..1

url

The technical base address for connecting to this endpoint

Obligations

Actor

SHALL:populate

Content Creator/Document Source (Imaging Manifest)

Endpoint.header 0..* string Usage depends on the channel type

Documentation for this format

Name	Content Creator/Document Source (Imaging Manifest)
Endpoint
Endpoint / Slices for payloadType
Endpoint / Slices for payloadMimeType
Endpoint / address	SHALL:populate
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Endpoint.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Endpoint.status	Base	required	EndpointStatus	📍4.0.1	FHIR Std.
Endpoint.connectionType	Base	extensible	Endpoint Connection Type	📍4.0.1	FHIR Std.
Endpoint.payloadType	Base	example	Endpoint Payload Type	📍4.0.1	FHIR Std.
Endpoint.payloadType:type-none	Base	example	Endpoint Payload Type	📍4.0.1	FHIR Std.
Endpoint.payloadMimeType	Base	required	MimeType	📍4.0.1	FHIR Std.
Endpoint.payloadMimeType:html	Base	required	MimeType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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()`

Name	Content Creator/Document Source (Imaging Manifest)
Endpoint
Endpoint / Slices for payloadType
Endpoint / Slices for payloadMimeType
Endpoint / address	SHALL:populate
Documentation for this format

This structure is derived from MadoWebViewerEndpoint

Summary

Maturity: 1

Key Elements View

Description & Constraints Filter:

Endpoint 0..* MadoWebViewerEndpoint The technical details of an endpoint that can be used for electronic services

Endpoint.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created

Endpoint.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored

connectionType

1..1

Coding

Protocol/Profile/Standard to be used with this endpoint connection
Binding: EndpointConnectionType (extensible)
Required Pattern:

{
  "system" : "https://profiles.ihe.net/RAD/MADO/CodeSystem/MadoEndpointConnectionTypes",
  "code" : "web-viewer"
}

Endpoint.Slices for payloadType.payloadType:type-none.Slices for coding Content/Rules for all slices

Endpoint.Slices for payloadType.payloadType:type-none.Slices for coding.coding:none This element is included in summaries. 1..1 Coding Code defined by a terminology system

address

1..1

url

The technical base address for connecting to this endpoint

Obligations

Actor

SHALL:populate

Content Creator/Document Source (Imaging Manifest)

Documentation for this format

Name	Content Creator/Document Source (Imaging Manifest)
Endpoint
Endpoint / Slices for payloadType
Endpoint / Slices for payloadMimeType
Endpoint / address	SHALL:populate
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Endpoint.status	Base	required	EndpointStatus	📍4.0.1	FHIR Std.
Endpoint.connectionType	Base	extensible	Endpoint Connection Type	📍4.0.1	FHIR Std.
Endpoint.payloadType	Base	example	Endpoint Payload Type	📍4.0.1	FHIR Std.
Endpoint.payloadType:type-none	Base	example	Endpoint Payload Type	📍4.0.1	FHIR Std.
Endpoint.payloadMimeType	Base	required	MimeType	📍4.0.1	FHIR Std.
Endpoint.payloadMimeType:html	Base	required	MimeType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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 MadoWebViewerEndpoint

Description & Constraints Filter:

Endpoint

MadoWebViewerEndpoint

address

1..1

url

The technical base address for connecting to this endpoint

Obligations

Actor

SHALL:populate

Content Creator/Document Source (Imaging Manifest)

Documentation for this format

Name	Content Creator/Document Source (Imaging Manifest)
Endpoint
Endpoint / address	SHALL:populate
Documentation for this format

Snapshot ViewView

Description & Constraints Filter:

Endpoint 0..* MadoWebViewerEndpoint The technical details of an endpoint that can be used for electronic services

Endpoint.id This element is included in summaries. 0..1 id Logical id of this artifact

Endpoint.meta This element is included in summaries. 0..1 Meta Metadata about the resource

Endpoint.implicitRules This element is a modifier element. This element is included in summaries. 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

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

Endpoint.contained 0..* Resource Contained, inline Resources

Endpoint.extension 0..* Extension Additional content defined by implementations

Endpoint.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored

Endpoint.identifier This element is included in summaries. 0..* Identifier Identifies this endpoint across multiple systems

connectionType

1..1

Coding

Protocol/Profile/Standard to be used with this endpoint connection
Binding: EndpointConnectionType (extensible)
Required Pattern:

{
  "system" : "https://profiles.ihe.net/RAD/MADO/CodeSystem/MadoEndpointConnectionTypes",
  "code" : "web-viewer"
}