Skip to content

Commit

Permalink
Merge pull request #9 from IHE/mlj-aug-2023-prepub-edits
Browse files Browse the repository at this point in the history
August 2023 Pre-publication Edits
  • Loading branch information
JohnMoehrke authored Aug 2, 2023
2 parents ff3198d + bd69e5a commit 178d22e
Show file tree
Hide file tree
Showing 6 changed files with 42 additions and 40 deletions.
4 changes: 2 additions & 2 deletions input/pagecontent/content.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ No additional requirements. For more information, see [PCC TF-2: 4.1.1.3](pcc.ht

### 3:5.9.3 Specification

This Content Module does not constrain the IPS content. For the definition of the [IPS content as defined by HL7]({{site.data.fhir.hl7ips}})
This Content Module does not constrain the IPS content. For the definition of the [IPS content as defined by HL7]({{site.data.fhir.hl7ips}}).

### 3:5.9.4 Examples

Expand All @@ -78,4 +78,4 @@ See example artifacts

- [Example Bundle: IPS Bundle example]({{site.data.fhir.hl7ips}}/Bundle-IPS-examples-Bundle-01.html)
- [Example DocumentReference for IPS Bundle in XML encoding](DocumentReference-ex-DocumentReference-Bundle-01-xml.html)
- [Example DocumentReference for IPS Bundle in JSON encoding](DocumentReference-ex-DocumentReference-Bundle-01-json.html) with transform relationship to XML encoding.
- [Example DocumentReference for IPS Bundle in JSON encoding](DocumentReference-ex-DocumentReference-Bundle-01-json.html) with transform relationship to XML encoding
4 changes: 2 additions & 2 deletions input/pagecontent/issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@

### Version 1.0.0-comment

- First Public-Comment
- First Public Comment
- Previously named Accessibility to IPS (aIPS). Name was changed due to potential misunderstanding of other meanings of accessibility around user experience with disability.

### Relationship of sIPS to PCC-IPS

The [PCC-IPS](https://www.ihe.net/uploadedFiles/Documents/PCC/IHE_PCC_Suppl_IPS.pdf) is being broken up into distinct Profiles starting with the sIPS Implementation Guide (Profile). Other parts of [PCC-IPS](https://www.ihe.net/uploadedFiles/Documents/PCC/IHE_PCC_Suppl_IPS.pdf) are expected to be published in the coming months and years as resources become available. The sIPS takes precedence over equivalent profiling found in the [PCC-IPS](https://www.ihe.net/uploadedFiles/Documents/PCC/IHE_PCC_Suppl_IPS.pdf) however those parts of the [PCC-IPS](https://www.ihe.net/uploadedFiles/Documents/PCC/IHE_PCC_Suppl_IPS.pdf) that have not been published in other forms are still relevant.
The [PCC-IPS](https://www.ihe.net/uploadedFiles/Documents/PCC/IHE_PCC_Suppl_IPS.pdf) is being broken up into distinct profiles starting with the sIPS Implementation Guide (Profile). Other parts of [PCC-IPS](https://www.ihe.net/uploadedFiles/Documents/PCC/IHE_PCC_Suppl_IPS.pdf) are expected to be published in the coming months and years as resources become available. The sIPS takes precedence over equivalent profiling found in the [PCC-IPS](https://www.ihe.net/uploadedFiles/Documents/PCC/IHE_PCC_Suppl_IPS.pdf); however, those parts of the [PCC-IPS](https://www.ihe.net/uploadedFiles/Documents/PCC/IHE_PCC_Suppl_IPS.pdf) that have not been published in other forms are still relevant.

## Issues

Expand Down
2 changes: 1 addition & 1 deletion input/pagecontent/other.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<div markdown="1" class="stu-note">
This section modifies other IHE profiles or the General Introduction appendices and is not a part of the xxx Profile. The content here will be incorporated into the target narrative at a future time, usually when xxx Profile goes normative.
This section modifies other IHE profiles or the General Introduction appendices and is not a part of the sIPS Profile. The content here will be incorporated into the target narrative at a future time, usually when sIPS Profile goes normative.
</div>

## IHE Technical Frameworks General Introduction Appendix A: Actors
Expand Down
12 changes: 6 additions & 6 deletions input/pagecontent/pcc.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,10 +184,10 @@ DocumentReference can be found in the FHIR core in both Composition and
DocumentReference. However, this mapping is only between Composition and
DocumentReference. See
<http://hl7.org/fhir/composition-mappings.html#fhirdocumentreference> ;
<http://hl7.org/fhir/documentreference-mappings.html#fhircomposition>
<http://hl7.org/fhir/documentreference-mappings.html#fhircomposition>.

For a mapping between DocumentReferenece and XDS DocumentEntry
attributes see <http://hl7.org/fhir/documentreference-mappings.html#xds>
attributes see <http://hl7.org/fhir/documentreference-mappings.html#xds>.

Additionally, below in table 4.1.1 is a mapping between FHIR Document
Composition elements and the XDS DocumentEntry attributes.
Expand All @@ -205,9 +205,9 @@ should identify the transactions and content to which it applies.
The source for all required and optional attributes have been defined in
the bindings below. Two tables describe the XDS object
types: XDSDocumentEntry, and XDSSubmissionSet.
The definitions of the [metadata attributes is defined in ITI Volume 3:4](https://profiles.ihe.net/ITI/TF/Volume3/index.html#4), with the [optionality defined in ITI Volume 3:4.3](https://profiles.ihe.net/ITI/TF/Volume3/ch-4.3.html#4.3)
The definitions of the [metadata attributes is defined in ITI Volume 3:4](https://profiles.ihe.net/ITI/TF/Volume3/index.html#4), with the [optionality defined in ITI Volume 3:4.3](https://profiles.ihe.net/ITI/TF/Volume3/ch-4.3.html#4.3).
For a mapping between DocumentReferenece and XDS DocumentEntry
attributes see <http://hl7.org/fhir/documentreference-mappings.html#xds>
attributes see <http://hl7.org/fhir/documentreference-mappings.html#xds>.

## 4.1 Medical Document Binding to Document Sharing Metadata

Expand All @@ -220,7 +220,7 @@ registry. The other sources of information include the configuration of
the Document Source Actor, the XDS Affinity Domain, the site or
facility, local agreements, other documents in the registry/repository,
and this Content Profile.
See [Overview of Health Document Sharing Communities](https://profiles.ihe.net/ITI/HIE-Whitepaper/index.html#13-overview-of-health-document-sharing-communities)
See [Overview of Health Document Sharing Communities](https://profiles.ihe.net/ITI/HIE-Whitepaper/index.html#13-overview-of-health-document-sharing-communities).

In many cases, the [CDA/FHIR document](https://profiles.ihe.net/ITI/HIE-Whitepaper/index.html#231-fhir-document-vs-cda-document) is created for the purposes of sharing
within an XDS Affinity Domain. In these cases the context of the [CDA/FHIR Document](https://profiles.ihe.net/ITI/HIE-Whitepaper/index.html#231-fhir-document-vs-cda-document) and
Expand All @@ -231,7 +231,7 @@ In other cases, the [CDA/FHIR document](https://profiles.ihe.net/ITI/HIE-Whitepa
and are subsequently being shared. In these cases the context of the [CDA/FHIR document](https://profiles.ihe.net/ITI/HIE-Whitepaper/index.html#231-fhir-document-vs-cda-document)
would not necessarily coincide with that of the XDS Affinity
Domain, and the mappings below would not necessarily apply.
See [Principles of IHE for Health Document sharing](https://profiles.ihe.net/ITI/HIE-Whitepaper/index.html#2-principles-of-ihe-for-health-document-sharing)
See [Principles of IHE for Health Document sharing](https://profiles.ihe.net/ITI/HIE-Whitepaper/index.html#2-principles-of-ihe-for-health-document-sharing).

Please note the specifics given in the table below.

Expand Down
52 changes: 27 additions & 25 deletions input/pagecontent/volume-1.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,13 @@ The IPS dataset is minimal and non-exhaustive; specialty-agnostic and condition-

The IHE sIPS does not modify the [HL7 IPS]({{site.data.fhir.hl7ips}}) specification, but provides for methods of sharing the IPS using [IHE Document Sharing](https://profiles.ihe.net/ITI/HIE-Whitepaper/index.html). The IPS, as a "current summary", is an excellent document for the ["On-Demand" capability of the Document Sharing](https://profiles.ihe.net/ITI/HIE-Whitepaper/index.html#212-dynamic-documents) infrastructure. On-Demand is available in [XDS](https://profiles.ihe.net/ITI/TF/Volume1/ch-10.html#10) with [On-Demand Documents Option](https://profiles.ihe.net/ITI/TF/Volume1/ch-10.html), [XCA](https://profiles.ihe.net/ITI/TF/Volume1/ch-18.html) with [On-Demand Documents Option](https://profiles.ihe.net/ITI/TF/Volume1/ch-18.html#18.2.4), and with [MHD/MHDS](https://profiles.ihe.net/ITI/MHD/index.html). Further details for IPS use of On-Demand are outlined below in section 3.9.2.1.2. IHE Document Sharing also has "Stable" and "Delayed Assembly" document entry types that are further explained in the [HIE Whitepaper: Dynamics Documents](https://profiles.ihe.net/ITI/HIE-Whitepaper/index.html#212-dynamic-documents).

The IPS document is composed by a set of robust, well-defined and potentially reusable sets of core data items (indicated as IPS library in the figure below). The tight focus of the IPS on unplanned care is in this case not a limitation, but, on the contrary, facilitates their potential re-use beyond the IPS scope.
The IPS document is composed by a set of robust, well-defined and potentially reusable sets of core data items (indicated as IPS library in the figure below). The tight focus of the IPS on unplanned care is in this case not a limitation, but on the contrary, facilitates their potential re-use beyond the IPS scope.

<div>
<img src="IPS_doc_library.png" caption="Figure 1: The IPS product and by-products" width="70%" >
</div>
<figure>
<img alt="mXDE Flow from Documents to Resources" src="IPS_doc_library.png" width="70%">
<figcaption><b>Figure 1:56-1: The IPS Product and By-products</b></figcaption>
</figure>
<br clear="all">

## 1:56.1 sIPS Actors, Transactions, and Content Modules

Expand All @@ -24,17 +26,17 @@ The IPS document is composed by a set of robust, well-defined and potentially re

<figure>
{%include docSharing.svg%}
<figcaption><b>Figure: sIPS Actor Diagram</b></figcaption>
<figcaption><b>Figure 1:56.1-1: sIPS Actor Diagram</b></figcaption>
</figure>
<br clear="all">

### 56.1.1 Actors
### 1:56.1.1 Actors

The actors in this profile are described in more detail in the sections below.

<a name="creator"> </a>

#### 56.1.1.1 Content Creator
#### 1:56.1.1.1 Content Creator

The [Content Creator](pcc.html#31-document-sharing-pcc-1) creates the [IPS content]({{site.data.fhir.hl7ips}}) and shares it using one of the methods defined in the [IHE Document Sharing Health Information Exchange](https://profiles.ihe.net/ITI/HIE-Whitepaper/index.html).

Expand All @@ -45,23 +47,23 @@ The HL7 IPS is mapped to the [Document Sharing Metadata according to PCC Volume

<a name="consumer"> </a>

#### 56.1.1.2 Content Consumer
#### 1:56.1.1.2 Content Consumer

The [Content Consumer](pcc.html#31-document-sharing-pcc-1) consumes the [IPS content]({{site.data.fhir.hl7ips}}) and obtains it using one of the methods defined in the [IHE Document Sharing Health Information Exchange](https://profiles.ihe.net/ITI/HIE-Whitepaper/index.html).

FHIR Capability Statement for [Content Consumer](CapabilityStatement-IHE.sIPS.ContentConsumer.html)

The HL7 IPS is mapped to the [Document Sharing Metadata according to PCC Volume 2: 4.1](pcc.html#4-ihe-patient-care-coordination-bindings). This shows how to map the FHIR Composition resource elements into XDS/XDM/XDR/XCA [Document Entry](https://profiles.ihe.net/ITI/TF/Volume3/ch-4.2.html#4.2) and MHD [FHIR DocumentReference](https://profiles.ihe.net/ITI/MHD/32_fhir_maps.html) elements.

#### 56.1.2 IPS Content
#### 1:56.1.2 IPS Content

The Content Creator and Content Consumer share the [IPS content]({{site.data.fhir.hl7ips}}) using one of the methods defined in the [IHE Document Sharing Health Information Exchange](https://profiles.ihe.net/ITI/HIE-Whitepaper/index.html).

The HL7 IPS is mapped to the [Document Sharing Metadata according to PCC Volume 2: 4.1](pcc.html#4-ihe-patient-care-coordination-bindings). This shows how to map the FHIR Composition resource elements into XDS/XDM/XDR/XCA [Document Entry](https://profiles.ihe.net/ITI/TF/Volume3/ch-4.2.html#4.2) and MHD [FHIR DocumentReference](https://profiles.ihe.net/ITI/MHD/32_fhir_maps.html) elements.

<a name="actor-options"> </a>

## 56.2 sIPS Actor Options
## 1:56.2 sIPS Actor Options

Options that may be selected for each actor in this implementation guide, are listed in Table 3.2-1 below. Dependencies
between options when applicable are specified in notes.
Expand All @@ -73,28 +75,28 @@ between options when applicable are specified in notes.
| Content Consumer | Discrete Data Import |
{: .grid}

### 56.2.1 View Option
### 1:56.2.1 View Option

This option defines the processing requirements placed on Content Consumers for providing
access, rendering and management of the medical document. See the [View Option in IHE PCC TF-2:3.1.1](pcc.html#31-document-sharing-pcc-1) for more details on this option.

The Content Consumer Actor shall be able to present a view of the document. Minimal view guidance following [FHIR core Document Presentation](http://hl7.org/fhir/documents.html#presentation).

### 56.2.2 Document Import Option
### 1:56.2.2 Document Import Option

This option defines the processing requirements placed on Content Consumers for providing
access, and importing the entire medical document and managing it as part of the patient record.
See the [Document Import Option in IHE PCC TF-2:3.1.2](pcc.html#31-document-sharing-pcc-1) for more details on this option.

### 56.2.3 Discrete Data Import Option
### 1:56.2.3 Discrete Data Import Option

This option defines the processing requirements placed on Content Consumers for providing
access, and importing discrete data from selected sections of the medical document and
managing them as part of the patient record. See the [Discrete Data Import Option in IHE PCC TF-2:3.1.4](pcc.html#31-document-sharing-pcc-1) for more details on this option.

<a name="required-groupings"> </a>

## 56.3 sIPS Required Actor Groupings
## 1:56.3 sIPS Required Actor Groupings

The Content Creator and Content Consumer communicate the content using the [IHE Document Sharing Health Information Exchange](https://profiles.ihe.net/ITI/HIE-Whitepaper/index.html).

Expand All @@ -111,11 +113,11 @@ Document Sharing [Health Information Exchange Whitepaper](https://profiles.ihe.n

<a name="overview"> </a>

## 56.4 sIPS Overview
## 1:56.4 sIPS Overview

This Implementation Guide simply hooks [HL7 IPS]({{site.data.fhir.hl7ips}}/index.html) to IHE [Document Sharing (XDS, XCA, XDR, XDM, MHD, MHDS)](https://profiles.ihe.net/ITI/HIE-Whitepaper/index.html), using existing Content Creator / Content Consumer actors that already support this binding.

### 56.4.1 Concepts
### 1:56.4.1 Concepts

The Concepts of [Document Sharing Health Information Exchange](https://profiles.ihe.net/ITI/HIE-Whitepaper/index.html) are defined in the [IHE Whitepaper](https://profiles.ihe.net/ITI/HIE-Whitepaper/index.html), and [ITI Profiles](https://profiles.ihe.net/ITI/).

Expand All @@ -127,13 +129,13 @@ A Document Entry (aka FHIR DocumentReference) is metadata about a document. This

<figure>
{%include on-demand.svg%}
<figcaption><b>Figure 56.4.1-1: Example On-Demand relationship to snapshot Stable entries.</b></figcaption>
<figcaption><b>Figure 1:56.4.1-1: Example On-Demand Relationship to Snapshot Stable Entries</b></figcaption>
</figure>
<br clear="all">

### 56.4.2 Use Cases
### 1:56.4.2 Use Cases

### 56.4.2.1 Publishing IPS
### 1:56.4.2.1 Publishing IPS

```Gherkin
Given that the HL7 FHIR IPS Implementation Guide provides a Medical Summary in FHIR format
Expand All @@ -150,7 +152,7 @@ See further discussion:
- General explaination of [Federated Discover and Retrieve in the HIE Whitepaper](https://profiles.ihe.net/ITI/HIE-Whitepaper/index.html#33-federated-discovery-and-retrieve)
- General explaination of [Document Publishing in the HIE Whitepaper](https://profiles.ihe.net/ITI/HIE-Whitepaper/index.html#321-document-publishing)

### 56.4.2.2 Making On-Demand access to IPS available
### 1:56.4.2.2 Making On-Demand Access to IPS Available

```Gherkin
Given that the HL7 FHIR IPS Implementation Guide provides a Medical Summary in FHIR format
Expand All @@ -166,7 +168,7 @@ See further discussion:
- General explaination of [Dynamic Documents in the HIE Whitepaper](https://profiles.ihe.net/ITI/HIE-Whitepaper/index.html#212-dynamic-documents)
- Content Module specific for IPS On-Demand - [3:5.9.2.1.2 On-Demand](content.html#359212-on-demand)

### 56.4.2.3 Retrieving an IPS
### 1:56.4.2.3 Retrieving an IPS

```Gherkin
Given that the HL7 FHIR IPS Implementation Guide provides a Medical Summary in FHIR format
Expand All @@ -180,7 +182,7 @@ See further discussion:
- General explaination of [Federated Discover and Retrieve in the HIE Whitepaper](https://profiles.ihe.net/ITI/HIE-Whitepaper/index.html#33-federated-discovery-and-retrieve)
- General explaination of [Document Discovery and retrival in the HIE Whitepaper](https://profiles.ihe.net/ITI/HIE-Whitepaper/index.html#322-document-discovery)

### 56.4.2.4 Pushing and IPS to a recipient
### 1:56.4.2.4 Pushing an IPS to a Recipient

```Gherkin
Given that the HL7 FHIR IPS Implementation Guide provides a Medical Summary in FHIR format
Expand All @@ -194,12 +196,12 @@ See further discussion:

<a name="security-considerations"> </a>

## 56.5 sIPS Security Considerations
## 1:56.5 sIPS Security Considerations

See [Security and Privacy Solutions: Handbooks, Profiles, and Content](https://profiles.ihe.net/ITI/HIE-Whitepaper/index.html#7-security-and-privacy)
See [Security and Privacy Solutions: Handbooks, Profiles, and Content](https://profiles.ihe.net/ITI/HIE-Whitepaper/index.html#7-security-and-privacy).

<a name="other-grouping"> </a>

## 56.6 sIPS Cross-Profile Considerations
## 1:56.6 sIPS Cross-Profile Considerations

All cross-profile considerations are discussed elsewhere.
8 changes: 4 additions & 4 deletions sushi-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -71,10 +71,10 @@ parameters: # see https://confluence.hl7.org/display/FHIR/Implementation+Guide+
pages:
# itemize here each narrative page. Include assigned section numbers when appropriate. The order they appear here is the order they will appear in the TOC and on the next/prev navigation.
index.md:
title: 1:56 sIPS Home
title: Sharing of IPS (sIPS)
generation: markdown
volume-1.md:
title: 1:56 sIPS Volume 1
title: 1:56 Sharing of IPS (sIPS)
generation: markdown
content.md:
title: 3:5.9 IPS Content Module
Expand All @@ -92,11 +92,11 @@ pages:
title: Download and Analysis
generation: markdown
pcc.md:
title: PCC Volume 2 excerpt
title: PCC Volume 2 Excerpt
generation: markdown

menu:
Home: index.html
sIPS Home: index.html
Volume 1:
Introduction: volume-1.html
Actors and Transactions: volume-1.html#actors-and-transactions
Expand Down

0 comments on commit 178d22e

Please sign in to comment.