Start adding options

IHE · Feb 6, 2024 · aea82a6 · aea82a6
1 parent 0369ece
commit aea82a6
Show file tree

Hide file tree

Showing 2 changed files with 127 additions and 15 deletions.
diff --git a/input/fsh/capability.fsh b/input/fsh/capability.fsh
@@ -1,5 +1,3 @@
-
-
 Instance: IHE.PDQm.PatientDemographicsSupplier
 InstanceOf: CapabilityStatement
 Title: "PDQm Patient Demographics Supplier Actor"
@@ -22,7 +20,6 @@ The PDQm Patient Demographics Supplier Actor (server) requirements CapabililtySt
   - address
   - gender
   - mothersMaidenName
-- SHALL support the PDQm $match operation
 - SHALL return Patient Resources conforming to the PDQm Patient Profile
 """
 * name = "IHE_PDQM_PATIENT_DEMOGRAPHICS_SUPPLIER"
@@ -34,6 +31,117 @@ The PDQm Patient Demographics Supplier Actor (server) requirements CapabililtySt
 * fhirVersion = #4.0.1
 * format[+] = #application/fhir+xml
 * format[+] = #application/fhir+json
+* rest
+  * mode = #server
+  * documentation = "PDQm Patient Demographics Supplier provides capability to discover Patient Identities by demographics and identities."
+  * security
+    * description = "Recommend [ATNA](https://profiles.ihe.net/ITI/TF/Volume1/ch-9.html), encouraged [IHE-IUA](https://profiles.ihe.net/ITI/IUA/index.html) or [SMART-app-launch](http://www.hl7.org/fhir/smart-app-launch/)"
+  * resource[+]
+    * type = #Patient
+    * supportedProfile[+] = Canonical(IHE.PDQm.Patient)
+    * documentation = """
+Mobile Patient Demographics Query [ITI-78]
+"""
+    * interaction[+].code = #read
+    * interaction[+].code = #search-type
+    * searchParam[+]
+      * name = "_lastUpdated"
+      * type = #date
+      * documentation = "When the resource version last changed"
+    * searchParam[+]
+      * name = "_id"
+      * type = #token
+      * documentation = "Logical id of this artifact"
+    * searchParam[+]
+      * name = "active"
+      * type = #token
+      * documentation = "Whether the patient record is active"
+    * searchParam[+]
+      * name = "family"
+      * type = #string
+      * documentation = "A portion of the family name of the patient"
+    * searchParam[+]
+      * name = "given"
+      * type = #string
+      * documentation = "A portion of the given name of the patient"
+    * searchParam[+]
+      * name = "identifier"
+      * type = #token
+      * documentation = "A patient identifier"
+    * searchParam[+]
+      * name = "telecom"
+      * type = #token
+      * documentation = "The value in any kind of telecom details of the patient"
+    * searchParam[+]
+      * name = "birthdate"
+      * type = #date
+      * documentation = "The patient's date of birth"
+    * searchParam[+]
+      * name = "address"
+      * type = #string
+      * documentation = "A server defined search that MAY match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text"
+    * searchParam[+]
+      * name = "address-city"
+      * type = #string
+      * documentation = "A city specified in an address"
+    * searchParam[+]
+      * name = "address-country"
+      * type = #string
+      * documentation = "A country specified in an address"
+    * searchParam[+]
+      * name = "address-postalcode"
+      * type = #string
+      * documentation = "A postalCode specified in an address"
+    * searchParam[+]
+      * name = "address-state"
+      * type = #string
+      * documentation = "A state specified in an address"
+    * searchParam[+]
+      * name = "gender"
+      * type = #token
+      * documentation = "Gender of the patient"
+    * searchParam[+]
+      * name = "mothersMaidenName"
+      * definition = "http://hl7.org/fhir/SearchParameter/patient-extensions-Patient-mothersMaidenName"
+      * type = #string
+      * documentation = "Mother's maiden (unmarried) name, commonly collected to help verify patient identity."
+  * interaction.code = #search-system
+
+
+Instance: IHE.PDQm.PatientDemographicsSupplierMatch
+InstanceOf: CapabilityStatement
+Title: "PDQm Patient Demographics Supplier Actor implementing Match Operation Option"
+Usage: #definition
+* description = """
+The PDQm Patient Demographics Supplier Actor (server) requirements CapabililtyStatement expresses the requirements that SHALL be provided. This capability statement implements the Match Operation Option.
+
+- Query against the FHIR endpoint to the Patient Resource endpoint
+- Using FHIR R4
+- SHALL support both json or xml encoding
+- SHOULD use a security framework. Recommend [ATNA](https://profiles.ihe.net/ITI/TF/Volume1/ch-9.html), encouraged [IHE-IUA](https://profiles.ihe.net/ITI/IUA/index.html) or [SMART-app-launch](http://www.hl7.org/fhir/smart-app-launch/)
+- [Search Parameters that SHALL be supported](https://profiles.ihe.net/ITI/PDQm/ITI-78.html#23784121-query-search-parameters)
+  - _id
+  - active
+  - family
+  - given
+  - identifier
+  - telecom
+  - birthdate
+  - address
+  - gender
+  - mothersMaidenName
+- SHALL support the PDQm $match operation
+- SHALL return Patient Resources conforming to the PDQm Patient Profile
+"""
+* name = "IHE_PDQM_PATIENT_DEMOGRAPHICS_SUPPLIER_Match"
+* title = "IHE PDQm Patient Demographics Supplier Implementing Match Operation Option"
+* status = #active
+* experimental = false
+* date = "2023-09-25"
+* kind = #requirements
+* fhirVersion = #4.0.1
+* format[+] = #application/fhir+xml
+* format[+] = #application/fhir+json
 * rest
   * mode = #server
   * documentation = "PDQm Patient Demographics Supplier provides capability to discover Patient Identities by demographics and identities."
@@ -114,13 +222,12 @@ Mobile Patient Demographics Query [ITI-78] and Patient Demographics Match [ITI-1
     * definition = Canonical(PDQmMatch)
 
 
-
 Instance: IHE.PDQm.PatientDemographicsConsumerQuery
 InstanceOf: CapabilityStatement
-Title: "PDQm Patient Demographics Consumer Actor Implementing ITI-78"
+Title: "PDQm Patient Demographics Consumer Actor Implementing Patient Search Option"
 Usage: #definition
 * description = """
-The PDQm Patient Demographics Consumer Actor (client) requirements CapabililtyStatement expresses the requirements that can be utilized while being compliant. This capability statement implements the ITI-78 transaction.
+The PDQm Patient Demographics Consumer Actor (client) requirements CapabililtyStatement expresses the requirements that can be utilized while being compliant. This capability statement implements the Patient Search Option.
 
 - Query against the FHIR endpoint to the Patient Resource endpoint
 - Using FHIR R4
@@ -138,8 +245,8 @@ The PDQm Patient Demographics Consumer Actor (client) requirements CapabililtySt
   - gender
   - mothersMaidenName
 """
-* name = "IHE_PDQM_PATIENT_DEMOGRAPHICS_CONSUMER_ITI_78"
-* title = "IHE PDQm Patient Demographics Consumer Implementing ITI-78"
+* name = "IHE_PDQM_PATIENT_DEMOGRAPHICS_CONSUMER_SEARCH"
+* title = "IHE PDQm Patient Demographics Consumer Implementing Patient Search Option"
 * status = #active
 * experimental = false
 * date = "2022-10-28"
@@ -224,19 +331,19 @@ Mobile Patient Demographics Query [ITI-78]
 
 Instance: IHE.PDQm.PatientDemographicsConsumerMatch
 InstanceOf: CapabilityStatement
-Title: "PDQm Patient Demographics Consumer Actor Implementing ITI-119"
+Title: "PDQm Patient Demographics Consumer Actor Implementing Match Operation Option"
 Usage: #definition
 * description = """
-The PDQm Patient Demographics Consumer Actor (client) requirements CapabililtyStatement expresses the requirements that can be utilized while being compliant. This capability statement implements the ITI-119 transaction.
+The PDQm Patient Demographics Consumer Actor (client) requirements CapabililtyStatement expresses the requirements that can be utilized while being compliant. This capability statement implements the Match Operation Option.
 
 - Invoke the $match operation on a FHIR endpoint
 - Using FHIR R4
 - Input and output parameters conform to the PDQm Profiles
 - MAY request json or xml encoding
 - SHOULD use a security framework. Recommend [ATNA](https://profiles.ihe.net/ITI/TF/Volume1/ch-9.html), encouraged [IHE-IUA](https://profiles.ihe.net/ITI/IUA/index.html) or [SMART-app-launch](http://www.hl7.org/fhir/smart-app-launch/)
 """
-* name = "IHE_PDQM_PATIENT_DEMOGRAPHICS_CONSUMER_ITI_119"
-* title = "IHE PDQm Patient Demographics Consumer Implementing ITI-119"
+* name = "IHE_PDQM_PATIENT_DEMOGRAPHICS_CONSUMER_MATCH"
+* title = "IHE PDQm Patient Demographics Consumer Implementing Match Operation Option"
 * status = #active
 * experimental = false
 * date = "2023-09-22"

diff --git a/input/pagecontent/volume-1.md b/input/pagecontent/volume-1.md
@@ -71,7 +71,7 @@ Table 1:38.1-1: PDQm - Profile Actors and Transactions
             <a href='ITI-119.html'>Patient Demographics Match [ITI-119]</a>
         </td>
         <td align='center'>
-            R
+            O
         </td>
     </tr>                        
 </tbody>
@@ -123,10 +123,15 @@ Options that MAY be selected for each actor in this profile, if any, are listed
 
 Actor	| Option Name |	Reference
 ---|---|---
-Patient Demographics Consumer |	none |	-
-Patient Demographics Supplier |	none |	-
+Patient Demographics Consumer |	Patient Search | 1:38.2.1
+Patient Demographics Consumer | Match Operation | 1:38.2.2
+Patient Demographics Supplier |	Match Operation | 1:38.2.2
 {:.grid}
 
+### 1:38.2.1 Patient Search Option
+
+### 1:38.2.2 Match Operation Option
+
 ## 1:38.3 PDQm Required Actor Grouping
 
 No required groupings.