Skip to content

Commit

Permalink
Merge branch 'Moehrke-publish-Fdocuments' into Improvements-2022
Browse files Browse the repository at this point in the history
  • Loading branch information
JohnMoehrke committed Oct 4, 2022
2 parents 6773a47 + de5f459 commit 5275778
Show file tree
Hide file tree
Showing 10 changed files with 1,280 additions and 7 deletions.
2 changes: 1 addition & 1 deletion input/fsh/documentReference.fsh
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Description: "A profile on the DocumentReference resource for MHD with minima
* content.attachment.title 0..1
* content.attachment.creation 0..1 MS
* content.format 0..1 MS
//* content.format from http://ihe.net/fhir/ihe.formatcode.fhir/ValueSet/formatcode (preferred)
* content.format from http://ihe.net/fhir/ihe.formatcode.fhir/ValueSet/formatcode (preferred)
//* context.encounter 0..0
* context.event 0..*
* context.period 0..1 MS
Expand Down
15 changes: 12 additions & 3 deletions input/fsh/provideBundle.fsh
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ Description: "A profile on the Bundle transaction for ITI-65 Provide Document
DocumentRefs 0..* and
UpdateDocumentRefs 0..* and
Documents 0..* and
FhirDocuments 0..* and
Folders 0..* and
Patient 0..1
* entry[SubmissionSet].resource only
Expand All @@ -52,11 +53,19 @@ Description: "A profile on the Bundle transaction for ITI-65 Provide Document
* entry[UpdateDocumentRefs].request.method = #PATCH
* entry[Documents].resource ^type.code = "Binary"
* entry[Documents].resource ^type.profile = Canonical(Binary)
* entry[Documents] ^short = "the documents"
* entry[Documents] ^definition = "the documents referenced by the DocumentReference resources"
* entry[Documents] ^short = "the Documents"
* entry[Documents] ^definition = "the Documents referenced by the DocumentReference resources"
* entry[Documents].resource 1..1
* entry[Documents].request 1..1
* entry[Documents].request.method = #POST
* entry[FhirDocuments].request.method = #POST
* entry[FhirDocuments].resource ^type.code = "Bundle"
* entry[FhirDocuments].resource ^type.profile = Canonical(Bundle)
// TODO Should there be more to be sure it is a FHIR Document Bundle?
* entry[FhirDocuments] ^short = "the FHIR-FhirDocuments"
* entry[FhirDocuments] ^definition = "the FHIR-FhirDocuments referenced by the DocumentReference resources"
* entry[FhirDocuments].resource 1..1
* entry[FhirDocuments].request 1..1
* entry[FhirDocuments].request.method = #POST
* entry[Folders].resource only
IHE.MHD.Minimal.Folder
* entry[Folders] ^short = "Folders"
Expand Down
6 changes: 5 additions & 1 deletion input/pagecontent/1331_actors_and_transactions.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,10 +156,12 @@ The Document Source is the producer and publisher of Document Content to a Docum
The Document Source uses either the ITI-65 or ITI-105.

The following CapabilityStatements define the Actor capabilities given the various Options
* [Document Source implementing Simplified Publish Option](CapabilityStatement-IHE.MHD.DocumentSource.Simplified.html)
* [Document Source](CapabilityStatement-IHE.MHD.DocumentSource.html)
* [Document Source implementing Comprehensive Metadata Option](CapabilityStatement-IHE.MHD.DocumentSource.Comprehensive.html)
* [Document Source implementing UnContained Reference Option](CapabilityStatement-IHE.MHD.DocumentSource.UnContained.html)
* [Document Source implementing Simplified Publish Option](CapabilityStatement-IHE.MHD.DocumentSource.Simplified.html)
* [Document Source implementing Generate Metadata Option](CapabilityStatement-IHE.MHD.DocumentSource.Generate.html)
* [Document Source implementing ITI-65 FHIR Documents Publish Option](CapabilityStatement-IHE.MHD.DocumentSource.Fdoc.html)

#### 1:33.1.1.2 Document Consumer

Expand All @@ -177,6 +179,8 @@ The following CapabilityStatements define the Actor capabilities
* [Document Recipient implementing Comprehensive Metadata Option](CapabilityStatement-IHE.MHD.DocumentRecipient.Comprehensive.html)
* [Document Recipient implementing UnContained Reference Option](CapabilityStatement-IHE.MHD.DocumentRecipient.UnContained.html)
* [Document Recipient implementing Simplified Publish Option](CapabilityStatement-IHE.MHD.DocumentRecipient.Simplified.html)
* [Document Source implementing Generate Metadata Option](CapabilityStatement-IHE.MHD.DocumentSource.Generate.html)
* [Document Source implementing ITI-65 FHIR Documents Publish Option](CapabilityStatement-IHE.MHD.DocumentSource.Fdoc.html)

#### 1:33.1.1.4 Document Responder

Expand Down
16 changes: 14 additions & 2 deletions input/pagecontent/1332_actor_options.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ between options when applicable are specified in notes.
</thead>
<tbody>
<tr>
<td rowspan='4'>Document Source</td>
<td rowspan='5'>Document Source</td>
<td><a href="#13321-comprehensive-metadata-option">Comprehensive Metadata</a></td>
</tr>
<tr>
Expand All @@ -23,9 +23,12 @@ between options when applicable are specified in notes.
</tr>
<tr>
<td><a href="#13325-generate-metadata-option">Generate Metadata</a></td>
</tr>
<tr>
<td><a href="#13326-iti-65-fhir-documents-publish-option">ITI-64 FHIR documents Publish</a></td>
</tr>
<tr>
<td rowspan='5'>Document Recipient</td>
<td rowspan='6'>Document Recipient</td>
<td><a href="#13321-comprehensive-metadata-option">Comprehensive Metadata</a></td>
</tr>
<tr>
Expand All @@ -40,6 +43,9 @@ between options when applicable are specified in notes.
</tr>
<tr>
<td><a href="#13325-generate-metadata-option">Generate Metadata</a></td>
</tr>
<tr>
<td><a href="#13326-iti-65-fhir-documents-publish-option">ITI-64 FHIR documents Publish</a></td>
</tr>
<tr>
<td rowspan='1'>Document Consumer</td>
Expand Down Expand Up @@ -120,3 +126,9 @@ The Document Source claiming the Generate Metadata Option shall implement use of

The Document Recipient claiming the Generate Metadata Option shall implement the [ITI-106](ITI-106.html) transaction. The Document Recipient will interpret the document, create or update a DocumentReference metadata, convert DocumentReference elements into a SubmissionSet. The metadata derivation shall following the [PCC TF-2: 4.1.1 XDSSubmissionSet Metadata](https://www.ihe.net/uploadedFiles/Documents/PCC/IHE_PCC_TF_Vol2.pdf), and may have further metadata translation requirements specified by the local Document Sharing Community policy.

#### 1:33.2.6 ITI-65 FHIR Documents Publish Option

The **ITI-65 FHIR Documents Publish Option** adds support to ITI-65 to carry a FHIR-Document encoded within the ITI-65, rather than needing this FHIR-Document encoded within a Binary. Actors not declaring this option are expected to only support Binary documents in ITI-65.

The Document Recipient Actor will process the FHIR-Document accordingly to the persistance needs that it supports (e.g. XDS, MHDS).

9 changes: 9 additions & 0 deletions input/pagecontent/ITI-65.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ This method is invoked when the Document Source needs to submit one or more docu

##### 2:3.65.4.1.2 Message Semantics

TODO: Look for uses of Binary, and replace with some new word that indicates it could be Binary, or FHIR Document Bundle.

The Document Source shall initiate a FHIR “transaction” using a “create” action by sending an HTTP POST request method composed of a FHIR Bundle Resource containing: one SubmissionSet type List Resource; one or more DocumentReference Resources; zero or more Folder type List Resources; and zero or more Binary Resources to the Document Recipient. Refer to [ITI TF-3: 4.5.1](32_fhir_maps.html) for details on the FHIR Resources and how Document Sharing metadata attributes are mapped.

The media type of the HTTP body shall be either `application/fhir+json` or `application/fhir+xml`.
Expand Down Expand Up @@ -152,6 +154,11 @@ If the recipient is known to be an XDR/XCDR community, the error codes `XDSUnkno

###### 2:3.65.4.1.3.1 Grouping with Actors in other Document Sharing Profiles

TODO: explain how to handle the document as a FHIR Document Bundle
1) SHALL seralice as mime type given from client
2) MAY also seralize as the other mime type and thus register two DocumentEntry with Transforms relationship
3) can we use text in the simplified publish?

This section applies to grouping MHD Document Recipient with [XDS](https://profiles.ihe.net/ITI/TF/Volume1/ch-10.html) [Document Source](https://profiles.ihe.net/ITI/TF/Volume1/ch-10.html#10.1.1.1) Actor, [XDR](https://profiles.ihe.net/ITI/TF/Volume1/ch-15.html) Document Source Actor, [XDR](https://profiles.ihe.net/ITI/TF/Volume1/ch-15.html) Limited-Metadata Document Source Actor, and [XDM](https://profiles.ihe.net/ITI/TF/Volume1/ch-16.html) Portable Media Creator Actor (e.g. with the [XDM ZIP over Email Option](https://profiles.ihe.net/ITI/TF/Volume1/ch-16.html#16.2.3) ).

The Document Recipient shall transform the Bundle content into a proper message for the given grouped Actor (e.g. the XDS Document Source using the Provide and Register Document Set-b [ITI-41](https://profiles.ihe.net/ITI/TF/Volume2/ITI-41.html) transaction). The Document Recipient shall create appropriate metadata from Resources in the FHIR Bundle Resource, including SubmissionSet, DocumentEntry, Folder, and Associations.
Expand All @@ -166,6 +173,8 @@ Some FHIR elements do not translate to XDS concepts; the handling of these eleme

Upon successful conversion of the FHIR Bundle to XDS Document Sharing metadata, the grouped source actor shall execute the appropriate transaction. The transaction result, and any error or warning messages, shall be reported to the MHD Document Source. The Document Recipient is responsible for translating the response to the appropriate HTTP Status Code and FHIR OperationOutcome Resource in the Provide Document Bundle Response Message.

TODO: Add a MHDS grouping that allows for the FHIR Document Bundle being maintained as a FHIR Bundle thus enabling mime-type picking at retrieve. Unclear if there should/must be three DocumentReference recorded to enable three mime-types

#### 2:3.65.4.2 Provide Document Bundle Response Message

The Document Recipient returns a HTTP Status code appropriate to the processing outcome, conforming to the transaction specification requirements as specified in [http://hl7.org/fhir/R4/http.html#transaction](http://hl7.org/fhir/R4/http.html#transaction).
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
{
"resourceType": "CapabilityStatement",
"id": "IHE.MHD.DocumentRecipient.Fdoc",
"text": {
"status": "additional",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n\tThis Requirements CapabilityStatement describes the <a href=\"1331_actors_and_transactions.html#133113-document-recipient\">Document Recipient actor</a> with ITI-65 FHIR Documents Publish declared Option.\n\t</div>"
},
"url": "https://profiles.ihe.net/ITI/MHD/CapabilityStatement/IHE.MHD.DocumentRecipient.Fdoc",
"name": "IHE_MHD_DocumentRecipient_Fdoc",
"title": "Document Recipient implementing ITI-65 FHIR Documents Publish Option",
"status": "active",
"experimental": false,
"date": "2021-02-22T00:00:00-05:00",
"publisher": "Integrating the Healthcare Enterprise (IHE)",
"contact": [
{
"name": "IHE",
"telecom": [
{
"system": "url",
"value": "http://ihe.net"
}
]
},
{
"name": "John Moehrke",
"telecom": [
{
"system": "email",
"value": "JohnMoehrke@gmail.com"
}
]
}
],
"description": "IHE ITI Mobile access to Health Documents (MHD) - Document Recipient - with ITI-65 FHIR Documents Publish declared Option.",
"copyright": "IHE http://www.ihe.net/Governance/#Intellectual_Property",
"kind": "requirements",
"fhirVersion": "4.0.0",
"format": [
"application/fhir+xml",
"application/fhir+json"
],
"rest": [
{
"mode": "server",
"security": {
"description": "Recommend IUA or SMART"
},
"interaction": [
{
"code": "transaction",
"documentation": "https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Minimal.ProvideBundle"
},
{
"code": "transaction",
"documentation": "https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.UnContained.Comprehensive.ProvideBundle"
},
{
"code": "transaction",
"documentation": "https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Comprehensive.ProvideBundle"
}
]
}
]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
{
"resourceType": "CapabilityStatement",
"id": "IHE.MHD.DocumentSource.Fdoc",
"text": {
"status": "additional",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n\tThis Requirements CapabilityStatement describes the <a href=\"1331_actors_and_transactions.html#133111-document-source\">Document Source actor</a> with ITI-65 FHIR Documents Publish declared Option.\n\t</div>"
},
"url": "https://profiles.ihe.net/ITI/MHD/CapabilityStatement/IHE.MHD.DocumentSource.Fdoc",
"name": "IHE_MHD_DocumentSource_Fdoc",
"title": "Document Source (publisher) implementing ITI-65 FHIR Documents Publish Option",
"status": "active",
"experimental": false,
"date": "2021-02-22T00:00:00-05:00",
"publisher": "Integrating the Healthcare Enterprise (IHE)",
"contact": [
{
"name": "IHE",
"telecom": [
{
"system": "url",
"value": "http://ihe.net"
}
]
},
{
"name": "John Moehrke",
"telecom": [
{
"system": "email",
"value": "JohnMoehrke@gmail.com"
}
]
}
],
"description": "IHE ITI Mobile access to Health Documents (MHD) - Document Source (publisher) - with ITI-65 FHIR Documents Publish Option.",
"copyright": "IHE http://www.ihe.net/Governance/#Intellectual_Property",
"kind": "requirements",
"fhirVersion": "4.0.0",
"format": [
"application/fhir+xml",
"application/fhir+json"
],
"rest": [
{
"mode": "client",
"security": {
"description": "Recommend IUA or SMART"
},
"interaction": [
{
"code": "transaction",
"documentation": "https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Minimal.ProvideBundle"
},
{
"code": "transaction",
"documentation": "https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.UnContained.Comprehensive.ProvideBundle"
},
{
"code": "transaction",
"documentation": "https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Comprehensive.ProvideBundle"
}
]
}
]
}
Loading

0 comments on commit 5275778

Please sign in to comment.