Merge pull request #252 in CIL/ci-fhir-stu3 from CIFMM-3336-PDL-profi…

…le-intro-pages-improve-guidance to master * commit '44c04f92e3edfc3db231dbf9dea4651d0fc7fc29': PDL profile intro pages - multiple updates provenance-list-gen-1-intro.md edited online with Bitbucket PDL profile intro pages - updates to first line and headers
AuDigitalHealth · Mar 24, 2020 · d147794 · d147794
2 parents 55faa62 + 44c04f9
commit d147794
Show file tree

Hide file tree

Showing 16 changed files with 122 additions and 103 deletions.
diff --git a/pages/PrescriptionDispenseLists/_includes/composition-pdl-1-intro.md b/pages/PrescriptionDispenseLists/_includes/composition-pdl-1-intro.md
@@ -2,7 +2,6 @@
 
 #### Usage scenarios
 The following are the overarching usage scenarios this profile is intended to support:
-
 * A clinical information system (CIS) sends or receives
   * a prescription list as a document with the My Health Record system
   * a dispense record list as a document with the My Health Record system
@@ -25,13 +24,11 @@ The following are the overarching usage scenarios this profile is intended to su
     * a prescription and dispense record list as a document 
 
 An expected usage scenario, further scoping the above overarching scenarios is:
-* Prescription and dispense view (PDV) exchanged with the My Health Record
+* Prescription and dispense view (PDV) exchanged with the My Health Record system
 
 This profile does not support sending medicines change information (e.g. indicating cancellation or newly prescribed items) or event-specific information; in this case it is recommended that information is supplied as a shared medicines list.  
 
-
 #### Implementation guidance
-
 When the list is a prescription list it is expected that:
 * code will be 57828-6 "Prescription list"
 * one section of type Prescription List with the code 57828-6 "Prescription list" is expected
@@ -53,7 +50,6 @@ When the list is a prescription and dispense list it is expected that:
 * a non-empty section will be sent with a list entry
 * if the list is generated from a filter or search query a provenance entry will be sent
 
-
 Additionally when a prescription and dispense list is a PDV it is expected that:
 * author will be the My Health Record system as a Device
 * custodian will be the My Health Record system operator

diff --git a/pages/PrescriptionDispenseLists/_includes/device-dh-base-1-intro.md b/pages/PrescriptionDispenseLists/_includes/device-dh-base-1-intro.md
@@ -1,5 +1,6 @@
-### Base Device *[[Draft](http://hl7.org/fhir/stu3/versions.html#maturity)]*
+#### Base Device *[[Draft](http://hl7.org/fhir/stu3/valueset-publication-status.html)]*
 
-##### Implementation guidance
-No additional guidance is suggested to support implementation of this profile for the expected usage scenarios of this implementation guide.
+#### Implementation guidance
+No additional guidance is suggested to support implementation of this profile for the overarching usage scenarios of this implementation guide.
 
+This profile is referenced by TBD
diff --git a/pages/PrescriptionDispenseLists/_includes/device-ident-1-intro.md b/pages/PrescriptionDispenseLists/_includes/device-ident-1-intro.md
@@ -1,10 +1,6 @@
 #### Device with Mandatory Identifier *[[Draft](http://hl7.org/fhir/stu3/valueset-publication-status.html)]*
 
-#### Usage scenarios
-
-TBD
-
 #### Implementation guidance
+No additional guidance is suggested to support implementation of this profile for the overarching usage scenarios of this implementation guide.
 
-No additional guidance is suggested to support implementation of this profile for the expected usage scenarios of this implementation guide.
-
+This profile is referenced by TBD
diff --git a/pages/PrescriptionDispenseLists/_includes/humanname-dh-base-1-intro.md b/pages/PrescriptionDispenseLists/_includes/humanname-dh-base-1-intro.md
@@ -1 +1,3 @@
-#### Base HumanName *[[Draft](http://hl7.org/fhir/stu3/valueset-publication-status.html)]*
+#### Base HumanName *[[Active](http://hl7.org/fhir/stu3/valueset-publication-status.html)]*
+
+This profile is referenced by TBD
diff --git a/pages/PrescriptionDispenseLists/_includes/intro.md b/pages/PrescriptionDispenseLists/_includes/intro.md
@@ -137,6 +137,10 @@ This table lists known issues with this specification at the time of publishing.
         <td>Examples</td>
         <td>There are no examples available in this FHIR implementation guide. Some example resources conforming to profiles, such as <a href="StructureDefinition-practitioner-ident-1.html">Patient with Mandatory Identifier</a>, can be found in a GitHub release, e.g. <a href="https://github.com/AuDigitalHealth/ci-fhir-stu3/releases/tag/SML-1.1.0-2020FEB">Shared Medicines List implementation guide (v1.1.0)</a>, or the <a href="https://github.com/AuDigitalHealth/ci-fhir-stu3/tree/master/examples">examples folder</a> of the GitHub ci-fhir-stu3 repository.</td>
     </tr>
+    <tr>
+        <td>Profile pages missing references</td>
+        <td>Many profile pages are missing the list of which other profiles include it as a reference.</td>
+    </tr>
  </tbody>
 </table> 
 

diff --git a/pages/PrescriptionDispenseLists/_includes/list-pdl-1-intro.md b/pages/PrescriptionDispenseLists/_includes/list-pdl-1-intro.md
@@ -1,66 +1,76 @@
 #### List of Prescription and or Dispense Records *[[Draft](http://hl7.org/fhir/stu3/valueset-publication-status.html)]*
 
 #### Usage scenarios
+The following are the overarching usage scenarios this profile is intended to support:
+* A clinical information system (CIS) sends or receives
+  * a prescription list with the My Health Record system
+  * a dispense record list with the My Health Record system
+  * a prescription and dispense record list with the My Health Record system
+* A contracted service provider (CSP) sends or receives
+   * a prescription list with the My Health Record system
+   * a dispense record list with the My Health Record system
+   * a prescription and dispense record list with the My Health Record system
+* A CIS sends or receives
+  * a prescription list with another CIS or CSP
+  * a dispense record list with another CIS or CSP
+  * a prescription and dispense record list with another CIS or CSP
+* A CSP sends or receives
+  * a prescription list with a CIS or another CSP
+  * a dispense record list with a CIS or another CSP
+  * a prescription and dispense record list list with a CIS or another CSP
+* A registered portal or registered repository receives
+    * a prescription list
+    * a dispense record list
+    * a prescription and dispense record list 
 
-* A clinical information system (CIS) sends or receives a prescription and or a dispense record list with the My Health Record system
-* A contracted service provider (CSP) sends or receives a prescription and or a dispense record list with the My Health Record system
-* A CIS sends or receives a prescription and or a dispense record list with another CIS or CSP
-* A CSP sends or receives a prescription and or a dispense record list with a CIS or another CSP
-* A registered portal or registered repository receives a prescription and or a dispense record list
-
-Expected usage scenarios, further scoping the above overarching scenarios are:
-
-* Prescription and dispense view (PDV) exchanged with the My Health Record as a list
-* Prescription and dispense view (PDV) exchanged with the My Health Record as a document
+An expected usage scenario, further scoping the above overarching scenarios is:
+* Prescription and dispense view (PDV) exchanged with the My Health Record system
 
 This profile does not support sending medicines change information (e.g. indicating cancellation or newly prescribed items) or event-specific information; in this case it is recommended that information is supplied as a shared medicines list.  
 
 #### Implementation guidance
+For the above overarching scenarios in this implementation guide it is expected that:
+* the use of MedicationStatement is discouraged
+* where possible systems are encouraged to send MedicationDispense or MedicationRequest
 
-For the above overarching scenarios in this implementation guide:
-
-* with a List.code of ‘100.32014’ Dispense List will be sent with only dispensed medicine items
-* with a List.code of ‘57828-6’ Prescription list will be sent with only prescribed medicine items
-* although an allowed type of list item is MedicationStatement its use is discouraged 
+When the list is a prescription and dispense view it is expected that:
+* the source will be a Device (My Health Record system)
+* the date will be the time the PDV is generated
 
-When the list is a PDV
-* The source will be a Device, and is expected to be the My Health Record system
-* The date will be the time the PDV is generated
-
-#### When the list is part of a document
-When the list is sent as part of a document (referenced in Composition.section.entry) rather than as a standalone resource the following guidance applies:
+When the list is sent as part of a document (referenced in Composition.section.entry) the following guidance applies:
 <table class="list" width="100%">
   <tr>
-    <th>Item</th>
+    <th>List element</th>
     <th>Guidance</th>
    </tr>
      <tr>
-        <td>author role</td>
-        <td>Will reference the same PractitionerRole as in Composition.composition-author-role</td>
+        <td>author-role</td>
+        <td>Will be sent with the same PractitionerRole as Composition.composition-author-role</td>
     </tr>
      <tr>
-        <td>author related person</td>
-        <td>Will reference the same RelatedPerson as in Composition.author</td>
+        <td>author-related-person</td>
+        <td>Will be sent with the same Relatedperson as Composition.author</td>
     </tr>
-    <tr>
+   <tr>
         <td>code</td>
-        <td>Will have the same value as in the referencing Composition.section.code</td>
-    </tr>
-    <tr>
+        <td>Will be sent with the same code as Composition.section.code</td>
+   </tr>   
+   <tr>
         <td>subject</td>
-        <td>Will reference the same Patient as in Composition.subject</td>
-    </tr>
-    <tr>
+        <td>Will be sent with the same Patient as Composition.subject</td>
+    </tr>   
+   <tr>
         <td>date</td>
-        <td>Will hold the same value as Composition.date</td>
-    </tr>
-    <tr>
+        <td>Will be sent with the same datetime as Composition.date</td>
+    </tr>   
+   <tr>
         <td>source</td>
-        <td>Will reference the same resource as in Composition.author</td>
-    </tr>
-    <tr>
+        <td>Will be sent with the same resource as Composition.author</td>
+    </tr>    
+       <tr>
         <td>title</td>
-        <td>Will not be provided</td>
-    </tr>
-    </table>
-
+        <td>Will not be sent</td>
+    </tr>  
+  </table> 
+
+This profile is referenced by [Prescription and / or Dispense List](StructureDefinition-composition-pdl-1.html)
diff --git a/pages/PrescriptionDispenseLists/_includes/organization-dh-base-1-intro.md b/pages/PrescriptionDispenseLists/_includes/organization-dh-base-1-intro.md
@@ -1,7 +1,7 @@
-#### Base Organization *[[Draft](http://hl7.org/fhir/stu3/valueset-publication-status.html)]*
+#### Base Organization *[[Active](http://hl7.org/fhir/stu3/valueset-publication-status.html)]*
 
 #### Implementation guidance
-
 For the overarching usage scenarios in this implementation guide it is recommended that:
+* an Australian address conforms to [AU Base Address](https://build.fhir.org/ig/hl7au/au-fhir-base-stu3/StructureDefinition-au-address.html)
 
-* an Australian address conforms to [AU Base Address](https://build.fhir.org/ig/hl7au/au-fhir-base-stu3/StructureDefinition-au-address.html)
+This profile is referenced by TBD
diff --git a/pages/PrescriptionDispenseLists/_includes/organization-ident-1-intro.md b/pages/PrescriptionDispenseLists/_includes/organization-ident-1-intro.md
@@ -1,10 +1,10 @@
-#### Organization with Mandatory Identifier *[[Draft](http://hl7.org/fhir/stu3/valueset-publication-status.html)]*
+#### Organization with Mandatory Identifier *[[Active](http://hl7.org/fhir/stu3/valueset-publication-status.html)]*
 
 #### Implementation guidance
-
 For the overarching usage scenarios in this implementation guide it is recommended that:
-* an Australian address conforms to [AU Base Address](https://hl7.org.au/fhir/base/aubase1.1/StructureDefinition-au-address.html)
+* an Australian address conforms to [AU Base Address](https://build.fhir.org/ig/hl7au/au-fhir-base-stu3/StructureDefinition-au-address.html)
 
 When sending a Prescription and or Dispense Record List to the My Health Record system it is expected that:
 * an HPI-O will be sent
 
+This profile is referenced by TBD
diff --git a/pages/PrescriptionDispenseLists/_includes/patient-dh-base-1-intro.md b/pages/PrescriptionDispenseLists/_includes/patient-dh-base-1-intro.md
@@ -1,6 +1,7 @@
-#### Base Patient *[[Draft](http://hl7.org/fhir/stu3/valueset-publication-status.html)]*
+#### Base Patient *[[Active](http://hl7.org/fhir/stu3/valueset-publication-status.html)]*
 
 #### Implementation guidance
-
 For the overarching usage scenarios in this implementation guide it is recommended that:
 * an Australian address conforms to [AU Base Address](https://build.fhir.org/ig/hl7au/au-fhir-base-stu3/StructureDefinition-au-address.html)
+
+This profile is referenced by TBD
diff --git a/pages/PrescriptionDispenseLists/_includes/patient-ident-1-intro.md b/pages/PrescriptionDispenseLists/_includes/patient-ident-1-intro.md
@@ -1,7 +1,7 @@
-### Patient with Mandatory Identifier *[[Draft](http://hl7.org/fhir/stu3/valueset-publication-status.html)]*
+#### Patient with Mandatory Identifier *[[Active](http://hl7.org/fhir/stu3/valueset-publication-status.html)]*
 
 #### Implementation guidance
-No additional guidance is suggested to support implementation of this profile for the expected usage scenarios of this implementation guide.
-
-
+For the overarching usage scenarios in this implementation guide it is recommended that:
+* an Australian address conforms to [AU Base Address](https://build.fhir.org/ig/hl7au/au-fhir-base-stu3/StructureDefinition-au-address.html)
 
+This profile is referenced by TBD
diff --git a/pages/PrescriptionDispenseLists/_includes/practitioner-dh-base-1-intro.md b/pages/PrescriptionDispenseLists/_includes/practitioner-dh-base-1-intro.md
@@ -1,9 +1,11 @@
-#### Base Practitioner *[[Draft](http://hl7.org/fhir/stu3/valueset-publication-status.html)]*
+#### Base Practitioner *[[Active](http://hl7.org/fhir/stu3/valueset-publication-status.html)]*
 
 #### Implementation guidance
 For the overarching usage scenarios in this implementation guide it is recommended that:
 * an Australian address conforms to [AU Base Address](http://build.fhir.org/ig/hl7au/au-fhir-base-stu3/StructureDefinition-au-address.html)
 * an employee identifier local to an organisation, e.g. a hospital or lab, be sent with:
   * a type code of 'EI' 'http://terminology.hl7.org/CodeSystem/v2-0203'
   * the system will be filled with a namespace specific to the organisation, e.g. 'https://territorymedicalcentre.example.com/provider' or 'http://ns.electronichealth.net.au/id/abn-scoped/service-provider-individual/1.0/51824753556'
-  * the value is the actual employee identifier in the organisation's system, e.g. 'frankburns27' or '123456'
+  * the value is the actual employee identifier in the organisation's system, e.g. 'frankburns27' or '123456'
+
+This profile is referenced by TBD
diff --git a/pages/PrescriptionDispenseLists/_includes/practitioner-ident-1-intro.md b/pages/PrescriptionDispenseLists/_includes/practitioner-ident-1-intro.md
@@ -1,6 +1,14 @@
-### Practitioner with Mandatory Identifier *[[Draft](http://hl7.org/fhir/stu3/valueset-publication-status.html)]*
+#### Practitioner with Mandatory Identifier *[[Active](http://hl7.org/fhir/stu3/valueset-publication-status.html)]*
 
 #### Implementation guidance
-No additional guidance is suggested to support implementation of this profile for the expected usage scenarios of this implementation guide.
+For the overarching usage scenarios in this implementation guide it is recommended that:
+* an Australian address conforms to [AU Base Address](http://build.fhir.org/ig/hl7au/au-fhir-base-stu3/StructureDefinition-au-address.html)
+* an employee identifier local to an organisation, e.g. a hospital or lab, be sent with:
+  * a type code of 'EI' 'http://terminology.hl7.org/CodeSystem/v2-0203'
+  * the system will be filled with a namespace specific to the organisation, e.g. 'https://territorymedicalcentre.example.com/provider' or 'http://ns.electronichealth.net.au/id/abn-scoped/service-provider-individual/1.0/51824753556'
+  * the value is the actual employee identifier in the organisation's system, e.g. 'frankburns27' or '123456'
 
-
+When sending a Prescription and or Dispense Record List to the My Health Record system it is expected that:
+* an HPI-I will be sent
+
+This profile is referenced by TBD
diff --git a/...iptionDispenseLists/_includes/practitionerrole-withpractitionerident-1-intro.md b/...iptionDispenseLists/_includes/practitionerrole-withpractitionerident-1-intro.md
@@ -1,12 +1,10 @@
-#### PractitionerRole with Practitioner with Mandatory Identifier *[[Draft](http://hl7.org/fhir/stu3/valueset-publication-status.html)]*
+#### PractitionerRole with Practitioner with Mandatory Identifier *[[Active](http://hl7.org/fhir/stu3/valueset-publication-status.html)]*
 
 #### Implementation guidance
+For the overarching usage scenarios in this implementation guide it is recommended that:
+* PractitionerRole.code will be a value equivalent to the author's professional role, e.g. General Practitioner
+* practitioner will be sent as a reference to a Practitioner resource for the author
+* the organisation the author is representing (PractitionerRole.organization), e.g. family clinic, will be sent as a reference to an Organization resource
+* availability information (availableTime, notAvailable, and availabilityExceptions) will not be sent
 
-No additional guidance is suggested to support implementation of this profile for the overarching usage scenarios this implementation guide is intended to support.
-
-When the shared medicines list is a PSML document it is expected that:
-
-* PractitionerRole.code will be a value equivalent to the author's professional role, e.g. 159011008 \|Community pharmacist\|
-* practitioner will be sent as a reference to a Practitioner resource for the author, e.g. the pharmacist
-* the organisation the author is representing (PractitionerRole.organization), e.g. pharmacy, will be sent as a reference to an Organization resource
-* availability information (availableTime, notAvailable, and availabilityExceptions) will not be sent
+This profile is referenced by TBD
diff --git a/pages/PrescriptionDispenseLists/_includes/provenance-list-gen-1-intro.md b/pages/PrescriptionDispenseLists/_includes/provenance-list-gen-1-intro.md
@@ -1,26 +1,26 @@
-### Provenance for the Generation of a List *[[Draft](http://hl7.org/fhir/stu3/valueset-publication-status.html)]*
+#### Provenance for the Generation of a List *[[Draft](http://hl7.org/fhir/stu3/valueset-publication-status.html)]*
 
-##### Usage scenarios
+#### Usage scenarios
 * A clinical information system (CIS) sends or receives a list with provenance with the My Health Record system
 * A contracted service provider (CSP) sends or receives a list with provenance with the My Health Record system
 * A CIS sends or receives a list with provenance with another CIS or CSP
 * A CSP sends or receives a list with provenance a CIS or another CSP
 * A registered portal or registered repository receives a list with provenance
 
 An expected usage scenario, further scoping the above overarching scenarios is:
-
 * Prescription and dispense view (PDV) exchanged with the My Health Record as a list with provenance
-Further scoping of applicable usage scenarios (e.g. point-to-point or point-to-share) is done at the referencing Composition profile.
 
+Further scoping of applicable usage scenarios (e.g. point-to-point or point-to-share) is done at the referencing Composition profile.
 
-##### Implementation guidance
+#### Implementation guidance
+For the overarching usage scenarios in this implementation guide it is expected that:
+* When creating a list as a filtered view of an existing list (e.g. filtering to only current medicines), the source list can be identified using the entity element with an entity.role of 'source' and entity.whatReference pointing to that source list resource
+* If a list has been generated from a time-based query or time-based filter it is expected that filtering dates are captured in the provenance period with the earliest filtering date provided in the period start and the latest filtering date provided in the period end
 
-For the supported scenarios in this implementation guide:
+Provenance can record the set of the resources used for generation, e.g. the created list itself in target and the set of resources that make up the list in one or more instances of entity with entity.role as 'source'. 
 
-* Where the list is a filtered view of an existing list, the source list may be referenced as an entity with the role of 'source' and what pointing to that list resource
-* Where the list is created with a set of existing resources, e.g. AllergyIntolerance, the resources that initially populated the list may be referenced as entities with the role of 'source' and what pointing to that resource
-* Where the generated list is a filtered view of an existing list, or a source system, or generated from a time-based search query it is expected that filtering dates are captured in the provenance period with the earliest filtering date provided in the period start and the latest filtering date provided in the period end
+When the list is a prescription and dispense view it is expected that:
+* only one instance of agent (the assembling device e.g. My Health Record system) is provided
+* only one instance of target (the Prescription and dispense view list resource) is provided
 
-#### When the list is a PDV
-* It is expected that the only agent provided is the assembling device
-* It is expected that there is only one instance of target, which is the Prescription and dispense view list resource
+This profile is referenced by [Prescription and / or Dispense List](StructureDefinition-composition-pdl-1.html)