US Public Health Profiles Library
2.0.0-ballot - STU 2.0.0 - Ballot
US Public Health Profiles Library
2.0.0-ballot - STU 2.0.0 - Ballot
US Public Health Profiles Library, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-us-ph-library/ and changes regularly. See the Directory of published versions
<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="http://example.org/fhir/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"><a name="PlanDefinition_plandefinition-cancer-example"> </a>
<div>
<table class="grid dict">
<tr>
<th scope="row"><b>Id: </b></th>
<td style="padding-left: 4px;">plandefinition-cancer-example</td>
</tr>
<tr>
<th scope="row"><b>Url: </b></th>
<td style="padding-left: 4px;"><a href="Bundle-us-ph-specification-bundle-example.html">PlanDefinition Cancer Reporting Example</a></td>
</tr>
<tr>
<th scope="row"><b>Version: </b></th>
<td style="padding-left: 4px;">1.0</td>
</tr>
<tr>
<th scope="row"><b>Title: </b></th>
<td style="padding-left: 4px;">PlanDefinition Cancer Reporting Example</td>
</tr>
<tr>
<th scope="row"><b>Status: </b></th>
<td style="padding-left: 4px;">draft</td>
</tr>
<tr>
<th scope="row"><b>Experimental: </b></th>
<td style="padding-left: 4px;">true</td>
</tr>
<tr>
<th scope="row"><b>Type: </b></th>
<td style="padding-left: 4px;">
<p style="margin-bottom: 5px;">
<b>system: </b> <span><a href="http://terminology.hl7.org/6.4.0/CodeSystem-plan-definition-type.html">http://terminology.hl7.org/CodeSystem/plan-definition-type</a></span>
</p>
<p style="margin-bottom: 5px;">
<b>code: </b> <span>workflow-definition</span>
</p>
<p style="margin-bottom: 5px;">
<b>display: </b> <span>Workflow Definition</span>
</p>
</td>
</tr>
<tr>
<th scope="row"><b>Date: </b></th>
<td style="padding-left: 4px;">2020-11-04 12:32:29-0500</td>
</tr>
<tr>
<th scope="row"><b>Publisher: </b></th>
<td style="padding-left: 4px;">ph-library</td>
</tr>
<tr>
<th scope="row"><b>Description: </b></th>
<td style="padding-left: 4px;"><div><p>This is the Cancer Reporting Knowledge Artifact</p>
</div></td>
</tr>
<tr>
<th scope="row"><b>Effective Period: </b></th>
<td style="padding-left: 4px;">2020-11-01..</td>
</tr>
<tr>
<th scope="row"><b>Related Artifacts: </b></th>
<td style="padding-left: 4px;">
<p><b>Dependencies</b></p>
<ul>
<li><a href="Bundle-us-ph-specification-bundle-example.html">SNOMED Cancer Codes Example</a></li>
</ul>
</td>
</tr>
<tr>
<th scope="row"><b>Actions: </b></th>
<td style="padding-left: 4px;">
<table class="grid-dict">
<tr>
<td>
Initiate Reporting Workflow
<br/>
<b>When:</b>
<i>Named Event:</i> encounter-close
<br/>
</td>
</tr>
<tr>
<td>
Check Trigger Codes
<br/>
<b>Then:</b>
<table class="grid-dict">
<tr>
<td>
<b> :</b>
<br/>
<b>If:</b>
<i>Applicability:</i>
<i>(Condition.code.memberof(http://hl7.org/fhir/us/ph-library/ValueSet/valueset-cancer-trigger-codes-example))</i>
<br/>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td>
Create Report
<br/>
</td>
</tr>
</table>
</td>
</tr>
</table>
</div>
</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="http://example.org/fhir/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"><a name="ValueSet_valueset-cancer-trigger-codes-example"> </a><p class="res-header-id"><b>Generated Narrative: ValueSet valueset-cancer-trigger-codes-example</b></p><a name="valueset-cancer-trigger-codes-example"> </a><a name="hcvalueset-cancer-trigger-codes-example"> </a><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"/><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-us-ph-valueset.html">US Public Health ValueSet</a></p></div><p><b>Artifact Author</b>: CSTE Author: </p><p><b>url</b>: <a href="Bundle-us-ph-specification-bundle-example.html">SNOMED Cancer Codes Example</a></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>: CSTE Steward</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>: </p><div><p>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>
</div><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><a href="CodeSystem-us-ph-codesystem-usage-context-type.html#us-ph-codesystem-usage-context-type-priority">US Public Health CodeSystem - Usage Context Type priority</a>: Priority</td><td><span title="Codes:{http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context routine}">Routine</span></td></tr><tr><td style="display: none">*</td><td><a href="http://terminology.hl7.org/6.4.0/CodeSystem-usage-context-type.html#usage-context-type-program">UsageContextType program</a>: Program</td><td><span title="Codes:{http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-valueset-use-context ph-reporting}">ValueSet is to be used in the context of public health reporting use cases.</span></td></tr></table><p><b>jurisdiction</b>: <span title="Codes:{urn:iso:std:iso:3166 US}">United States of America</span></p><p><b>copyright</b>: </p><div><p>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>
</div><blockquote><p><b>compose</b></p><blockquote><p><b>include</b></p><p><b>system</b>: <a href="https://browser.ihtsdotools.org/">http://snomed.info/sct</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/artifact-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="CSTE Steward"/>
<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>
IG © 2025+ HL7 International / Public Health. Package hl7.fhir.us.ph-library#2.0.0-ballot based on FHIR 4.0.1. Generated 2025-07-07
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change