Package | hl7.fhir.us.resp-net |
Resource Type | PlanDefinition |
Id | plandefinition-example |
FHIR Version | R4 |
Source | http://hl7.org/fhir/us/resp-net/https://build.fhir.org/ig/HL7/fhir-resp-net-ig/PlanDefinition-plandefinition-example.html |
URL | http://hl7.org/fhir/us/resp-net/StructureDefinition/plandefinition-example |
Version | 2.0.0-ballot |
Status | active |
Date | 2023-06-01T12:32:29.858-05:00 |
Name | PlanDefinitionRespNetExample |
Title | PlanDefinition RESP-NET Example |
Realm | us |
Authority | hl7 |
Description | This is the RESP-NET Knowledge Artifact |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Narrative: RESP-NET PlanDefinition Example
{ "resourceType": "PlanDefinition", "id": "plandefinition-example", "meta": { "versionId": "1", "lastUpdated": "2020-11-29T02:03:28.045+00:00", "profile": [ "http://hl7.org/fhir/us/resp-net/StructureDefinition/respnet-plandefinition" ] }, "text": { "status": "extensions", "div": "<!-- snip (see above) -->" }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/variable", "valueExpression": { "name": "normalReportingDuration", "language": "text/fhirpath", "expression": "1500" } }, { "url": "http://hl7.org/fhir/StructureDefinition/variable", "valueExpression": { "name": "encounterStartDate", "language": "text/fhirpath", "expression": "{{context.encounterStartDate}}" } }, { "url": "http://hl7.org/fhir/StructureDefinition/variable", "valueExpression": { "name": "encounterEndDate", "language": "text/fhirpath", "expression": "{{context.encounterEndDate}}" } } ], "url": "http://hl7.org/fhir/us/resp-net/StructureDefinition/plandefinition-example", "identifier": [ { "system": "urn:ietf:rfc:3986", "value": "urn:oid:2.16.840.1.113883.4.642.40.52.34.1" } ], "version": "2.0.0-ballot", "name": "PlanDefinitionRespNetExample", "title": "PlanDefinition RESP-NET Example", "type": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/plan-definition-type", "code": "workflow-definition", "display": "Workflow Definition" } ] }, "status": "active", "experimental": false, "date": "2023-06-01T12:32:29.858-05:00", "publisher": "HL7 International / Public Health", "contact": [ { "telecom": [ { "system": "url", "value": "http://www.hl7.org/Special/committees/pher" } ] } ], "description": "This is the RESP-NET Knowledge Artifact", "jurisdiction": [ { "coding": [ { "system": "urn:iso:std:iso:3166", "code": "US" } ] } ], "effectivePeriod": { "start": "2024-11-01" }, "relatedArtifact": [ { "type": "depends-on", "label": "RESPNet Valueset Library", "resource": "http://hl7.org/fhir/us/resp-net/Library/respnet-valuesets-example2" } ], "action": [ { "id": "start-workflow", "description": "This action represents the start of the reporting workflow in response to a named event", "textEquivalent": "Start the reporting workflow in response to a named event", "code": [ { "coding": [ { "system": "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions", "code": "initiate-reporting-workflow" } ] } ], "trigger": [ { "id": "encounter-close", "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" }, { "id": "encounter-start", "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-start", "display": "Indicates the start of an encounter" } ] } } ], "type": "named-event", "name": "encounter-start" } ], "input": [ { "id": "patient", "extension": [ { "url": "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-fhirquerypattern-extension", "valueString": "Patient/{{context.patientId}}" } ], "type": "Patient" }, { "id": "encounter", "extension": [ { "url": "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-fhirquerypattern-extension", "valueString": "Encounter/{{context.encounterId}}" } ], "type": "Encounter" } ], "relatedAction": [ { "actionId": "check-reportability", "relationship": "before-start", "offsetDuration": { "value": 1, "system": "http://unitsofmeasure.org", "code": "h" } } ] }, { "id": "check-reportability", "description": "This action represents the start of the check for reportable conditions and labresults in response to the named event.", "textEquivalent": "Check Reportability workflow", "code": [ { "coding": [ { "system": "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions", "code": "execute-reporting-workflow" } ] } ], "action": [ { "id": "is-hospital-based-influenza-case", "description": "Check for reportability of a hospital based influenza case", "textEquivalent": "Check for hospital based influenza case", "code": [ { "coding": [ { "system": "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions", "code": "evaluate-condition" } ] } ], "condition": [ { "kind": "applicability", "expression": { "language": "text/fhirpath", "expression": "%fluTestEncounter.where(status = 'in-progress' or status = 'arrived') and %encounterStartDate + 1 day * %normalReportingDuration >= now() and %positiveFluTestResults.exists()" } } ], "input": [ { "id": "positiveFluTestResults", "extension": [ { "url": "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-fhirquerypattern-extension", "valueString": "Observation?patient=Patient/{{context.patientId}}" } ], "type": "Observation", "codeFilter": [ { "path": "code", "valueSet": "http://hl7.org/fhir/us/resp-net/ValueSet/resp-net-labtest-flu-codes|2.0.0" }, { "path": "value", "valueSet": "http://hl7.org/fhir/us/resp-net/ValueSet/resp-net-positive-result-codes|2.0.0" } ] }, { "id": "fluTestEncounter", "extension": [ { "url": "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-relateddata-extension", "valueString": "encounter" } ], "type": "Encounter" } ], "relatedAction": [ { "actionId": "create-resp-net-report", "relationship": "before-start" } ] }, { "id": "is-clinical-surveillance-influena-case", "description": "Check for reportability of a clincial surveillance influenza case", "textEquivalent": "Check for clinical surveillance influenza case", "code": [ { "coding": [ { "system": "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions", "code": "evaluate-condition" } ] } ], "condition": [ { "kind": "applicability", "expression": { "language": "text/fhirpath", "expression": "%influenzaTestEncounter.where(status = 'finished') and %encounterStartDate + 1 day * %normalReportingDuration >= now() and %positiveInfluenzaTestResults.exists()" } } ], "input": [ { "id": "positiveInfluenzaTestResults", "extension": [ { "url": "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-fhirquerypattern-extension", "valueString": "Observation?patient=Patient/{{context.patientId}}" } ], "type": "Observation", "codeFilter": [ { "path": "code", "valueSet": "http://hl7.org/fhir/us/resp-net/ValueSet/resp-net-labtest-flu-codes|2.0.0" }, { "path": "value", "valueSet": "http://hl7.org/fhir/us/resp-net/ValueSet/resp-net-positive-result-codes|2.0.0" } ] }, { "id": "influenzaTestEncounter", "extension": [ { "url": "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-relateddata-extension", "valueString": "encounter" } ], "type": "Encounter" } ], "relatedAction": [ { "actionId": "create-resp-net-report", "relationship": "before-start" } ] }, { "id": "is-hospital-disease-burden-case", "description": "Check for reportability of a hospital disease burden case", "textEquivalent": "Check for hospital disease burden case", "code": [ { "coding": [ { "system": "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions", "code": "evaluate-condition" } ] } ], "condition": [ { "kind": "applicability", "expression": { "language": "text/fhirpath", "expression": "%diseaseEncounter.where(status = 'finished') and %encounterStartDate + 1 day * %normalReportingDuration >= now() and %ariConditions.exists() and (%labTests.exists() or %diagnosticReports.exists())" } } ], "input": [ { "id": "labTests", "extension": [ { "url": "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-fhirquerypattern-extension", "valueString": "Observation?patient=Patient/{{context.patientId}}" } ], "type": "Observation", "codeFilter": [ { "path": "code", "valueSet": "http://hl7.org/fhir/us/resp-net/ValueSet/resp-net-labtest-flu-rsv-covid-codes|2.0.0" } ] }, { "id": "diagnosticReports", "extension": [ { "url": "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-fhirquerypattern-extension", "valueString": "DiagnosticReport?patient=Patient/{{context.patientId}}" } ], "type": "DiagnosticReport", "codeFilter": [ { "path": "code", "valueSet": "http://hl7.org/fhir/us/resp-net/ValueSet/resp-net-labtest-flu-rsv-covid-codes|2.0.0" } ] }, { "id": "diseaseEncounter", "extension": [ { "url": "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-relateddata-extension", "valueString": "encounter" } ], "type": "Encounter" }, { "id": "ariConditions", "extension": [ { "url": "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-fhirquerypattern-extension", "valueString": "Condition?patient=Patient/{{context.patientId}}" } ], "type": "Condition", "codeFilter": [ { "path": "code", "valueSet": "http://hl7.org/fhir/us/resp-net/ValueSet/resp-net-ari-test-codes|2.0.0" } ] } ], "relatedAction": [ { "actionId": "create-resp-net-report", "relationship": "before-start" } ] }, { "id": "is-covid19-surveillance-case", "description": "Check for reportability of a covid-19 surveillance case", "textEquivalent": "Check for covid-19 surveillance case", "code": [ { "coding": [ { "system": "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions", "code": "evaluate-condition" } ] } ], "condition": [ { "kind": "applicability", "expression": { "language": "text/fhirpath", "expression": "%covidEncounter.where(status = 'finished') and %encounterStartDate + 1 day * %normalReportingDuration >= now() and %positiveCovidTestResults.exists()" } } ], "input": [ { "id": "positiveCovidTestResults", "extension": [ { "url": "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-fhirquerypattern-extension", "valueString": "Observation?patient=Patient/{{context.patientId}}" } ], "type": "Observation", "codeFilter": [ { "path": "code", "valueSet": "http://hl7.org/fhir/us/resp-net/ValueSet/resp-net-labtest-covid-codes|2.0.0" }, { "path": "value", "valueSet": "http://hl7.org/fhir/us/resp-net/ValueSet/resp-net-positive-result-codes|2.0.0" } ] }, { "id": "covidEncounter", "extension": [ { "url": "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-relateddata-extension", "valueString": "encounter" } ], "type": "Encounter" } ], "relatedAction": [ { "actionId": "create-resp-net-report", "relationship": "before-start" } ] }, { "id": "is-rsv-surveillance-case", "description": "Check for reportability of a RSV surveillance case", "textEquivalent": "Check for RSV surveillance case", "code": [ { "coding": [ { "system": "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions", "code": "evaluate-condition" } ] } ], "condition": [ { "kind": "applicability", "expression": { "language": "text/fhirpath", "expression": "%rsvEncounter.where(status = 'finished') and %encounterStartDate + 1 day * %normalReportingDuration >= now() and %positiveRsvTestResults.exists()" } } ], "input": [ { "id": "positiveRsvTestResults", "extension": [ { "url": "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-fhirquerypattern-extension", "valueString": "Observation?patient=Patient/{{context.patientId}}" } ], "type": "Observation", "codeFilter": [ { "path": "code", "valueSet": "http://hl7.org/fhir/us/resp-net/ValueSet/resp-net-labtest-rsv-codes|2.0.0" }, { "path": "value", "valueSet": "http://hl7.org/fhir/us/resp-net/ValueSet/resp-net-positive-result-codes|2.0.0" } ] }, { "id": "rsvEncounter", "extension": [ { "url": "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-relateddata-extension", "valueString": "encounter" } ], "type": "Encounter" } ], "relatedAction": [ { "actionId": "create-resp-net-report", "relationship": "before-start" } ] }, { "id": "is-influenza-effectiveness-evaluation-case", "description": "Check for reportability of a influenza vaccine effectiveness case", "textEquivalent": "Check for influenza vaccine effectiveness case", "code": [ { "coding": [ { "system": "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions", "code": "evaluate-condition" } ] } ], "condition": [ { "kind": "applicability", "expression": { "language": "text/fhirpath", "expression": "%influenzaEffectivenessEncounter.where(status = 'finished') and %encounterStartDate + 1 day * %normalReportingDuration >= now() and %negativeFluTestResults.exists()" } } ], "input": [ { "id": "negativeFluTestResults", "extension": [ { "url": "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-fhirquerypattern-extension", "valueString": "Observation?patient=Patient/{{context.patientId}}" } ], "type": "Observation", "codeFilter": [ { "path": "code", "valueSet": "http://hl7.org/fhir/us/resp-net/ValueSet/resp-net-labtest-flu-codes|2.0.0" }, { "path": "value", "valueSet": "http://hl7.org/fhir/us/resp-net/ValueSet/resp-net-negative-result-codes|2.0.0" } ] }, { "id": "influenzaEffectivenessEncounter", "extension": [ { "url": "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-relateddata-extension", "valueString": "encounter" } ], "type": "Encounter" } ], "relatedAction": [ { "actionId": "create-resp-net-report", "relationship": "before-start" } ] }, { "id": "continue-to-check-reportability", "description": "Continue to Check for reportability of RESPNet cases until 72 hours after encounter closure", "textEquivalent": "Continue to Check for reportability of RESPNet cases until 72 hours after encounter closure", "code": [ { "coding": [ { "system": "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions", "code": "evaluate-condition" } ] } ], "condition": [ { "kind": "applicability", "expression": { "language": "text/fhirpath", "expression": "%contextEncounter.where(status = 'finished') and %encounterEndDate + 72 hours >= now()" } } ], "input": [ { "id": "contextEncounter", "extension": [ { "url": "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-relateddata-extension", "valueString": "encounter" } ], "type": "Encounter" } ], "relatedAction": [ { "actionId": "check-reportability", "relationship": "before-start", "offsetDuration": { "value": 24, "system": "http://unitsofmeasure.org", "code": "h" } } ] } ] }, { "id": "create-resp-net-report", "description": "This action represents the creation, validation and submission of the RESP-NET report.", "textEquivalent": "Create Report and send to RESP-NET site.", "code": [ { "coding": [ { "system": "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions", "code": "create-report" } ] } ], "input": [ { "id": "contextPatient", "extension": [ { "url": "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-fhirquerypattern-extension", "valueString": "Patient/{{context.patientId}}" } ], "type": "Patient" }, { "id": "conditions", "extension": [ { "url": "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-fhirquerypattern-extension", "valueString": "Condition?patient=Patient/{{context.patientId}}&clinical-status=http://terminology.hl7.org/CodeSystem/condition-clinical|active" } ], "type": "Condition" }, { "id": "allergies", "extension": [ { "url": "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-fhirquerypattern-extension", "valueString": "AllergyIntolerance?patient=Patient/{{context.patientId}}" } ], "type": "AllergyIntolerance" }, { "id": "careteam", "extension": [ { "url": "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-fhirquerypattern-extension", "valueString": "CareTeam?patient=Patient/{{context.patientId}}" } ], "type": "CareTeam" }, { "id": "careplan", "extension": [ { "url": "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-fhirquerypattern-extension", "valueString": "CarePlan?patient=Patient/{{context.patientId}}" } ], "type": "CarePlan" }, { "id": "goals", "extension": [ { "url": "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-fhirquerypattern-extension", "valueString": "Goal?patient=Patient/{{context.patientId}}" } ], "type": "Goal" }, { "id": "reportableEncounter", "extension": [ { "url": "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-fhirquerypattern-extension", "valueString": "Encounter/{{context.encounterId}}" } ], "type": "Encounter" }, { "id": "medRequests", "extension": [ { "url": "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-fhirquerypattern-extension", "valueString": "MedicationRequest?patient=Patient/{{context.patientId}}&intent=order" } ], "type": "MedicationRequest" }, { "id": "medStatements", "extension": [ { "url": "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-fhirquerypattern-extension", "valueString": "MedicationStatement?patient=Patient/{{context.patientId}}" } ], "type": "MedicationStatement" }, { "id": "medAdms", "extension": [ { "url": "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-fhirquerypattern-extension", "valueString": "MedicationAdministration?patient=Patient/{{context.patientId}}" } ], "type": "MedicationAdministration" }, { "id": "vitals", "extension": [ { "url": "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-fhirquerypattern-extension", "valueString": "Observation?patient=Patient/{{context.patientId}}&category=http://terminology.hl7.org/CodeSystem/observation-category|vital-signs" } ], "type": "Observation" }, { "id": "socialHistory", "extension": [ { "url": "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-fhirquerypattern-extension", "valueString": "Observation?patient=Patient/{{context.patientId}}&category=http://terminology.hl7.org/CodeSystem/observation-category|social-history" } ], "type": "Observation" }, { "id": "diagnosticOrders", "extension": [ { "url": "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-fhirquerypattern-extension", "valueString": "DiagnosticReport?patient=Patient/{{context.patientId}}" } ], "type": "DiagnosticReport" }, { "id": "serviceRequests", "extension": [ { "url": "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-fhirquerypattern-extension", "valueString": "ServiceRequest?patient=Patient/{{context.patientId}}" } ], "type": "ServiceRequest" }, { "id": "procedures", "extension": [ { "url": "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-fhirquerypattern-extension", "valueString": "Procedure?patient=Patient/{{context.patientId}}" } ], "type": "Procedure" }, { "id": "implantableDevices", "extension": [ { "url": "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-fhirquerypattern-extension", "valueString": "Device?patient=Patient/{{context.patientId}}" } ], "type": "Device" }, { "id": "labs", "extension": [ { "url": "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-fhirquerypattern-extension", "valueString": "Observation?patient=Patient/{{context.patientId}}&category=http://terminology.hl7.org/CodeSystem/observation-category|laboratory" } ], "type": "Observation" } ], "output": [ { "id": "resp-net-report", "type": "Bundle", "profile": [ "http://hl7.org/fhir/us/resp-net/StructureDefinition/resp-net-reporting-bundle" ] } ], "relatedAction": [ { "actionId": "validate-resp-net-report", "relationship": "before-start" } ] }, { "id": "validate-resp-net-report", "description": "This action represents the validation of the RESP-NET Report", "textEquivalent": "Validate Report", "code": [ { "coding": [ { "system": "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions", "code": "validate-report" } ] } ], "input": [ { "id": "created-resp-net-report", "extension": [ { "url": "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-relateddata-extension", "valueString": "resp-net-report" } ], "type": "Bundle", "profile": [ "http://hl7.org/fhir/us/resp-net/StructureDefinition/resp-net-reporting-bundle" ] } ], "output": [ { "id": "validated-resp-net-report", "type": "Bundle", "profile": [ "http://hl7.org/fhir/us/resp-net/StructureDefinition/resp-net-reporting-bundle" ] } ], "relatedAction": [ { "actionId": "submit-resp-net-report", "relationship": "before-start" } ] }, { "id": "submit-resp-net-report", "description": "This action represents the routing and sending of the RESP-NET Report", "textEquivalent": "Route and send RESP-NET Report", "code": [ { "coding": [ { "system": "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions", "code": "submit-report" } ] } ], "input": [ { "id": "valid-resp-net-report", "extension": [ { "url": "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-relateddata-extension", "valueString": "validated-resp-net-report" } ], "type": "Bundle", "profile": [ "http://hl7.org/fhir/us/resp-net/StructureDefinition/resp-net-reporting-bundle" ] } ] } ] }