US Public Health Profiles Library
2.0.0-ballot - STU 2 - Ballot
US Public Health Profiles Library
2.0.0-ballot - STU 2 - Ballot
This page is part of the US Public Health Profiles Library (v2.0.0-ballot: STU 2 Ballot) based on FHIR (HL7® FHIR® Standard) R4. This version is a pre-release. The current official version is 1.0.0. For a full list of available versions, see the Directory of published versions
{
"resourceType" : "Bundle",
"id" : "us-ph-specification-bundle-example",
"meta" : {
"versionId" : "11",
"profile" : [
🔗 "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-specification-bundle"
]
},
"type" : "collection",
"timestamp" : "2022-11-20T11:15:33-10:00",
"entry" : [
{
"fullUrl" : "http://example.org/fhir/PlanDefinition/plandefinition-cancer-example",
"resource" : {
"resourceType" : "PlanDefinition",
"id" : "plandefinition-cancer-example",
"meta" : {
"profile" : [
🔗 "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-plandefinition"
]
},
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><a name=\"PlanDefinition_plandefinition-cancer-example\"> </a>\n<div>\n <table class=\"grid dict\">\n \n <tr>\n <th scope=\"row\"><b>Id: </b></th>\n <td style=\"padding-left: 4px;\">plandefinition-cancer-example</td>\n </tr>\n \n\n \n <tr>\n <th scope=\"row\"><b>Url: </b></th>\n <td style=\"padding-left: 4px;\"><a href=\"Bundle-us-ph-specification-bundle-example.html\">PlanDefinition Cancer Reporting Example</a></td>\n </tr>\n \n\n \n <tr>\n <th scope=\"row\"><b>Version: </b></th>\n <td style=\"padding-left: 4px;\">1.0</td>\n </tr>\n \n\n \n\n \n <tr>\n <th scope=\"row\"><b>Title: </b></th>\n <td style=\"padding-left: 4px;\">PlanDefinition Cancer Reporting Example</td>\n </tr>\n \n\n \n\n \n <tr>\n <th scope=\"row\"><b>Status: </b></th>\n <td style=\"padding-left: 4px;\">draft</td>\n </tr>\n \n\n \n <tr>\n <th scope=\"row\"><b>Experimental: </b></th>\n <td style=\"padding-left: 4px;\">true</td>\n </tr>\n \n\n \n <tr>\n <th scope=\"row\"><b>Type: </b></th>\n <td style=\"padding-left: 4px;\">\n \n \n \n <p style=\"margin-bottom: 5px;\">\n <b>system: </b> <span><a href=\"http://terminology.hl7.org/6.5.0/CodeSystem-plan-definition-type.html\">http://terminology.hl7.org/CodeSystem/plan-definition-type</a></span>\n </p>\n \n \n <p style=\"margin-bottom: 5px;\">\n <b>code: </b> <span>workflow-definition</span>\n </p>\n \n \n <p style=\"margin-bottom: 5px;\">\n <b>display: </b> <span>Workflow Definition</span>\n </p>\n \n \n \n \n </td>\n </tr>\n \n\n \n\n \n <tr>\n <th scope=\"row\"><b>Date: </b></th>\n <td style=\"padding-left: 4px;\">2020-11-04 12:32:29-0500</td>\n </tr>\n \n\n \n <tr>\n <th scope=\"row\"><b>Publisher: </b></th>\n <td style=\"padding-left: 4px;\">ph-library</td>\n </tr>\n \n\n \n <tr>\n <th scope=\"row\"><b>Description: </b></th>\n <td style=\"padding-left: 4px;\"><div><p>This is the Cancer Reporting Knowledge Artifact</p>\n</div></td>\n </tr>\n \n\n \n\n \n\n \n\n \n\n \n\n \n\n \n\n \n\n \n\n \n <tr>\n <th scope=\"row\"><b>Effective Period: </b></th>\n <td style=\"padding-left: 4px;\">2020-11-01..</td>\n </tr>\n \n\n \n <tr>\n <th scope=\"row\"><b>Related Artifacts: </b></th>\n <td style=\"padding-left: 4px;\">\n \n \n \n <p><b>Dependencies</b></p>\n <ul>\n \n <li><a href=\"Bundle-us-ph-specification-bundle-example.html\">SNOMED Cancer Codes Example</a></li>\n \n </ul>\n \n \n \n \n \n </td>\n </tr>\n \n\n \n\n \n <tr>\n <th scope=\"row\"><b>Actions: </b></th>\n <td style=\"padding-left: 4px;\">\n <table class=\"grid-dict\">\n \n <tr>\n <td>\n \n Initiate Reporting Workflow\n \n <br/>\n \n <b>When:</b>\n \n <i>Named Event:</i> encounter-close\n <br/>\n \n \n \n \n \n \n </td>\n </tr>\n \n <tr>\n <td>\n \n Check Trigger Codes\n \n <br/>\n \n \n \n <b>Then:</b>\n <table class=\"grid-dict\">\n \n <tr>\n <td>\n \n <b> :</b>\n \n \n <br/>\n \n \n <b>If:</b>\n \n <i>Applicability:</i>\n \n <i>(Condition.code.memberof(http://hl7.org/fhir/us/ph-library/ValueSet/valueset-cancer-trigger-codes-example))</i>\n <br/>\n \n \n \n \n \n </td>\n </tr>\n \n </table>\n \n </td>\n </tr>\n \n <tr>\n <td>\n \n Create Report\n \n <br/>\n \n \n \n \n \n </td>\n </tr>\n \n </table>\n </td>\n </tr>\n \n </table>\n</div>\n</div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-receiver-address-extension",
"valueReference" : {
🔗 "reference" : "Endpoint/us-ph-endpoint-salem-medical-center"
}
},
{
"url" : "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-async-indicator-extension",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-expected-response-time-extension",
"valueDuration" : {
"value" : 1,
"system" : "http://unitsofmeasure.org",
"code" : "min"
}
}
],
"url" : "http://hl7.org/fhir/us/ph-library/StructureDefinition/plandefinition-cancer-example",
"version" : "1.0",
"name" : "PlanDefinitionCancerExample",
"title" : "PlanDefinition Cancer Reporting Example",
"type" : {
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/plan-definition-type",
"code" : "workflow-definition",
"display" : "Workflow Definition"
}
]
},
"status" : "draft",
"experimental" : true,
"date" : "2020-11-04T12:32:29.858-05:00",
"publisher" : "ph-library",
"description" : "This is the Cancer Reporting Knowledge Artifact",
"effectivePeriod" : {
"start" : "2020-11-01"
},
"relatedArtifact" : [
{
"type" : "depends-on",
"label" : "Cancer Trigger Codes",
"resource" : "http://hl7.org/fhir/us/ph-library/ValueSet/valueset-cancer-trigger-codes-example"
}
],
"action" : [
{
"id" : "initiate-reporting-workflow",
"description" : "This action represents the start of a reporting workflow.",
"textEquivalent" : "Initiate Reporting Workflow",
"code" : [
{
"coding" : [
{
"system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
"code" : "initiate-reporting-workflow"
}
]
}
],
"trigger" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-named-eventtype-extension",
"valueCodeableConcept" : {
"coding" : [
{
"system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-triggerdefinition-namedevents",
"code" : "encounter-close",
"display" : "Indicates the close of an encounter"
}
]
}
}
],
"type" : "named-event",
"name" : "encounter-close"
}
],
"relatedAction" : [
{
"actionId" : "check-trigger-codes",
"relationship" : "before-start",
"offsetDuration" : {
"value" : 1,
"system" : "http://unitsofmeasure.org",
"code" : "min"
}
}
]
},
{
"id" : "check-trigger-codes",
"description" : "This action represents the execution of the checking trigger codes in the workflow.",
"textEquivalent" : "Check Trigger Codes",
"action" : [
{
"code" : [
{
"coding" : [
{
"system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
"code" : "check-trigger-codes"
}
]
}
],
"condition" : [
{
"kind" : "applicability",
"expression" : {
"language" : "text/fhirpath",
"expression" : "Condition.code.memberof(http://hl7.org/fhir/us/ph-library/ValueSet/valueset-cancer-trigger-codes-example)"
}
}
],
"relatedAction" : [
{
"actionId" : "create-report",
"relationship" : "before-start"
}
]
}
]
},
{
"id" : "create-report",
"description" : "This action represents the creation of a cancer report.",
"textEquivalent" : "Create Report",
"code" : [
{
"coding" : [
{
"system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
"code" : "create-report"
}
]
}
]
}
]
}
},
{
"fullUrl" : "http://example.org/fhir/ValueSet/valueset-cancer-trigger-codes-example",
"resource" : {
"resourceType" : "ValueSet",
"id" : "valueset-cancer-trigger-codes-example",
"meta" : {
"profile" : [
🔗 "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-valueset"
]
},
"text" : {
"status" : "extensions",
"div" : "<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>\n</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.5.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>\n</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>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/artifact-author",
"valueContactDetail" : {
"name" : "CSTE Author"
}
}
],
"url" : "http://hl7.org/fhir/us/ph-library/ValueSet/valueset-cancer-trigger-codes-example",
"version" : "3.0.0",
"name" : "SNOMEDCancerCodesExample",
"title" : "SNOMED Cancer Codes Example",
"status" : "draft",
"experimental" : true,
"date" : "2018-08-01",
"publisher" : "CSTE Steward",
"contact" : [
{
"name" : "HL7 International - Public Health",
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/pher"
}
]
}
],
"description" : "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" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context-type",
"code" : "priority",
"display" : "Priority"
},
"valueCodeableConcept" : {
"coding" : [
{
"system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-usage-context",
"code" : "routine",
"display" : "Routine"
}
]
}
},
{
"code" : {
"system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
"code" : "program"
},
"valueCodeableConcept" : {
"coding" : [
{
"system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-valueset-use-context",
"code" : "ph-reporting",
"display" : "ValueSet is to be used in the context of public health reporting use cases."
}
]
}
}
],
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "US",
"display" : "United States of America"
}
],
"text" : "United States of America"
}
],
"copyright" : "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" : "http://snomed.info/sct",
"concept" : [
{
"code" : "281566005",
"display" : "Abdominothoracic neuroblastoma"
}
]
}
]
}
}
}
]
}
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-30
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change