Merge pull request #344 from echicoine-icf/intro-generator-new-files

Intro Generation: Modified script to create missing intro files.
HL7 · Nov 5, 2024 · e80caed · e80caed
2 parents 9b1bdfa + fbb383c
commit e80caed
Show file tree

Hide file tree

Showing 15 changed files with 84 additions and 14 deletions.
diff --git a/input/intro-notes/StructureDefinition-qicore-claim-intro.xml b/input/intro-notes/StructureDefinition-qicore-claim-intro.xml
@@ -2,15 +2,20 @@
 <!--Begin Generated Intro Tag (DO NOT REMOVE)-->
 <b>QI Elements:</b>
 <ul>
+<li>Claim: Claim, Pre-determination or Pre-authorization</li>
 <li>patient: (QI) The recipient of the products and services</li>
 <li>billablePeriod: (QI) Relevant time frame for the claim</li>
 <li>created: (QI) Resource creation date</li>
 <li>provider: (QI) Party responsible for the claim</li>
 <li>prescription: (QI) Prescription authorizing services and products</li>
+<li>diagnosis: (QI) Pertinent diagnosis information</li>
 <li>diagnosis.sequence: (QI) Diagnosis instance identifier</li>
 <li>diagnosis.diagnosis[x]: (QI) Nature of illness or problem</li>
+<li>diagnosis.type: (QI) Timing or nature of the diagnosis</li>
 <li>diagnosis.onAdmission: (QI) Present on admission</li>
+<li>procedure: (QI) Clinical procedures performed</li>
 <li>procedure.sequence: (QI) Procedure instance identifier</li>
+<li>procedure.type: (QI) Category of Procedure</li>
 <li>procedure.procedure[x]: (QI) Specific clinical procedure</li>
 <li>item.encounter: (QI) Encounters related to this billed item</li>
 </ul>

diff --git a/input/intro-notes/StructureDefinition-qicore-communicationnotdone-intro.xml b/input/intro-notes/StructureDefinition-qicore-communicationnotdone-intro.xml
@@ -2,7 +2,7 @@
 <!--Begin Generated Intro Tag (DO NOT REMOVE)-->
 <b>QI Elements:</b>
 <ul>
-<li>recorded: (QI) Extension</li>
+<li>event-recorded: (QI) Captures the recorded date of the communication</li>
 <li>status: (QI) preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown</li>
 <li>statusReason: (QI) Reason for current status</li>
 <li>subject: (QI) Focus of message</li>

diff --git a/input/intro-notes/StructureDefinition-qicore-devicenotrequested-intro.xml b/input/intro-notes/StructureDefinition-qicore-devicenotrequested-intro.xml
@@ -2,7 +2,6 @@
 <!--Begin Generated Intro Tag (DO NOT REMOVE)-->
 <b>QI Elements:</b>
 <ul>
-<li>doNotPerformReason: (QI) Extension</li>
 <li>modifierExtension: (QI) Extension</li>
 <li>modifierExtension.value[x]: (QI) Value of extension</li>
 <li>status: (QI) draft | active | on-hold | revoked | completed | entered-in-error | unknown</li>
@@ -11,6 +10,7 @@
 <li>doNotPerformValueSet: (QI) What was not done</li>
 <li>subject: (QI) Focus of request</li>
 <li>authoredOn: (QI) When recorded</li>
+<li>reasonCode: (QI) Explanation/Justification for procedure or service</li>
 </ul>
 
 <b>Primary code path:</b> code

diff --git a/input/intro-notes/StructureDefinition-qicore-immunizationnotdone-intro.xml b/input/intro-notes/StructureDefinition-qicore-immunizationnotdone-intro.xml
@@ -12,7 +12,7 @@
 <b>QI Elements:</b>
 <ul>
 <li>notDoneValueSet: (QI) What wasn't administered</li>
-<li>recorded: (QI) When the immunization was first captured in the subject's record</li>
+<li>recorded: (QI) Documented date Immunization did not occur.</li>
 </ul>
 
 <b>Primary code path:</b> vaccineCode

diff --git a/input/intro-notes/StructureDefinition-qicore-keyelement-intro.xml b/input/intro-notes/StructureDefinition-qicore-keyelement-intro.xml
@@ -0,0 +1,16 @@
+<!--Begin Generated Intro Tag (DO NOT REMOVE)-->
+<br></br>
+<b>NOTE TO BALLOT REVIEWERS:</b>
+<ul>
+<li>US Core 7.0, and thus QI-Core 7.0, has a new approach to USCDI requirements.</li>
+<ul>
+<li>As noted in the US Core 7.0 <a href='https://hl7.org/fhir/us/core/must-support.html#must-support-elements'>Must Support</a> section, US Core 7.0 no longer highlights mandatory (cardinality 1..* or 1..1) and Must Support elements with a (USCDI) indicator as such items must be supported for interoperability.</li>
+<li>Those USCDI elements that are not mandatory or Must Support now include an indicator (ADDITIONAL USCDI) in US Core. QI-Core 7.0 does not reference USCDI elements; rather, users should access US Core 7.0 to understand its implementation of USCDI version 4.</li>
+</ul>
+<li>We invite comments about the approach and suggestions for other options that would also avoid unnecessary noise or reading load to the QI-Core profile representation.</li>
+<li>Further, QI-Core 7.0 does not discuss <a href='https://uscdiplus.healthit.gov/uscdi'>USCDI+Quality</a> because at the time of ballot preparation, no published version of USCDI+Quality is available. We seek reviewer advice regarding how QI-Core might address future USCDI+Quality.</li>
+</ul>
+<br></br>
+
+
+<!--End Generated Intro (DO NOT REMOVE)-->
diff --git a/input/intro-notes/StructureDefinition-qicore-medicationadministration-intro.xml b/input/intro-notes/StructureDefinition-qicore-medicationadministration-intro.xml
@@ -2,6 +2,7 @@
 <!--Begin Generated Intro Tag (DO NOT REMOVE)-->
 <b>QI Elements:</b>
 <ul>
+<li>recorded: (QI) Recorded</li>
 <li>status: (QI) in-progress | on-hold | completed | entered-in-error | stopped | unknown</li>
 <li>medication[x]: (QI) What was administered</li>
 <li>subject: (QI) Who received medication</li>

diff --git a/input/intro-notes/StructureDefinition-qicore-medicationadministrationnotdone-intro.xml b/input/intro-notes/StructureDefinition-qicore-medicationadministrationnotdone-intro.xml
@@ -3,7 +3,7 @@
 <b>QI Elements:</b>
 <ul>
 <li>implicitRules: (QI) A set of rules under which this content was created</li>
-<li>recorded: (QI) Extension</li>
+<li>recorded: (QI) Recorded</li>
 <li>status: (QI) in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown</li>
 <li>statusReason: (QI) Reason administration not performed</li>
 <li>medication[x]: (QI) What was administered</li>

diff --git a/input/intro-notes/StructureDefinition-qicore-medicationdispense-intro.xml b/input/intro-notes/StructureDefinition-qicore-medicationdispense-intro.xml
@@ -10,6 +10,7 @@
 
 <b>QI Elements:</b>
 <ul>
+<li>recorded: (QI) Extension</li>
 <li>authorizingPrescription: (QI) Medication order that authorizes the dispense</li>
 <li>type: (QI) Trial fill, partial fill, emergency fill, etc.</li>
 <li>quantity: (QI) Amount dispensed</li>

diff --git a/input/intro-notes/StructureDefinition-qicore-nonpatient-observation-intro.xml b/input/intro-notes/StructureDefinition-qicore-nonpatient-observation-intro.xml
@@ -0,0 +1,36 @@
+<!--Begin Generated Intro Tag (DO NOT REMOVE)-->
+<b>QI Elements:</b>
+<ul>
+<li>status: (QI) registered | prliminary | final | amended | corrected | entered-in-error | unknown</li>
+<li>category: (QI) Classification of type of observation</li>
+<li>code: (QI) Type of observation (code / type)</li>
+<li>subject: (QI) The device/location/implantable device the observation is about</li>
+<li>effective[x]: (QI) Clinically relevant time/time-period for observation</li>
+<li>performer: (QI) Who is responsible for the observation</li>
+<li>value[x]: (QI) Actual result</li>
+<li>value[x]: (QI) actual | potential</li>
+<li>interpretation: (QI) High, low, normal, etc.</li>
+<li>derivedFrom: (QI) QI Core Profiles or other resource the observation is made from</li>
+</ul>
+
+<b>Primary code path:</b> code
+<br></br>
+(PCPath) This element is the primary code path for this resource <a href='https://cql.hl7.org/02-authorsguide.html#filtering-with-terminology'>CQL Retrieve</a>
+<br></br>
+<br></br>
+
+<br></br>
+<b>NOTE TO BALLOT REVIEWERS:</b>
+<ul>
+<li>US Core 7.0, and thus QI-Core 7.0, has a new approach to USCDI requirements.</li>
+<ul>
+<li>As noted in the US Core 7.0 <a href='https://hl7.org/fhir/us/core/must-support.html#must-support-elements'>Must Support</a> section, US Core 7.0 no longer highlights mandatory (cardinality 1..* or 1..1) and Must Support elements with a (USCDI) indicator as such items must be supported for interoperability.</li>
+<li>Those USCDI elements that are not mandatory or Must Support now include an indicator (ADDITIONAL USCDI) in US Core. QI-Core 7.0 does not reference USCDI elements; rather, users should access US Core 7.0 to understand its implementation of USCDI version 4.</li>
+</ul>
+<li>We invite comments about the approach and suggestions for other options that would also avoid unnecessary noise or reading load to the QI-Core profile representation.</li>
+<li>Further, QI-Core 7.0 does not discuss <a href='https://uscdiplus.healthit.gov/uscdi'>USCDI+Quality</a> because at the time of ballot preparation, no published version of USCDI+Quality is available. We seek reviewer advice regarding how QI-Core might address future USCDI+Quality.</li>
+</ul>
+<br></br>
+
+
+<!--End Generated Intro (DO NOT REMOVE)-->
diff --git a/input/intro-notes/StructureDefinition-qicore-observation-lab-intro.xml b/input/intro-notes/StructureDefinition-qicore-observation-lab-intro.xml
@@ -11,6 +11,7 @@
 
 <b>QI Elements:</b>
 <ul>
+<li>encounter: (QI) Encounter associated with Observation</li>
 <li>effective[x]: (QI) Clinically relevant time/time-period for observation</li>
 <li>issued: (QI) Date/Time this version was made available</li>
 <li>value[x]: (QI) Result Value</li>

diff --git a/input/intro-notes/StructureDefinition-qicore-observationcancelled-intro.xml b/input/intro-notes/StructureDefinition-qicore-observationcancelled-intro.xml
@@ -2,7 +2,7 @@
 <!--Begin Generated Intro Tag (DO NOT REMOVE)-->
 <b>QI Elements:</b>
 <ul>
-<li>notDoneReason: (QI) Extension</li>
+<li>event-statusReason: (QI) Event Status Reason</li>
 <li>status: (QI) registered | preliminary | final | amended +</li>
 <li>category: (QI) Classification of type of observation</li>
 <li>code: (QI) Type of observation (code / type)</li>

diff --git a/input/intro-notes/StructureDefinition-qicore-procedurenotdone-intro.xml b/input/intro-notes/StructureDefinition-qicore-procedurenotdone-intro.xml
@@ -14,6 +14,8 @@
 <li>statusReason: (QI) Reason for the current status</li>
 <li>notDoneValueSet: (QI) What was not performed</li>
 <li>performed[x]: (QI) When the procedure was performed</li>
+<li>reasonCode: (QI) Coded reason procedure performed</li>
+<li>reasonReference: (QI) The justification that the procedure was performed</li>
 </ul>
 
 <b>Primary code path:</b> code

diff --git a/input/intro-notes/StructureDefinition-qicore-relatedperson-intro.xml b/input/intro-notes/StructureDefinition-qicore-relatedperson-intro.xml
@@ -10,6 +10,7 @@
 <ul>
 <li>relationship: (QI) The nature of the relationship</li>
 <li>name: (QI) A name associated with the person</li>
+<li>telecom: (QI) A contact detail for the person</li>
 </ul>
 
 <b>Primary code path:</b> relationship

diff --git a/input/intro-notes/StructureDefinition-qicore-servicenotrequested-intro.xml b/input/intro-notes/StructureDefinition-qicore-servicenotrequested-intro.xml
@@ -11,8 +11,6 @@
 
 <b>QI Elements:</b>
 <ul>
-<li>reasonRefused: (QI) Extension</li>
-<li>doNotPerform: (QI) True if service/procedure should not be performed</li>
 <li>notDoneValueSet: (QI) What was not requested</li>
 <li>occurrence[x]: (QI) When service should occur</li>
 <li>reasonCode: (QI) Explanation/Justification for procedure or service</li>

diff --git a/input/pages/qi-elements.md b/input/pages/qi-elements.md
@@ -105,15 +105,20 @@
 
 ### [QICore Claim](StructureDefinition-qicore-claim.html) ###
 **QI Elements:**
+* Claim: Claim, Pre-determination or Pre-authorization
 * patient: (QI) The recipient of the products and services
 * billablePeriod: (QI) Relevant time frame for the claim
 * created: (QI) Resource creation date
 * provider: (QI) Party responsible for the claim
 * prescription: (QI) Prescription authorizing services and products
+* diagnosis: (QI) Pertinent diagnosis information
 * diagnosis.sequence: (QI) Diagnosis instance identifier
 * diagnosis.diagnosis[x]: (QI) Nature of illness or problem
+* diagnosis.type: (QI) Timing or nature of the diagnosis
 * diagnosis.onAdmission: (QI) Present on admission
+* procedure: (QI) Clinical procedures performed
 * procedure.sequence: (QI) Procedure instance identifier
+* procedure.type: (QI) Category of Procedure
 * procedure.procedure[x]: (QI) Specific clinical procedure
 * item.encounter: (QI) Encounters related to this billed item
 
@@ -155,7 +160,7 @@
 
 ### [QICore Communication Not Done](StructureDefinition-qicore-communicationnotdone.html) ###
 **QI Elements:**
-* recorded: (QI) Extension
+* event-recorded: (QI) Captures the recorded date of the communication
 * status: (QI) preparation \| in-progress \| not-done \| on-hold \| stopped \| completed \| entered-in-error \| unknown
 * statusReason: (QI) Reason for current status
 * subject: (QI) Focus of message
@@ -290,7 +295,6 @@
 
 ### [QICore Device Not Requested](StructureDefinition-qicore-devicenotrequested.html) ###
 **QI Elements:**
-* doNotPerformReason: (QI) Extension
 * modifierExtension: (QI) Extension
 * modifierExtension.value[x]: (QI) Value of extension
 * status: (QI) draft \| active \| on-hold \| revoked \| completed \| entered-in-error \| unknown
@@ -299,6 +303,7 @@
 * doNotPerformValueSet: (QI) What was not done
 * subject: (QI) Focus of request
 * authoredOn: (QI) When recorded
+* reasonCode: (QI) Explanation/Justification for procedure or service
 
 **Primary code path:** code
 <br>
@@ -537,7 +542,7 @@
 
 **QI Elements:**
 * notDoneValueSet: (QI) What wasn't administered
-* recorded: (QI) When the immunization was first captured in the subject's record
+* recorded: (QI) Documented date Immunization did not occur.
 
 **Primary code path:** vaccineCode
 <br>
@@ -619,6 +624,7 @@
 
 
 **QI Elements:**
+* encounter: (QI) Encounter associated with Observation
 * effective[x]: (QI) Clinically relevant time/time-period for observation
 * issued: (QI) Date/Time this version was made available
 * value[x]: (QI) Result Value
@@ -698,7 +704,7 @@
 ### [QICore MedicationAdministration Not Done](StructureDefinition-qicore-medicationadministrationnotdone.html) ###
 **QI Elements:**
 * implicitRules: (QI) A set of rules under which this content was created
-* recorded: (QI) Extension
+* recorded: (QI) Recorded
 * status: (QI) in-progress \| not-done \| on-hold \| completed \| entered-in-error \| stopped \| unknown
 * statusReason: (QI) Reason administration not performed
 * medication[x]: (QI) What was administered
@@ -720,6 +726,7 @@
 
 ### [QICore MedicationAdministration](StructureDefinition-qicore-medicationadministration.html) ###
 **QI Elements:**
+* recorded: (QI) Recorded
 * status: (QI) in-progress \| on-hold \| completed \| entered-in-error \| stopped \| unknown
 * medication[x]: (QI) What was administered
 * subject: (QI) Who received medication
@@ -777,6 +784,7 @@
 
 
 **QI Elements:**
+* recorded: (QI) Extension
 * authorizingPrescription: (QI) Medication order that authorizes the dispense
 * type: (QI) Trial fill, partial fill, emergency fill, etc.
 * quantity: (QI) Amount dispensed
@@ -902,7 +910,7 @@
 
 ### [QICore Observation Cancelled](StructureDefinition-qicore-observationcancelled.html) ###
 **QI Elements:**
-* notDoneReason: (QI) Extension
+* event-statusReason: (QI) Event Status Reason
 * status: (QI) registered \| preliminary \| final \| amended +
 * category: (QI) Classification of type of observation
 * code: (QI) Type of observation (code / type)
@@ -1099,6 +1107,8 @@
 * statusReason: (QI) Reason for the current status
 * notDoneValueSet: (QI) What was not performed
 * performed[x]: (QI) When the procedure was performed
+* reasonCode: (QI) Coded reason procedure performed
+* reasonReference: (QI) The justification that the procedure was performed
 
 **Primary code path:** code
 <br>
@@ -1163,6 +1173,7 @@
 **QI Elements:**
 * relationship: (QI) The nature of the relationship
 * name: (QI) A name associated with the person
+* telecom: (QI) A contact detail for the person
 
 **Primary code path:** relationship
 <br>
@@ -1184,8 +1195,6 @@
 
 
 **QI Elements:**
-* reasonRefused: (QI) Extension
-* doNotPerform: (QI) True if service/procedure should not be performed
 * notDoneValueSet: (QI) What was not requested
 * occurrence[x]: (QI) When service should occur
 * reasonCode: (QI) Explanation/Justification for procedure or service