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