Merge pull request #198 from IHE/moehrke-friday-qa

Moehrke Friday qa
IHE · Oct 7, 2022 · 184e90e · 184e90e
2 parents ed87f28 + 22e2aa9
commit 184e90e
Show file tree

Hide file tree

Showing 12 changed files with 28 additions and 24 deletions.
diff --git a/README.md b/README.md
@@ -6,10 +6,10 @@ This branch is dedicated to the improvements agreed to for 2022 Spring Quarter:
 - Constraints on Identifier - [#93](https://github.com/IHE/ITI.MHD/issues/93)
 - SubmisstionSet identifier 2.. cardionality is unclear - [#92](https://github.com/IHE/ITI.MHD/issues/92)
 - Allow DocumentReference.context.encounter - [#88](https://github.com/IHE/ITI.MHD/issues/88)
-- *Clarify replaceTo behaviour and mechanism* - [#100](https://github.com/IHE/ITI.MHD/issues/100)
+- Clarify replaceTo behaviour and mechanism - [#100](https://github.com/IHE/ITI.MHD/issues/100)
 - Support FHIR Document Bundle as an attachment type - [#91](https://github.com/IHE/ITI.MHD/issues/91)
 - Simplified publish - [#122](https://github.com/IHE/ITI.MHD/issues/122) -- Spencer
-- DocumentReference $generate operation -- [#123](https://github.com/IHE/ITI.MHD/issues/123)
+- DocumentReference $generate operation - [#123](https://github.com/IHE/ITI.MHD/issues/123)
 - Align AuditEvents with BasicAudit IG
 - include other fixes from master branch
 
@@ -30,3 +30,4 @@ This Continuous Build will appear http://build.fhir.org/ig/IHE/ITI.MHD/branches/
 
 Formal Publication at http://profiles.ihe.net/ITI/MHD
 
+History of publications at https://profiles.ihe.net/ITI/MHD/history.html 
diff --git a/input/fsh/documentReference.fsh b/input/fsh/documentReference.fsh
@@ -1,7 +1,7 @@
 Profile:        PatchParameters
 Parent:         Parameters
 Id:             IHE.MHD.Patch.Parameters
-Title:          "MHD DocumentReference Pactch Parameters"
+Title:          "MHD DocumentReference Patch Parameters"
 Description:    "A profile on the Parameters resource to update DocumentReference" 
 * parameter.name = "operation"
 

diff --git a/input/fsh/ex-ProvideBundles3.fsh b/input/fsh/ex-ProvideBundles3.fsh
@@ -150,8 +150,22 @@ Usage: #inline
 * data = "VGhhbmtzIGZvciBhbGwgdGhlIGZpc2g="
 
 
+// example for artifacts presentation, replication of the #inline.
+Instance:   ex-patchParameters
+InstanceOf: PatchParameters
+Title:      "DocumentReference for Comprehensive metadata beeing replaced"
+Description: "Example of a comprehensive DocumentReference resource beeing replaced"
+Usage: #example
+* parameter.name = "operation"
+* parameter.part[0].name = "type"
+* parameter.part[=].valueCode = #replace
+* parameter.part[+].name = "path"
+* parameter.part[=].valueString = "DocumentReference.status"
+* parameter.part[+].name = "value"
+* parameter.part[=].valueCode = #superseded
+
 Instance:   aaaaaaaa-bbbb-cccc-ffff-e00333300002
-InstanceOf: Parameters
+InstanceOf: PatchParameters
 Title:      "DocumentReference for Comprehensive metadata beeing replaced"
 Description: "Example of a comprehensive DocumentReference resource beeing replaced"
 Usage: #inline

diff --git a/input/pagecontent/1331_actors_and_transactions.md b/input/pagecontent/1331_actors_and_transactions.md
@@ -224,6 +224,6 @@ For more details see the detailed [ITI-105 transaction description](ITI-105.html
 
 #### 1:33.1.2.6 Generate Metadata
 
-This transaction is used to generate DocumentReference metadata given a document. The Document Source provides a document. The Document Responder will create, update, or use an existing DocumentReference instance. The Document Source indicates if the document should also be persisted.
+This transaction is used to generate DocumentReference metadata given a document. The Document Source provides a document. The Document Responder will create, update, or use an existing DocumentReference instance. 
 
 For more details see the detailed [ITI-106 transaction description](ITI-106.html).
diff --git a/input/pagecontent/ITI-105.md b/input/pagecontent/ITI-105.md
@@ -128,8 +128,6 @@ To enable the Document Source to know the outcome of processing the transaction,
 
 ##### 2:3.105.4.2.3 Expected Actions
 
-If the Document Recipient returns an HTTP redirect response (HTTP status codes 301, 302, 303, or 307), the Document Source shall follow the redirect, but may stop processing if it detects a loop. See [RFC7231 Section 6.4 Redirection 3xx](https://tools.ietf.org/html/rfc7231#section-6.4).
-
 The Document Source processes the results according to application-defined rules.	
 
 #### 2:3.105.4.3 CapabilityStatement Resource

diff --git a/input/pagecontent/ITI-106.md b/input/pagecontent/ITI-106.md
@@ -91,8 +91,6 @@ The Document Recipient returns an OperationOutcome upon failure.
 
 ##### 2:3.106.4.2.3 Expected Actions
 
-If the Document Recipient returns an HTTP redirect response (HTTP status codes 301, 302, 303, or 307), the Document Source shall follow the redirect, but may stop processing if it detects a loop. See [RFC7231 Section 6.4 Redirection 3xx](https://tools.ietf.org/html/rfc7231#section-6.4).
-
 The Document Source processes the results according to application-defined rules.	
 
 #### 2:3.106.4.3 CapabilityStatement Resource

diff --git a/input/pagecontent/ITI-65.md b/input/pagecontent/ITI-65.md
@@ -112,7 +112,7 @@ When the [UnContained Reference Option](1332_actor_options.html#13323-uncontaine
 
 ###### 2:3.65.4.1.2.3 Replace, Transform, Signs, and Append Associations
 
-The DocumentReference.relatesTo element indicates an association between DocumentReference resources. The relatesTo.target element in the provided DocumentReference points at the pre-existing DocumentReference that is being replaced, transformed, signed, or appended. The relatesTo.code element in the provided DocumentReference shall be the appropriate relationship type code defined in [http://hl7.org/fhir/R4/valueset-document-relationship-type.html](http://hl7.org/fhir/R4/valueset-document-relationship-type.html). If a DocumentReference will be replaced, the to be replaced DocumentReference needs to be added and updated to status `superseded` within the transaction bundle.
+The DocumentReference.relatesTo element indicates an association between DocumentReference resources. The relatesTo.target element in the provided DocumentReference points at the pre-existing DocumentReference that is being replaced, transformed, signed, or appended. The relatesTo.code element in the provided DocumentReference shall be the appropriate relationship type code defined in [http://hl7.org/fhir/R4/valueset-document-relationship-type.html](http://hl7.org/fhir/R4/valueset-document-relationship-type.html). If a DocumentReference will be replaced, the to be replaced DocumentReference needs to be added and updated to status `superseded` within the transaction bundle (see [Example Bundle: Provide Document Bundle with Comprehensive metadata of one document which replaces another document](Bundle-ex-comprehensiveProvideDocumentBundleReplace.html) entry 2).
 
 ##### 2:3.65.4.1.3 Expected Actions
 
@@ -202,8 +202,6 @@ An informative StructureDefinition is outlined for [MHD Provide Bundle Document
 
 ##### 2:3.65.4.2.3 Expected Actions
 
-If the Document Recipient returns an HTTP redirect response (HTTP status codes 301, 302, 303, or 307), the Document Source shall follow the redirect, but may stop processing if it detects a loop. See [RFC7231 Section 6.4 Redirection 3xx](https://tools.ietf.org/html/rfc7231#section-6.4).
-
 The Document Source processes the results according to application-defined rules.	
 
 #### 2:3.65.4.3 CapabilityStatement Resource

diff --git a/input/pagecontent/ITI-66.md b/input/pagecontent/ITI-66.md
@@ -221,8 +221,6 @@ Where the List Resource being returned is being translated from an XDS Submissio
 
 ##### 2:3.66.4.2.3 Expected Actions
 
-If the Document Responder returns an HTTP redirect response (HTTP status codes 301, 302, 303, or 307), the Document Consumer shall follow the redirect, but may stop processing if it detects a loop. See RFC7231 Section 6.4 Redirection 3xx.
-
 The Document Consumer shall process the results according to application-defined rules. The Document Consumer should be robust as the response may contain List Resources that match the query parameters but are not compliant with the List constraints defined in [ITI TF-3: 4.5](32_fhir_maps.html).
 
 #### 2:3.66.4.3 CapabilityStatement Resource

diff --git a/input/pagecontent/ITI-67.md b/input/pagecontent/ITI-67.md
@@ -252,8 +252,6 @@ Resource Bundling shall comply with the guidelines in [ITI TF-2x: Appendix Z.1](
 
 #### 2:3.67.4.3 Expected Actions
 
-If the Document Responder returns an HTTP redirect response (HTTP status codes 301, 302, 303, or 307), the Document Consumer shall follow the redirect, but may stop processing if it detects a loop. See RFC7231 Section 6.4 Redirection 3xx.
-
 The Document Consumer shall process the results according to application-defined rules. The Document Consumer should be robust as the response may contain DocumentReference Resources that match the query parameters but are not compliant with the DocumentReference constraints defined here.
 
 #### 2:3.67.4.4 CapabilityStatement Resource

diff --git a/input/pagecontent/ITI-68.md b/input/pagecontent/ITI-68.md
@@ -78,12 +78,8 @@ The Document Responder may return other HTTP Status Codes. Guidance on handling
 
 The Document Responder should complement the returned error code with a human readable description of the error condition.
 
-The Document Responder may return HTTP redirect responses (responses with HTTP Status Codes 301, 302, 303 or 307) in response to a request.See [RFC7231 Section 6.4 Redirection 3xx](https://tools.ietf.org/html/rfc7231#section-6.4). 
-
 ##### 2:3.68.4.2.3 Expected Actions
 
-If the Document Responder returns an HTTP redirect response (HTTP status codes 301, 302, 303, or 307), the Document Consumer shall follow the redirect, but may stop processing if it detects a loop. See [RFC7231 Section 6.4 Redirection 3xx](https://tools.ietf.org/html/rfc7231#section-6.4).
-
 The Document Consumer processes the results according to application-defined rules.
 
 The .hash and .size, when populated, represent the content in the MIME type indicated in the DocumentReference.content.attachment.contentType. Note there are special .size and .hash handling for [On-Demand Documents](ITI-67.html#236742212-support-for-on-demand-documents) and [Delayed Document Assembly](ITI-67.html#236742213-support-for-delayed-document-assembly).

diff --git a/input/pagecontent/a_issues.md b/input/pagecontent/a_issues.md
@@ -1,6 +1,8 @@
 <div markdown="1" class="stu-note">
 
 ### Significant changes since MHD Version 4.1.0
+
+Version 4.2.0-comment
 - changed to AuditEvent profiling leveraging [Basic Audit Log Patterns (BALP) Release 1.1.0](https://profiles.ihe.net/ITI/BALP/index.html)
   - changes to RESTful type, and query subtype
 - Added new features
@@ -11,9 +13,9 @@
     - This is added as an option at this time to keep base compatibility with existing MHD. This may become normal functionality of ITI-65 eventually
   - Each of these new options may survive or may be removed. Please voice your interest, and sign up for IHE-Connectathon to test these options. Based on interest these Options may survive or be removed.
 - better clarity on types of Identifier
+- a method has been added to support DocumentReference replace that is used by the Document Source to mark the old/replaced DocumentReference instance as superseded.
 
-
-Possibly will be in 4.1.1
+#### Other changes
 - added clarity on when ITI-65 would/should/could include a Patient resource, vs relying on Patient services like PIXm/PDQm/PMIR.
 - added a search parameter for searching against DocumentReference.content.attachment.creation
 - eliminated mandate for entryUUID in ITI-65 from the StructureDefinitions, it was already relaxed in the ITI-65 narrative.
@@ -55,7 +57,8 @@ These issues were known as part of the publication, and IHE invites comments. Co
 * [MHD_065](https://github.com/IHE/ITI.MHD/issues/155): Is it needed to have a mapping between XDS RegistryError and FHIR OperationOutcome at the element level, and also addressing OperationOutcome.issue.code vocabulary could be mapped to the XDS error vocabulary between XDS https://profiles.ihe.net/ITI/TF/Volume3/ch-4.2.html#4.2.4.1 and FHIR OperationOutcome?
 * [MHD_066](https://github.com/IHE/ITI.MHD/issues/154): Note that On-Demand may become supported in FHIR R5 https://jira.hl7.org/browse/FHIR-22501
 * [MHD_067](https://github.com/IHE/ITI.MHD/issues/109): Potential use of $docref operation from HL7 Implementation Guide. This operation is currently in US-Core, and is being added/moved to IPA. It is unclear how MHD would be able to use just this operation without being fully dependant upon all of IPA.
-
+* [MHD_068](https://github.com/IHE/ITI.MHD/issues/197): Document Source "replace" methodology to better support FHIR backends like MHDS.
+
 ### Closed Issues
 These issues have been decided and documented in the publication.
 

diff --git a/package-list.json b/package-list.json
@@ -19,7 +19,7 @@
   "status" : "ballot",
   "fhirversion" : "4.0.1",
   "sequence" : "Public Comment",
-  "current" : true
+  "current" : false
  },
  {
     "version" : "4.1.0",