US Public Health Profiles Library
1.0.0 - STU1
US Public Health Profiles Library
1.0.0 - STU1
US Public Health Profiles Library, published by HL7 Public Health Work Group. This guide is not an authorized publication; it is the continuous build for version 1.0.0 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
{
"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" : "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><p class=\"res-header-id\"><b>Generated Narrative: PlanDefinition plandefinition-cancer-example</b></p><a name=\"plandefinition-cancer-example\"> </a><a name=\"hcplandefinition-cancer-example\"> </a><a name=\"plandefinition-cancer-example-en-US\"> </a><p><b>US Public Health Receiver Address Extension</b>: <a href=\"Endpoint-us-ph-endpoint-salem-medical-center.html\">Endpoint: status = active; connectionType = HL7 FHIR (Endpoint Connection Type#hl7-fhir-rest); payloadType = ; address = http://example.org/salem-medical-center/fhir</a></p><p><b>US Public Health Async Indicator Extension</b>: true</p><p><b>US Public Health Expected Response Time Extension</b>: No display for Duration (value: 1; system: http://unitsofmeasure.org; code: min)</p><p><b>url</b>: <a href=\"Bundle-us-ph-specification-bundle-example.html\">PlanDefinition PlanDefinition Cancer Reporting Example</a></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>: <span title=\"Codes:{http://terminology.hl7.org/CodeSystem/plan-definition-type workflow-definition}\">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>: </p><div><p>This is the Cancer Reporting Knowledge Artifact</p>\n</div><p><b>effectivePeriod</b>: 2020-11-01 --> (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>: <span title=\"Codes:{http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions initiate-reporting-workflow}\">Initiate a 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>No display for Duration (value: 1; system: http://unitsofmeasure.org; code: min)</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>: <span title=\"Codes:{http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions check-trigger-codes}\">Evaluate candidate patient's data against trigger codes to determine reportability</span></p><blockquote><p><b>condition</b></p><p><b>kind</b>: Applicability</p><h3>Expressions</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Language</b></td><td><b>Expression</b></td></tr><tr><td style=\"display: none\">*</td><td>FHIRPath</td><td>Condition.code.memberof(http://hl7.org/fhir/us/ph-library/ValueSet/valueset-cancer-trigger-codes-example)</td></tr></table></blockquote><h3>RelatedActions</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>ActionId</b></td><td><b>Relationship</b></td></tr><tr><td style=\"display: none\">*</td><td>create-report</td><td>Before Start</td></tr></table></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>: <span title=\"Codes:{http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions create-report}\">Create a Report containing Patient's data for patients who passed the check-reportability test</span></p></blockquote></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" : "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><a name=\"valueset-cancer-trigger-codes-example-en-US\"> </a><p><b>steward</b>: CSTE Steward: </p><p><b>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>: 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>: </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.0.2/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=\"http://hl7.org/fhir/R4/codesystem-snomedct.html\">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/valueset-steward",
"valueContactDetail" : {
"name" : "CSTE Steward"
}
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/valueset-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" : "HL7 Public Health Work Group (http://www.hl7.org/Special/committees/pher/index.cfm)",
"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 © 2023+ HL7 Public Health Work Group. Package hl7.fhir.us.ph-library#1.0.0 based on FHIR 4.0.1. Generated 2024-11-18
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change