US Public Health Profiles Library
1.0.0 - STU1 United States of America flag

US Public Health Profiles Library, published by HL7 Public Health Working Group. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/HL7/fhir-us-ph-common-library-ig/ and changes regularly. See the Directory of published versions

: US Public Health Specification Bundle - Cancer Reporting - XML Representation

Raw xml | Download



<Bundle xmlns="http://hl7.org/fhir">
  <id value="us-ph-specification-bundle-example"/>
  <meta>
    <versionId value="11"/>
    <profile
             value="http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-specification-bundle"/>
  </meta>
  <type value="collection"/>
  <timestamp value="2022-11-20T11:15:33-10:00"/>
  <entry>
    <fullUrl value="PlanDefinition/plandefinition-cancer-example"/>
    <resource>
      <PlanDefinition>
        <id value="plandefinition-cancer-example"/>
        <meta>
          <profile
                   value="http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-plandefinition"/>
        </meta>
        <text>
          <status value="extensions"/>
          <div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative: PlanDefinition</b><a name="plandefinition-cancer-example"> </a></p><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px">Resource PlanDefinition &quot;plandefinition-cancer-example&quot; </p><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-us-ph-plandefinition.html">US Public Health PlanDefinition</a></p></div><p><b>US Public Health Receiver Address Extension</b>: <a href="Endpoint-us-ph-endpoint-salem-medical-center.html">Endpoint/us-ph-endpoint-salem-medical-center</a></p><p><b>US Public Health Async Indicator Extension</b>: true</p><p><b>US Public Health Expected Response Time Extension</b>: 1 min<span style="background: LightGoldenRodYellow"> (Details: UCUM code min = 'min')</span></p><p><b>url</b>: <code>http://hl7.org/fhir/us/ph-library/StructureDefinition/plandefinition-cancer-example</code></p><p><b>version</b>: 1.0</p><p><b>name</b>: PlanDefinitionCancerExample</p><p><b>title</b>: PlanDefinition Cancer Reporting Example</p><p><b>type</b>: Workflow Definition <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="http://terminology.hl7.org/5.0.0/CodeSystem-plan-definition-type.html">PlanDefinitionType</a>#workflow-definition)</span></p><p><b>status</b>: draft</p><p><b>experimental</b>: true</p><p><b>date</b>: 2020-11-04 12:32:29-0500</p><p><b>publisher</b>: ph-library</p><p><b>description</b>: This is the Cancer Reporting Knowledge Artifact</p><p><b>effectivePeriod</b>: 2020-11-01 --&gt; (ongoing)</p><h3>RelatedArtifacts</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Type</b></td><td><b>Label</b></td><td><b>Resource</b></td></tr><tr><td style="display: none">*</td><td>depends-on</td><td>Cancer Trigger Codes</td><td><a href="Bundle-us-ph-specification-bundle-example.html">SNOMED Cancer Codes Example</a></td></tr></table><blockquote><p><b>action</b></p><blockquote><p><b>id</b></p>initiate-reporting-workflow</blockquote><p><b>description</b>: This action represents the start of a reporting workflow.</p><p><b>textEquivalent</b>: Initiate Reporting Workflow</p><p><b>code</b>: Initiate a reporting workflow <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="CodeSystem-us-ph-codesystem-plandefinition-actions.html">US Public Health CodeSystem - PlanDefinition Actions</a>#initiate-reporting-workflow)</span></p><h3>Triggers</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Extension</b></td><td><b>Type</b></td><td><b>Name</b></td></tr><tr><td style="display: none">*</td><td/><td>named-event</td><td>encounter-close</td></tr></table><h3>RelatedActions</h3><table class="grid"><tr><td style="display: none">-</td><td><b>ActionId</b></td><td><b>Relationship</b></td><td><b>Offset[x]</b></td></tr><tr><td style="display: none">*</td><td>check-trigger-codes</td><td>before-start</td><td>1 min<span style="background: LightGoldenRodYellow"> (Details: UCUM code min = 'min')</span></td></tr></table></blockquote><blockquote><p><b>action</b></p><blockquote><p><b>id</b></p>check-trigger-codes</blockquote><p><b>description</b>: This action represents the execution of the checking trigger codes in the  workflow.</p><p><b>textEquivalent</b>: Check Trigger Codes</p><blockquote><p><b>action</b></p><p><b>code</b>: Evaluate candidate patient's data against trigger codes to determine reportability <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="CodeSystem-us-ph-codesystem-plandefinition-actions.html">US Public Health CodeSystem - PlanDefinition Actions</a>#check-trigger-codes)</span></p><blockquote><p><b>condition</b></p></blockquote><blockquote><p><b>relatedAction</b></p></blockquote></blockquote></blockquote><blockquote><p><b>action</b></p><blockquote><p><b>id</b></p>create-report</blockquote><p><b>description</b>: This action represents the creation of a cancer report.</p><p><b>textEquivalent</b>: Create Report</p><p><b>code</b>: Create a Report containing Patient's data for patients who passed the check-reportability test <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="CodeSystem-us-ph-codesystem-plandefinition-actions.html">US Public Health CodeSystem - PlanDefinition Actions</a>#create-report)</span></p></blockquote></div>
        </text>
        <extension
                   url="http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-receiver-address-extension">
          <valueReference>
            <reference value="Endpoint/us-ph-endpoint-salem-medical-center"/>
          </valueReference>
        </extension>
        <extension
                   url="http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-async-indicator-extension">
          <valueBoolean value="true"/>
        </extension>
        <extension
                   url="http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-expected-response-time-extension">
          <valueDuration>
            <value value="1"/>
            <system value="http://unitsofmeasure.org"/>
            <code value="min"/>
          </valueDuration>
        </extension>
        <url
             value="http://hl7.org/fhir/us/ph-library/StructureDefinition/plandefinition-cancer-example"/>
        <version value="1.0"/>
        <name value="PlanDefinitionCancerExample"/>
        <title value="PlanDefinition Cancer Reporting Example"/>
        <type>
          <coding>
            <system
                    value="http://terminology.hl7.org/CodeSystem/plan-definition-type"/>
            <code value="workflow-definition"/>
            <display value="Workflow Definition"/>
          </coding>
        </type>
        <status value="draft"/>
        <experimental value="true"/>
        <date value="2020-11-04T12:32:29.858-05:00"/>
        <publisher value="ph-library"/>
        <description value="This is the Cancer Reporting Knowledge Artifact"/>
        <effectivePeriod>
          <start value="2020-11-01"/>
        </effectivePeriod>
        <relatedArtifact>
          <type value="depends-on"/>
          <label value="Cancer Trigger Codes"/>
          <resource
                    value="http://hl7.org/fhir/us/ph-library/ValueSet/valueset-cancer-trigger-codes-example"/>
        </relatedArtifact>
        <action id="initiate-reporting-workflow">
          <description
                       value="This action represents the start of a reporting workflow."/>
          <textEquivalent value="Initiate Reporting Workflow"/>
          <code>
            <coding>
              <system
                      value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
              <code value="initiate-reporting-workflow"/>
            </coding>
          </code>
          <trigger>
            <extension
                       url="http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-named-eventtype-extension">
              <valueCodeableConcept>
                <coding>
                  <system
                          value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-triggerdefinition-namedevents"/>
                  <code value="encounter-close"/>
                  <display value="Indicates the close of an encounter"/>
                </coding>
              </valueCodeableConcept>
            </extension>
            <type value="named-event"/>
            <name value="encounter-close"/>
          </trigger>
          <relatedAction>
            <actionId value="check-trigger-codes"/>
            <relationship value="before-start"/>
            <offsetDuration>
              <value value="1"/>
              <system value="http://unitsofmeasure.org"/>
              <code value="min"/>
            </offsetDuration>
          </relatedAction>
        </action>
        <action id="check-trigger-codes">
          <description
                       value="This action represents the execution of the checking trigger codes in the  workflow."/>
          <textEquivalent value="Check Trigger Codes"/>
          <action>
            <code>
              <coding>
                <system
                        value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
                <code value="check-trigger-codes"/>
              </coding>
            </code>
            <condition>
              <kind value="applicability"/>
              <expression>
                <language value="text/fhirpath"/>
                <expression
                            value="Condition.code.memberof(http://hl7.org/fhir/us/ph-library/ValueSet/valueset-cancer-trigger-codes-example)"/>
              </expression>
            </condition>
            <relatedAction>
              <actionId value="create-report"/>
              <relationship value="before-start"/>
            </relatedAction>
          </action>
        </action>
        <action id="create-report">
          <description
                       value="This action represents the creation of a cancer report."/>
          <textEquivalent value="Create Report"/>
          <code>
            <coding>
              <system
                      value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
              <code value="create-report"/>
            </coding>
          </code>
        </action>
      </PlanDefinition>
    </resource>
  </entry>
  <entry>
    <fullUrl value="ValueSet/valueset-cancer-trigger-codes-example"/>
    <resource>
      <ValueSet>
        <id value="valueset-cancer-trigger-codes-example"/>
        <meta>
          <profile
                   value="http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-valueset"/>
        </meta>
        <text>
          <status value="extensions"/>
          <div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative: ValueSet</b><a name="valueset-cancer-trigger-codes-example"> </a></p><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px">Resource ValueSet &quot;valueset-cancer-trigger-codes-example&quot; </p><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-us-ph-valueset.html">US Public Health ValueSet</a></p></div><p><b>steward</b>: CSTE Steward: </p><p><b>author</b>: CSTE Author: </p><p><b>url</b>: <code>http://hl7.org/fhir/us/ph-library/ValueSet/valueset-cancer-trigger-codes-example</code></p><p><b>version</b>: 3.0.0</p><p><b>name</b>: SNOMEDCancerCodesExample</p><p><b>title</b>: SNOMED Cancer Codes Example</p><p><b>status</b>: draft</p><p><b>experimental</b>: true</p><p><b>date</b>: 2018-08-01</p><p><b>publisher</b>: HL7 Public Health Work Group (http://www.hl7.org/Special/committees/pher/index.cfm)</p><p><b>contact</b>: HL7 International - Public Health: <a href="http://www.hl7.org/Special/committees/pher">http://www.hl7.org/Special/committees/pher</a></p><p><b>description</b>: This example set of values contains diagnoses or problems that represent that the patient may have a potentially reportable condition regardless of the clinical presentation of the condition</p><h3>UseContexts</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Code</b></td><td><b>Value[x]</b></td></tr><tr><td style="display: none">*</td><td>Priority (Details: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context-type code priority = 'Priority', stated as 'Priority')</td><td>Routine <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="CodeSystem-us-ph-codesystem-usage-context.html">US Public Health CodeSystem - Usage Context</a>#routine)</span></td></tr><tr><td style="display: none">*</td><td>Program (Details: http://terminology.hl7.org/CodeSystem/usage-context-type code program = 'Program', stated as 'null')</td><td>ValueSet is to be used in the context of public health reporting use cases. <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="CodeSystem-us-ph-codesystem-valueset-use-context.html">US Public Health CodeSystem for ValueSet Use Context</a>#ph-reporting)</span></td></tr></table><p><b>jurisdiction</b>: United States of America <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="http://terminology.hl7.org/5.0.0/CodeSystem-ISO3166Part1.html">ISO 3166-1 Codes for the representation of names of countries and their subdivisions — Part 1: Country code</a>#US)</span></p><p><b>copyright</b>: This value set includes content from SNOMED CT, which is copyright © 2002+ International Health Terminology Standards Development Organisation (IHTSDO), and distributed by agreement between IHTSDO and HL7. Implementer use of SNOMED CT is not covered by this agreement</p><blockquote><p><b>compose</b></p><blockquote><p><b>include</b></p><p><b>system</b>: <a href="http://hl7.org/fhir/R4/codesystem-snomedct.html">SNOMED CT (all versions)</a></p><h3>Concepts</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Code</b></td><td><b>Display</b></td></tr><tr><td style="display: none">*</td><td>281566005</td><td>Abdominothoracic neuroblastoma</td></tr></table></blockquote></blockquote></div>
        </text>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/valueset-steward">
          <valueContactDetail>
            <name value="CSTE Steward"/>
          </valueContactDetail>
        </extension>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/valueset-author">
          <valueContactDetail>
            <name value="CSTE Author"/>
          </valueContactDetail>
        </extension>
        <url
             value="http://hl7.org/fhir/us/ph-library/ValueSet/valueset-cancer-trigger-codes-example"/>
        <version value="3.0.0"/>
        <name value="SNOMEDCancerCodesExample"/>
        <title value="SNOMED Cancer Codes Example"/>
        <status value="draft"/>
        <experimental value="true"/>
        <date value="2018-08-01"/>
        <publisher
                   value="HL7 Public Health Work Group (http://www.hl7.org/Special/committees/pher/index.cfm)"/>
        <contact>
          <name value="HL7 International - Public Health"/>
          <telecom>
            <system value="url"/>
            <value value="http://www.hl7.org/Special/committees/pher"/>
          </telecom>
        </contact>
        <description
                     value="This example set of values contains diagnoses or problems that represent that the patient may have a potentially reportable condition regardless of the clinical presentation of the condition"/>
        <useContext>
          <code>
            <system
                    value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context-type"/>
            <code value="priority"/>
            <display value="Priority"/>
          </code>
          <valueCodeableConcept>
            <coding>
              <system
                      value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context"/>
              <code value="routine"/>
              <display value="Routine"/>
            </coding>
          </valueCodeableConcept>
        </useContext>
        <useContext>
          <code>
            <system
                    value="http://terminology.hl7.org/CodeSystem/usage-context-type"/>
            <code value="program"/>
          </code>
          <valueCodeableConcept>
            <coding>
              <system
                      value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-valueset-use-context"/>
              <code value="ph-reporting"/>
              <display
                       value="ValueSet is to be used in the context of public health reporting use cases."/>
            </coding>
          </valueCodeableConcept>
        </useContext>
        <jurisdiction>
          <coding>
            <system value="urn:iso:std:iso:3166"/>
            <code value="US"/>
            <display value="United States of America"/>
          </coding>
          <text value="United States of America"/>
        </jurisdiction>
        <copyright
                   value="This value set includes content from SNOMED CT, which is copyright © 2002+ International Health Terminology Standards Development Organisation (IHTSDO), and distributed by agreement between IHTSDO and HL7. Implementer use of SNOMED CT is not covered by this agreement"/>
        <compose>
          <include>
            <system value="http://snomed.info/sct"/>
            <concept>
              <code value="281566005"/>
              <display value="Abdominothoracic neuroblastoma"/>
            </concept>
          </include>
        </compose>
      </ValueSet>
    </resource>
  </entry>
</Bundle>