Skip to content

Commit 795a00f

Browse files
committed
Escape liquid tags for IG build
1 parent 2e01082 commit 795a00f

8 files changed

Lines changed: 87 additions & 80 deletions

ig-src/input/pagecontent/design-consideration-composition-diagnosticreport.liquid.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
### FHIR representation of the report
22

3-
This guide is part of the HL7 EU suite of report related implementation guides that also includes {{hl7EuLabs}}, {{hl7EuHdr}} and {{hl7EuEps}}.
3+
This guide is part of the HL7 EU suite of report related implementation guides that also includes {% raw %}{{hl7EuLabs}}{% endraw %}, {% raw %}{{hl7EuHdr}}{% endraw %} and {% raw %}{{hl7EuEps}}{% endraw %}.
44
{% if isR5 %}
55
This implementation guide follows the approach taken by those specifications in that a Imaging Report is:
66
* represented by one `DiagnosticReport` and and `Composition` resource.

ig-src/input/pagecontent/design-consideration-composition-structure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ One of the choices made in the IG is the structure of the Composition resource.
44

55
* Leave it open for users of the implementation guide.
66
* Follow the structure of the presented form (rendered document).
7-
* Follow the structure of the {{ehnImagingGuidelines}}.
7+
* Follow the structure of the {% raw %}{{ehnImagingGuidelines}}{% endraw %}.
88
* Adopt the structure defined in IHE-IDR.
99

1010
Linking the structure of the composition of the presented form will cause difficulties as it requires importers of such documents to understand and properly represent such structure which might place undue burden on such import process.

ig-src/input/pagecontent/design-consideration-healthcareprofessional.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
### Representing Healthcare Professionals
22

3-
When referring to healthcare professionals, the {{ehnImagingGuidelines}} include information on the professional as well as on the organization the professional is associated with (e.g. information recipient, author, resultValidator, etc.). In FHIR a healthcare professional is represented as a `Practitioner`. As a healthcare professional can be employed by multiple organizations, a different resource,`PractitionerRole` models the relationship between the healthcare professional and an organization.
4-
For the representation of healthcare professionals, organizations and the relations between them, this implementation guide uses the profiles defined by {{hl7EuBase}}:
3+
When referring to healthcare professionals, the {% raw %}{{ehnImagingGuidelines}}{% endraw %} include information on the professional as well as on the organization the professional is associated with (e.g. information recipient, author, resultValidator, etc.). In FHIR a healthcare professional is represented as a `Practitioner`. As a healthcare professional can be employed by multiple organizations, a different resource,`PractitionerRole` models the relationship between the healthcare professional and an organization.
4+
For the representation of healthcare professionals, organizations and the relations between them, this implementation guide uses the profiles defined by {% raw %}{{hl7EuBase}}{% endraw %}.:
55

66
```mermaid
77
classDiagram
Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
### Representation of Key Images
2+
3+
Key images can be represented in two ways:
4+
{% if isR5 %}
5+
* ImagingSelection
6+
* DocumentReference
7+
{% endif %}
8+
{% if isR4 %}
9+
* ImagingSelection (Implemented in this R4 IG by the [ImagingSelectionEuImaging](StructureDefinition-ImagingSelectionEuImaging.html) profile on top of a `Basic` resource with a cross-version extension backporting the R5 ImagingSelection structure)
10+
* DocumentReference
11+
{% endif %}
12+
ImagingSelection is more DICOM oriented and only relates to DICOM identifiers. DocumentReference is more image oriented and also contains information on the size, duration, etc. aspects of the image.
13+
The {% raw %}{{ehnImagingGuidelines}}{% endraw %} requires information on the size, format, duration etc., data elements that are provided on the `Attachment` field on `DocumentReference`. If these fields are critical, DocumentReference fits more closely. In US Core the R4 `Media` resource is used to represent key images. This resource later merged into the FHIR R5 `DocumentReference`.
14+
15+
As this IG has an FHIR R5 and R4 representation, `DocumentReference` is an easy fit but in other sections of this specification, `ImagingSelection` is used (e.g. to state that an image can from a Procedure Phase).
16+
17+
The `ImagingSelection` resource points to a DICOM data. The DICOM instance data also holds the data required by the {% raw %}{{ehnImaging}}{% endraw %}. So the client can retrieve the information from the DICOM source data.
18+
19+
The {% raw %}{{ehnImagingGuidelines}}{% endraw %} also requires access to the imaging data. It refers to access the data directly or using an web based image viewer. A scenario that can be supported based on ImagingSelection as such mechanism require access to the DICOM identifiers and a WADO endpoint. Although not discussed yet, it is anticipated that a web based endpoint can operate based on similar data fields.
20+
21+
`DocumentReferences` refer to the data source directly (included in the Attachment or referred to it). It does not carry the DICOM identifiers, although these can be added to `DocumentReference` resources (identifier or extensions).
22+
23+
Another aspect, although unlikely, is that the report mey refer to key images (charts, pdf's, ...) not stored in a DICOM PACS, `DocumentReferences` would allow this.
24+
25+
There is a point to be made for both resource types.
26+
27+
**CHOICE:** Key images can be represented by `ImagingSelection` or `DocumentReference` resources.
28+
29+
**CHOICE:** When using `DocumentReference` to represent a DICOM data element, it will carry an identifier corresponding the serie or instance it represents.
30+
31+
That leaves the question in what way are these resources linked into the overall infrastructure.
32+
33+
```mermaid
34+
classDiagram
35+
direction TD
36+
{% if isR5 %}
37+
class ImagingSelectionKeyImageEuImaging{
38+
<<ImagingSelection>>
39+
studyUid
40+
instance.uid
41+
instance.sopClass
42+
}
43+
{% endif %}
44+
{% if isR4 %}
45+
class ImagingSelectionKeyImageEuImaging{
46+
<<Basic as ImagingSelection>>
47+
extension[ImagingSelection].extension[studyUid].value
48+
extension[ImagingSelection].extension[instance].extension[uid].value
49+
instance.sopClass
50+
}
51+
{% endif %}
52+
class DocumentReferenceKeyImageEuImaging{
53+
<<DocumentReference>>
54+
modality
55+
}
56+
class ImKeyImageInstanceDocumentReference{
57+
<<DocumentReference>>
58+
identifier: SOP Instance UID
59+
}
60+
class ImKeyImageInstanceSerieDocumentReference{
61+
<<DocumentReference>>
62+
identifier: SerieInstanceUID
63+
}
64+
class CompositionEuImaging{
65+
<<Composition>>
66+
section[keyimages]
67+
}
68+
class DiagnosticReportEuImaging{
69+
<<DiagnosticReport>>
70+
}
71+
CompositionEuImaging --> DocumentReferenceKeyImageEuImaging: section[findings].entry[keyimages]
72+
CompositionEuImaging --> ImagingSelectionKeyImageEuImaging: section[findings].entry[keyimages]
73+
DiagnosticReportEuImaging --> DocumentReferenceKeyImageEuImaging: extension[finding]
74+
DiagnosticReportEuImaging --> ImagingSelectionKeyImageEuImaging: extension[finding]
75+
76+
DocumentReferenceKeyImageEuImaging --> ImageData: content.attachment.url
77+
DocumentReferenceKeyImageEuImaging <|-- ImKeyImageInstanceSerieDocumentReference
78+
DocumentReferenceKeyImageEuImaging <|-- ImKeyImageInstanceDocumentReference
79+
```

ig-src/input/pagecontent/design-consideration-keyimages.md

Lines changed: 0 additions & 72 deletions
This file was deleted.

ig-src/input/pagecontent/design-consideration-linking-to-bodysites.liquid.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
### Linking to body-sites
22

3-
THe {{ehnImagingGuidelines}} requires that information is added that defines the body site of the imaging procedure (section A.5.1.6). This information consists of a set of different data elements:
3+
THe {% raw %}{{ehnImagingGuidelines}}{% endraw %} requires that information is added that defines the body site of the imaging procedure (section A.5.1.6). This information consists of a set of different data elements:
44

55
- body location
66
- laterality
77

8-
In FHIR body locations can be represented in two ways: as a coded value or as a reference to a `BodyStructure` resource. The coded value is used when a code is sufficient. The `BodyStructure` is used when more information is needed such as laterality or to indicate morphology. Additionally, as is specified in {{dicomSr2fhir}} the information such as the DICOM tracking id (see [DICOM-SR-2-FHIR body structure](https://hl7.org/fhir/uv/dicom-sr/2024Sep/StructureDefinition-dicom-sr-tracking-identifiers.html)). The DICOM tracking id is used to track similar features across DICOM studies and reports.
8+
In FHIR body locations can be represented in two ways: as a coded value or as a reference to a `BodyStructure` resource. The coded value is used when a code is sufficient. The `BodyStructure` is used when more information is needed such as laterality or to indicate morphology. Additionally, as is specified in {% raw %}{{dicomSr2fhir}}{% endraw %} the information such as the DICOM tracking id (see [DICOM-SR-2-FHIR body structure](https://hl7.org/fhir/uv/dicom-sr/2024Sep/StructureDefinition-dicom-sr-tracking-identifiers.html)). The DICOM tracking id is used to track similar features across DICOM studies and reports.
99
{% if isR5 %}
1010
References to a body site are used in `ServiceRequestOrderEuImaging` (what part of the body is to be studied), `ProcedureEuImaging` (the body site the procedure is performed on) and `ImagingStudy.series` (the body site the series is imaging). In FHIR R5 both `ServiceRequestOrderEuImaging` and `ImagingStudy` allow references to `BodyStructure`. `Procedure` only supports a coded value.
1111
{% endif %}

ig-src/input/pagecontent/design-consideration-radiation-dose-summary.liquid.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,6 @@ In this process, also some changes where made in line with FHIR R5, these includ
2020
{% endif %}
2121
{% if isR4 %}
2222
In this process, also some changes where made in line with FHIR R4, these include:
23-
* The observation identifier referred to the SOPInstanceUID, this is replaced with a reference to ImagingSelection through an `derivedFrom` extension, replicating R5 functionality by backporting that `Observation` element to R4 .
23+
* The observation identifier referred to the SOPInstanceUID, this is replaced with a reference to ImagingSelection through an `derivedFrom` extension, replicating R5 functionality by backporting that `Observation` R5 element to R4.
2424
* Adding slices on Observation.component for the different numeric values.
2525
{% endif %}

ig-src/input/pagecontent/design-considerations-report-and-manifest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ In order to access the data, the URL's of the WADO/viewer endpoints are needed t
4848

4949
#### Conclusion
5050

51-
**Decision:** There will be a imaging-manifest documenting the information typically stored in a PACS that holds the Endpoint resources with the URL's that allow access to the content, this manifest is defined in {{manifest}}.
51+
**Decision:** There will be a imaging-manifest documenting the information typically stored in a PACS that holds the Endpoint resources with the URL's that allow access to the content, this manifest is defined in {% raw %}{{manifest}}{% endraw %}.
5252

5353
**Decision:** There will be a imaging report documenting the radiology report which is not required to include the URL's to access the content.
5454

0 commit comments

Comments
 (0)