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: Viewer endpoint

Official URL: http://hl7.eu/fhir/imaging/StructureDefinition/im-viewer-endpoint Version: 0.1.0
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.

This represents a viewer supporting that can be launched to access imaging data.

References to this resource are typically added to an resource. When it appears on ImagingStudy.endpoint it signals that the study can be viewed using the viewer. When it appears on ImagingStudy.serie.endpoint, it signals that the serie can be viewed using the viewer.

defines the query parameters in Table 4.106.4.1.2-2. These parameters are populated according to the following guidelines.

The use case in which this viewer is used maps more naturally on launching the viewer using study-based viewing, in which case the AccessionNumber or StudyInstanceUID is used to identify the study to be viewed. Note that IID does not allow direct viewing of series. In the case it is present on ImagingStudy.series.endpoint, it signals that at least the serie it is on can be viewed using the viewer.

A example launch URL for study-based viewing is:

http://<location>/IHEInvokeImageDisplay?requestType=STUDY&studyUID=1.2.840.113883.19.110.4,1.2.840.113883.19.110.5&viewerType=IHE_BIR&diagnosticQuality=true

The viewer can also be used for patient-based viewing. This requires passing an identification of the patient as a HL7v2 CX field. The patient is identified by its identifiers, the mapping of the identifiers to Hl7v2 CX is defined in HL7v2-to-FHIR CX. The identifier.system maps on CX.4 and identifier.value on CX.1.

An example of a launch URL for patient-based viewing is:

http://<location>/IHEInvokeImageDisplay?requestType=PATIENT&patientID=99998410^^^AcmeHospital&mostRecentResults=1

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:iid 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://hl7.eu/fhir/imaging/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
... 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
... payload S 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
..... text Σ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
Required Pattern: IHE IID
.... Slices for mimeType SΣ 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: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)


ele-1: All FHIR elements must have a @value or children
..... 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
... address SΣ 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:iidexamplePattern: ihe-iid("IHE IID endpoint")
http://hl7.org/fhir/ValueSet/endpoint-connection-type
from the FHIR Standard
Endpoint.payload.typeexampleEndpointPayloadType
http://hl7.org/fhir/ValueSet/endpoint-payload-type
from the FHIR Standard
Endpoint.payload.mimeTyperequiredMimeTypes (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|5.0.0
from the FHIR Standard
Endpoint.payload.mimeType:text-htmlrequiredPattern: text/html
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