FHIR-39598 FHIR-40240 FHIR-40223 changes

input/fsh/instances/OperationDefinition-summary-uv-ips.fsh → input/fsh/OperationDefinition-summary-uv-ips.fsh

@@ -4,16 +4,21 @@ Title: "IPS Summary"
 Description: "This operation is used to return a patient summary using the IPS profile."
 Usage: #definition
 * url = "http://hl7.org/fhir/uv/ips/OperationDefinition/summary"
-* version = "1.1.0"
+* version = "2.0.0"
 * name = "IpsSummary"
 * title = "IPS Summary"
 * status = #active
 * kind = #operation
-* date = "2022-01-05T13:15:56.964-00:00"
+* date = "2024-07-15T13:15:56.964-00:00"
 * publisher = "HL7 International / Patient Care"
 * contact.telecom.system = #url
 * contact.telecom.value = "http://www.hl7.org/Special/committees/patientcare"
-* description = "This operation is used to return a patient summary using the IPS profile."
+* description = "This operation returns an IPS document in response to a POST request.  The returned document MAY be generated on-demand and SHOULD represent the latest available information. This operation would not necessarily create a persisted IPS instance on the server responding to the request. When historic records or other documents are desired, this operation is not appropriate.  
+
+Generally when a patient's logical id is known, that id would be used to request the patient summary from a FHIR server (see [id] pattern below). When it is not known, servers MAY support using other identifiers (see 'identifier' parameter).
+
+Servers MAY support profiles beyond the IPS. When supported, other profiles can be specified using the 'profile' parameter. When not supported, servers MAY use the universal Composition profile to identify what profile is returned by default.  
+" 
 * jurisdiction = $m49.htm#001
 * affectsState = false
 * code = #summary
@@ -32,17 +37,11 @@ Usage: #definition
 * parameter[=].use = #in
 * parameter[=].min = 0
 * parameter[=].max = "1"
-* parameter[=].documentation = "A specific profile for the patient summary may be specified. By default, servers MAY use the [Bundle profile](./StructureDefinition-Bundle-uv-ips.html)"
-* parameter[=].type = #uri
-* parameter[+].name = #graph
-* parameter[=].use = #in
-* parameter[=].min = 0
-* parameter[=].max = "1"
-* parameter[=].documentation = "Servers MAY choose to allow any graph definition to be specified, but MAY require that the client choose a graph definition from a specific list of known supported definitions. The server is not required to support a formal definition of the graph on the end point"
+* parameter[=].documentation = "A specific profile for the patient summary may be specified. By default, servers MAY use the universal Composition profile to identify what profile the returned summary will adhere to.  This is intended as a more flexible approach for implementers to support derivations of the IPS (e.g. national and jurisdictional implementations)."
 * parameter[=].type = #uri
 * parameter[+].name = #return
 * parameter[=].use = #out
 * parameter[=].min = 0
 * parameter[=].max = "1"
-* parameter[=].documentation = "The Bundle returned is a document conforming to the specified input profile parameter or the International Patient Summary [Bundle profile](./StructureDefinition-Bundle-uv-ips.html) (if not otherwise specified)"
+* parameter[=].documentation = "The Bundle returned is a document conforming to the specified input Composition profile parameter or the International Patient Summary [Composition profile](./StructureDefinition-Composition-uv-ips.html) (if not otherwise specified)"
 * parameter[=].type = #Bundle

input/pagecontent/ipsGeneration.md

@@ -4,7 +4,7 @@ The IPS document is composed by a set of resources organized as a [`Bundle`](./S
 
 -	Using a `$summary` [operation](./OperationDefinition-summary.html) on the `Patient` resource. This operation returns an IPS document `Bundle` in response to a POST request. This operation is similar to how the [`$everything`](http://hl7.org/fhir/OperationDefinition/Patient-everything) operation works on the Patient resource. Unlike `$everything`, `$summary` returns summary information, rather than all patient information, in a `Bundle` document through the use of a [`Composition`](./StructureDefinition-Composition-uv-ips.html) resource. This operation would not necessarily create a persisted IPS instance on the server responding to the request. 
 
--	Using a `$docref` [operation](http://hl7.org/fhir/uv/ipa/2022Jan/OperationDefinition-docref.html) on a `DocumentReference` resource as defined in the [International Patient Access](https://hl7.org/fhir/uv/ipa/) guide. For this operation to generate an IPS `Bundle`, it may be necessary to specify the `type` as LOINC 60591-5 (patient summary). This operation may return a `Bundle` with `Bundle.type` of `searchSet` with a `DocumentReference` that references the IPS document `Bundle`.  This operation would generally create a saved IPS `DocumentReference` and `Bundle` on the server. 
+-	Using a `$docref` [operation](http://hl7.org/fhir/uv/ipa/OperationDefinition-docref.html) on a `DocumentReference` resource as defined in the [International Patient Access](https://hl7.org/fhir/uv/ipa/) guide. For this operation to generate an IPS `Bundle`, it may be necessary to specify the `type` as LOINC 60591-5 (patient summary). This operation may return a `Bundle` with `Bundle.type` of `searchSet` with a `DocumentReference` that references the IPS document `Bundle`.  This operation would generally create a saved IPS `DocumentReference` and `Bundle` on the server. 
 
 Future implementation guides may provide alternative methods and further recommendations for IPS document `Bundle` generation. These may include methods different than those outlined above. In addition, the  [International Patient Access Implementation Guide](https://hl7.org/fhir/uv/ipa/) Implementation Guide provides additional guidance accessing individual resources as well as documents from compatible FHIR servers. 
 

sushi-config.yaml

@@ -48,6 +48,7 @@ menu:
     Datatypes: datatypes.html
     Extensions: extensions.html
     Terminology: terminology.html
+    Operations: OperationDefinition-summary.html
     Examples: examples.html
   Downloads: downloads.html
   Copyrights: copyrights.html