HL7 Europe Imaging Study Report
0.1.0 - 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 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/imaging/ and changes regularly. See the Directory of published versions

Resource Profile: WADO endpoint

Official URL: http://hl7.eu/fhir/imaging/StructureDefinition/im-wado-endpoint Version: 0.1.0
Standards status: Draft Maturity Level: 1 Computable Name: ImWadoEndpoint

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

This profile defines the WADO endpoint for accessing imaging study content.

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..* Endpoint The technical details of an endpoint that can be used for electronic services
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... meta Σ 0..1 Meta Metadata about the resource
ele-1: All FHIR elements must have a @value or children
.... security SΣ 0..* Coding Security Labels applied to this resource
Binding: AllSecurityLabels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


ele-1: All FHIR elements must have a @value or children
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... language S 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter Set

ele-1: All FHIR elements must have a @value or children
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... status ?!SΣ 1..1 code active | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required): The status of the endpoint.


ele-1: All FHIR elements must have a @value or children
... Slices for connectionType Σ 1..* CodeableConcept Protocol/Profile/Standard to be used with this endpoint connection
Slice: Unordered, Open by value:coding
Binding: EndpointConnectionType (example)
ele-1: All FHIR elements must have a @value or children
.... connectionType:wado SΣ 1..1 CodeableConcept Protocol/Profile/Standard to be used with this endpoint connection
Binding: EndpointConnectionType (example)
ele-1: All FHIR elements must have a @value or children

Required Pattern: At least the following
..... coding 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-connection-type
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: dicom-wado-rs
...... display 1..1 string Representation defined by the system
Fixed Value: DICOM WADO-RS
... name SOΣ 0..1 string A name that this endpoint can be identified by
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:populate-if-known IM Producer
... description SΣ 0..1 string Additional details about the endpoint that could be displayed as further information to identify the description beyond its name
ele-1: All FHIR elements must have a @value or children
... managingOrganization SΣ 0..1 Reference(Organization) Organization that manages this endpoint (might not be the organization that exposes the endpoint)
ele-1: All FHIR elements must have a @value or children
... Slices for payload S 1..* BackboneElement Set of payloads that are provided by this endpoint
Slice: Unordered, Open by value:type
ele-1: All FHIR elements must have a @value or children
.... payload:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... payload:wadors S 1..1 BackboneElement Set of payloads that are provided by this endpoint
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type SΣ 1..1 CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: EndpointPayloadType (example)
ele-1: All FHIR elements must have a @value or children

Required Pattern: At least the following
...... coding 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-connection-type
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: dicom-wado-rs
....... display 1..1 string Representation defined by the system
Fixed Value: DICOM WADO-RS
..... Slices for mimeType SΣ 17..* 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: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)


ele-1: All FHIR elements must have a @value or children
...... mimeType:dicom SΣ 1..1 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)


ele-1: All FHIR elements must have a @value or children

Required Pattern: application/dicom
...... mimeType:dicom-octet SΣ 1..1 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)


ele-1: All FHIR elements must have a @value or children

Required Pattern: application/octet-stream
...... mimeType:dicom-xml SΣ 1..1 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)


ele-1: All FHIR elements must have a @value or children

Required Pattern: application/dicom+xml
...... mimeType:dicom-json SΣ 1..1 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)


ele-1: All FHIR elements must have a @value or children

Required Pattern: application/json
...... mimeType:image-jpg SΣ 1..1 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)


ele-1: All FHIR elements must have a @value or children

Required Pattern: image/jpg
...... mimeType:image-gif SΣ 1..1 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)


ele-1: All FHIR elements must have a @value or children

Required Pattern: image/gif
...... mimeType:image-jp2 SΣ 1..1 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)


ele-1: All FHIR elements must have a @value or children

Required Pattern: image/jp2
...... mimeType:image-jph SΣ 1..1 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)


ele-1: All FHIR elements must have a @value or children

Required Pattern: image/jph
...... mimeType:image-jxl SΣ 1..1 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)


ele-1: All FHIR elements must have a @value or children

Required Pattern: image/jxl
...... mimeType:video-mpeg SΣ 1..1 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)


ele-1: All FHIR elements must have a @value or children

Required Pattern: video/mpeg
...... mimeType:video-mp4 SΣ 1..1 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)


ele-1: All FHIR elements must have a @value or children

Required Pattern: video/mp4
...... mimeType:video-H265 SΣ 1..1 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)


ele-1: All FHIR elements must have a @value or children

Required Pattern: video/H265
...... mimeType:text-html SΣ 1..1 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)


ele-1: All FHIR elements must have a @value or children

Required Pattern: text/html
...... mimeType:text-plain SΣ 1..1 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)


ele-1: All FHIR elements must have a @value or children

Required Pattern: text/plain
...... mimeType:text-xml SΣ 1..1 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)


ele-1: All FHIR elements must have a @value or children

Required Pattern: text/xml
...... mimeType:text-rtf SΣ 1..1 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)


ele-1: All FHIR elements must have a @value or children

Required Pattern: text/rtf
...... mimeType:application-pdf SΣ 1..1 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)


ele-1: All FHIR elements must have a @value or children

Required Pattern: application/pdf
... address Σ 1..1 url The technical base address for connecting to this endpoint
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Endpoint.meta.securityextensibleAllSecurityLabels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Endpoint.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
Endpoint.statusrequiredEndpointStatus
http://hl7.org/fhir/ValueSet/endpoint-status|5.0.0
from the FHIR Standard
Endpoint.connectionTypeexampleEndpointConnectionType
http://hl7.org/fhir/ValueSet/endpoint-connection-type
from the FHIR Standard
Endpoint.connectionType:wadoexamplePattern: dicom-wado-rs("DICOM WADO-RS")
http://hl7.org/fhir/ValueSet/endpoint-connection-type
from the FHIR Standard
Endpoint.payload:wadors.typeexamplePattern: dicom-wado-rs("DICOM WADO-RS")
http://hl7.org/fhir/ValueSet/endpoint-payload-type
from the FHIR Standard
Endpoint.payload:wadors.mimeTyperequiredMimeTypes (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|5.0.0
from the FHIR Standard
Endpoint.payload:wadors.mimeType:dicomrequiredPattern: application/dicom
http://hl7.org/fhir/ValueSet/mimetypes|5.0.0
from the FHIR Standard
Endpoint.payload:wadors.mimeType:dicom-octetrequiredPattern: application/octet-stream
http://hl7.org/fhir/ValueSet/mimetypes|5.0.0
from the FHIR Standard
Endpoint.payload:wadors.mimeType:dicom-xmlrequiredPattern: application/dicom+xml
http://hl7.org/fhir/ValueSet/mimetypes|5.0.0
from the FHIR Standard
Endpoint.payload:wadors.mimeType:dicom-jsonrequiredPattern: application/json
http://hl7.org/fhir/ValueSet/mimetypes|5.0.0
from the FHIR Standard
Endpoint.payload:wadors.mimeType:image-jpgrequiredPattern: image/jpg
http://hl7.org/fhir/ValueSet/mimetypes|5.0.0
from the FHIR Standard
Endpoint.payload:wadors.mimeType:image-gifrequiredPattern: image/gif
http://hl7.org/fhir/ValueSet/mimetypes|5.0.0
from the FHIR Standard
Endpoint.payload:wadors.mimeType:image-jp2requiredPattern: image/jp2
http://hl7.org/fhir/ValueSet/mimetypes|5.0.0
from the FHIR Standard
Endpoint.payload:wadors.mimeType:image-jphrequiredPattern: image/jph
http://hl7.org/fhir/ValueSet/mimetypes|5.0.0
from the FHIR Standard
Endpoint.payload:wadors.mimeType:image-jxlrequiredPattern: image/jxl
http://hl7.org/fhir/ValueSet/mimetypes|5.0.0
from the FHIR Standard
Endpoint.payload:wadors.mimeType:video-mpegrequiredPattern: video/mpeg
http://hl7.org/fhir/ValueSet/mimetypes|5.0.0
from the FHIR Standard
Endpoint.payload:wadors.mimeType:video-mp4requiredPattern: video/mp4
http://hl7.org/fhir/ValueSet/mimetypes|5.0.0
from the FHIR Standard
Endpoint.payload:wadors.mimeType:video-H265requiredPattern: video/H265
http://hl7.org/fhir/ValueSet/mimetypes|5.0.0
from the FHIR Standard
Endpoint.payload:wadors.mimeType:text-htmlrequiredPattern: text/html
http://hl7.org/fhir/ValueSet/mimetypes|5.0.0
from the FHIR Standard
Endpoint.payload:wadors.mimeType:text-plainrequiredPattern: text/plain
http://hl7.org/fhir/ValueSet/mimetypes|5.0.0
from the FHIR Standard
Endpoint.payload:wadors.mimeType:text-xmlrequiredPattern: text/xml
http://hl7.org/fhir/ValueSet/mimetypes|5.0.0
from the FHIR Standard
Endpoint.payload:wadors.mimeType:text-rtfrequiredPattern: text/rtf
http://hl7.org/fhir/ValueSet/mimetypes|5.0.0
from the FHIR Standard
Endpoint.payload:wadors.mimeType:application-pdfrequiredPattern: application/pdf
http://hl7.org/fhir/ValueSet/mimetypes|5.0.0
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().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-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()

 

Other representations of profile: CSV, Excel, Schematron