{
"description": "An example ersd PlanDefinition",
"_filename": "example/PlanDefinition-plandefinition-ersd-instance-simple-example.json",
"package_name": "hl7.fhir.us.ecr",
"date": "2020-07-31T12:32:29.858-05:00",
"meta": {
"profile": [ "http://hl7.org/fhir/us/ecr/StructureDefinition/ersd-plandefinition" ]
},
"publisher": "HL7 International / Public Health",
"jurisdiction": [ {
"text": "United States of America",
"coding": [ {
"code": "US",
"system": "urn:iso:std:iso:3166",
"display": "United States of America"
} ]
} ],
"name": "PlanDefinition_eRSD_Instance_Simple_Example",
"type": "{:coding [{:system \\\"http://terminology.hl7.org/CodeSystem/plan-definition-type\\\", :code \\\"workflow-definition\\\", :display \\\"Workflow Definition\\\"}]}",
"experimental": "true",
"resourceType": "PlanDefinition",
"title": "eRSD PlanDefinition Instance Simple Example",
"package_version": "2.1.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/variable",
"valueExpression": {
"name": "normalReportingDuration",
"language": "text/fhirpath",
"expression": "2 weeks"
}
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "pher"
} ],
"status": "active",
"id": "8699f5c9-2148-427e-9047-7c4bc3a7de09",
"kind": null,
"url": "http://hl7.org/fhir/us/ecr/PlanDefinition/plandefinition-ersd-instance-simple-example",
"action": [ {
"id": "start-workflow",
"code": [ {
"coding": [ {
"code": "initiate-reporting-workflow",
"system": "http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actions",
"display": "Initiate a reporting workflow"
} ]
} ],
"input": [ {
"id": "patient",
"type": "Patient",
"extension": [ {
"url": "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-fhirquerypattern-extension",
"valueString": "Patient/{{context.patientId}}"
} ]
}, {
"id": "encounter",
"type": "Encounter",
"extension": [ {
"url": "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-fhirquerypattern-extension",
"valueString": "Encounter/{{context.encounterId}}"
} ]
} ],
"trigger": [ {
"id": "encounter-start",
"name": "encounter-start",
"type": "named-event",
"extension": [ {
"url": "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension",
"valueCodeableConcept": {
"coding": [ {
"code": "encounter-start",
"system": "http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-triggerdefinition-namedevents",
"display": "Indicates the start of an encounter"
} ]
}
} ]
} ],
"description": "This action represents the start of the reporting workflow in response to the encounter-start event.",
"relatedAction": [ {
"actionId": "check-suspected-disorder",
"relationship": "before-start",
"offsetDuration": {
"code": "h",
"value": 1,
"system": "http://unitsofmeasure.org"
}
} ],
"textEquivalent": "Start the reporting workflow in response to an encounter-start event"
}, {
"id": "check-suspected-disorder",
"code": [ {
"coding": [ {
"code": "execute-reporting-workflow",
"system": "http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actions"
} ]
} ],
"action": [ {
"id": "is-encounter-suspected-disorder",
"code": [ {
"coding": [ {
"code": "check-trigger-codes",
"system": "http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actions"
} ]
} ],
"input": [ {
"id": "modifiedConditions",
"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/ecr/ValueSet/valueset-sdtc-example"
} ]
}, {
"id": "modifiedLabResults",
"type": "Observation",
"extension": [ {
"url": "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-fhirquerypattern-extension",
"valueString": "Observation?patient=Patient/{{context.patientId}}"
} ],
"codeFilter": [ {
"path": "value",
"valueSet": "http://hl7.org/fhir/us/ecr/ValueSet/valueset-lotc-example"
} ]
}, {
"id": "modifiedMedicationOrders",
"type": "MedicationRequest",
"extension": [ {
"url": "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-fhirquerypattern-extension",
"valueString": "MedicationRequest?patient=Patient/{{context.patientId}}"
} ],
"codeFilter": [ {
"path": "medication",
"valueSet": "http://hl7.org/fhir/us/ecr/ValueSet/valueset-mrtc-example"
} ]
} ],
"condition": [ {
"kind": "applicability",
"expression": {
"language": "text/fhirpath",
"expression": "%modifiedConditions.exists() or %modifiedLabResults.exists() or %modifiedMedicationOrders.exists()"
}
} ],
"description": "This action represents the check for suspected disorder reportability to create the patients eICR.",
"relatedAction": [ {
"actionId": "create-eicr",
"relationship": "before-start"
} ],
"textEquivalent": "Check Trigger Codes based on Suspected Reportable Value set."
}, {
"id": "continue-check-reportable",
"code": [ {
"coding": [ {
"code": "evaluate-condition",
"system": "http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actions"
} ]
} ],
"condition": [ {
"kind": "applicability",
"expression": {
"language": "text/fhirpath",
"expression": "%encounter.where((status = 'in-progress' and period.start + %normalReportingDuration < now()) or status = 'finished' and period.end <= now() - 72 hours)"
}
} ],
"relatedAction": [ {
"actionId": "check-reportable",
"relationship": "before-start",
"offsetDuration": {
"code": "h",
"value": 6,
"system": "http://unitsofmeasure.org",
"comparator": "<="
}
} ]
} ],
"description": "This action represents the start of the check suspected disorder reporting workflow in response to the encounter-start event.",
"textEquivalent": "Check suspected disorders for immediate reportability and setup jobs for future reportability checks."
}, {
"id": "check-reportable",
"code": [ {
"coding": [ {
"code": "execute-reporting-workflow",
"system": "http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actions"
} ]
} ],
"action": [ {
"id": "is-encounter-reportable",
"code": [ {
"coding": [ {
"code": "check-trigger-codes",
"system": "http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actions"
} ]
} ],
"input": [ {
"id": "conditions",
"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/ecr/ValueSet/valueset-dxtc-example"
} ]
}, {
"id": "encounters",
"type": "Encounter",
"extension": [ {
"url": "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension",
"valueString": "encounter"
} ],
"codeFilter": [ {
"path": "reasonCode",
"valueSet": "http://hl7.org/fhir/us/ecr/ValueSet/valueset-dxtc-example"
} ]
}, {
"id": "immunizations",
"type": "Immunization",
"extension": [ {
"url": "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-fhirquerypattern-extension",
"valueString": "Immunization?patient=Patient/{{context.patientId}}"
} ],
"codeFilter": [ {
"path": "vaccineCode",
"valueSet": "http://hl7.org/fhir/us/ecr/ValueSet/valueset-mrtc-example"
} ]
}, {
"id": "labOrders",
"type": "ServiceRequest",
"extension": [ {
"url": "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-fhirquerypattern-extension",
"valueString": "ServiceRequest?patient=Patient/{{context.patientId}}"
} ],
"codeFilter": [ {
"path": "code",
"valueSet": "http://hl7.org/fhir/us/ecr/ValueSet/valueset-lotc-example"
} ]
}, {
"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/ecr/ValueSet/valueset-lotc-example"
} ]
}, {
"id": "diagnosticOrders",
"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/ecr/ValueSet/valueset-lotc-example"
} ]
}, {
"id": "procedureOrders",
"type": "ServiceRequest",
"extension": [ {
"url": "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-fhirquerypattern-extension",
"valueString": "ServiceRequest?patient=Patient/{{context.patientId}}"
} ],
"codeFilter": [ {
"path": "code",
"valueSet": "http://hl7.org/fhir/us/ecr/ValueSet/valueset-pctc-example"
} ]
}, {
"id": "procedures",
"type": "Procedure",
"extension": [ {
"url": "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-fhirquerypattern-extension",
"valueString": "Procedure?patient=Patient/{{context.patientId}}"
} ],
"codeFilter": [ {
"path": "code",
"valueSet": "http://hl7.org/fhir/us/ecr/ValueSet/valueset-pctc-example"
} ]
}, {
"id": "medicationOrders",
"type": "MedicationRequest",
"extension": [ {
"url": "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-fhirquerypattern-extension",
"valueString": "MedicationRequest?patient=Patient/{{context.patientId}}"
} ],
"codeFilter": [ {
"path": "medication",
"valueSet": "http://hl7.org/fhir/us/ecr/ValueSet/valueset-mrtc-example"
} ]
}, {
"id": "medicationDispenses",
"type": "MedicationDispense",
"extension": [ {
"url": "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-fhirquerypattern-extension",
"valueString": "MedicationDispense?patient=Patient/{{context.patientId}}"
} ],
"codeFilter": [ {
"path": "medication",
"valueSet": "http://hl7.org/fhir/us/ecr/ValueSet/valueset-mrtc-example"
} ]
}, {
"id": "medicationAdministrations",
"type": "MedicationAdministration",
"extension": [ {
"url": "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-fhirquerypattern-extension",
"valueString": "MedicationAdministration?patient=Patient/{{context.patientId}}"
} ],
"codeFilter": [ {
"path": "medication",
"valueSet": "http://hl7.org/fhir/us/ecr/ValueSet/valueset-mrtc-example"
} ]
}, {
"id": "labResults",
"type": "Observation",
"extension": [ {
"url": "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension",
"valueString": "labTests"
} ],
"codeFilter": [ {
"path": "value",
"valueSet": "http://hl7.org/fhir/us/ecr/ValueSet/valueset-ostc-example"
} ]
}, {
"id": "diagnosticResults",
"type": "DiagnosticReport",
"extension": [ {
"url": "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension",
"valueString": "diagnosticOrders"
} ],
"codeFilter": [ {
"path": "code",
"valueSet": "http://hl7.org/fhir/us/ecr/ValueSet/valueset-ostc-example"
} ]
} ],
"condition": [ {
"kind": "applicability",
"expression": {
"language": "text/fhirpath",
"expression": "%encounter.where(period.start + %normalReportingDuration >= now()) and (%conditions.exists() or %encounters.exists() or %immunizations.exists() or %procedures.exists() or %procedureOrders.exists() or %labOrders.exists() or %labTests.exists() or %labResults.exists() or %medicationAdministrations.exists() or %medicationOrders.exists() or %medicationDispenses.exists())"
}
} ],
"description": "This action represents the check for reportability to create the patients eICR.",
"relatedAction": [ {
"actionId": "create-eicr",
"relationship": "before-start"
} ],
"textEquivalent": "Check Trigger Codes based on RCTC Value sets."
}, {
"id": "check-update-eicr",
"code": [ {
"coding": [ {
"code": "evaluate-condition",
"system": "http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actions"
} ]
} ],
"input": [ {
"id": "last-eicr",
"type": "Bundle",
"profile": [ "http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle" ],
"extension": [ {
"url": "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension",
"valueString": "eicr-report"
} ]
} ],
"condition": [ {
"kind": "applicability",
"expression": {
"language": "text/fhirpath",
"expression": "%last-eicr.last().entry.first().resource.date < now() - 72 hours"
}
} ],
"relatedAction": [ {
"actionId": "create-eicr",
"relationship": "before-start"
} ]
}, {
"id": "is-encounter-in-progress",
"code": [ {
"coding": [ {
"code": "evaluate-condition",
"system": "http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actions"
} ]
} ],
"input": [ {
"id": "inprogress-encounter",
"type": "Encounter",
"extension": [ {
"url": "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension",
"valueString": "encounter"
} ]
} ],
"condition": [ {
"kind": "applicability",
"expression": {
"language": "text/fhirpath",
"expression": "%`inprogress-encounter`.where(status = 'in-progress' and period.start + %normalReportingDuration >= now() and period.end <= now() - 72 hours)"
}
} ],
"relatedAction": [ {
"actionId": "check-reportable",
"relationship": "before-start",
"offsetDuration": {
"code": "h",
"value": 6,
"system": "http://unitsofmeasure.org",
"comparator": "<="
}
} ]
}, {
"id": "is-encounter-completed",
"code": [ {
"coding": [ {
"code": "complete-reporting",
"system": "http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actions"
} ]
} ],
"input": [ {
"id": "completedEncounter",
"type": "Encounter",
"extension": [ {
"url": "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension",
"valueString": "encounter"
} ]
} ],
"condition": [ {
"kind": "applicability",
"expression": {
"language": "text/fhirpath",
"expression": "%completedEncounter.exists(status = 'finished')"
}
} ]
} ],
"description": "This action represents the check for suspected reportability of the eICR.",
"textEquivalent": "Check Reportability and setup jobs for future reportability checks."
}, {
"id": "create-eicr",
"code": [ {
"coding": [ {
"code": "create-report",
"system": "http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actions"
} ]
} ],
"input": [ {
"id": "patient-data",
"type": "Patient",
"profile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient" ],
"extension": [ {
"url": "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension",
"valueString": "patient"
} ]
}, {
"id": "condition-data",
"type": "Condition",
"profile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition" ],
"extension": [ {
"url": "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension",
"valueString": "conditions"
} ]
}, {
"id": "encounter-data",
"type": "Encounter",
"profile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter" ],
"extension": [ {
"url": "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension",
"valueString": "encounters"
} ]
}, {
"id": "mr-data",
"type": "MedicationRequest",
"profile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest" ],
"extension": [ {
"url": "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension",
"valueString": "medicationOrders"
} ]
}, {
"id": "immz-data",
"type": "Immunization",
"profile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization" ],
"extension": [ {
"url": "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension",
"valueString": "immunizations"
} ]
}, {
"id": "proc-data",
"type": "Procedure",
"profile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure" ],
"extension": [ {
"url": "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension",
"valueString": "procedures"
} ]
}, {
"id": "labResult-data",
"type": "Observation",
"profile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab" ],
"extension": [ {
"url": "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension",
"valueString": "labResults"
} ]
}, {
"id": "labOrder-data",
"type": "ServiceRequest",
"profile": [ "http://hl7.org/fhir/StructureDefinition/ServiceRequest" ],
"extension": [ {
"url": "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension",
"valueString": "labOrders"
} ]
}, {
"id": "diagnosticResult-data",
"type": "DiagnosticReport",
"profile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab" ],
"extension": [ {
"url": "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension",
"valueString": "diagnosticResults"
} ]
}, {
"id": "diagnosticOrder-data",
"type": "DiagnosticReport",
"profile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab" ],
"extension": [ {
"url": "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension",
"valueString": "diagnosticOrders"
} ]
} ],
"output": [ {
"id": "eicr-report",
"type": "Bundle",
"profile": [ "http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle" ]
} ],
"description": "This action represents the creation of the eICR. It subsequently calls validate.",
"relatedAction": [ {
"actionId": "validate-eicr",
"relationship": "before-start"
} ],
"textEquivalent": "Create eICR"
}, {
"id": "validate-eicr",
"code": [ {
"coding": [ {
"code": "validate-report",
"system": "http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actions"
} ]
} ],
"input": [ {
"id": "generated-eicr-report",
"type": "Bundle",
"profile": [ "http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle" ],
"extension": [ {
"url": "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension",
"valueString": "eicr-report"
} ]
} ],
"output": [ {
"id": "valid-eicr-report",
"type": "Bundle",
"profile": [ "http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle" ]
} ],
"description": "This action represents the validation of the eICR. It subsequently calls route-and-send.",
"relatedAction": [ {
"actionId": "route-and-send-eicr",
"relationship": "before-start"
} ],
"textEquivalent": "Validate eICR"
}, {
"id": "route-and-send-eicr",
"code": [ {
"coding": [ {
"code": "submit-report",
"system": "http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actions"
} ]
} ],
"input": [ {
"id": "validated-eicr-report",
"type": "Bundle",
"profile": [ "http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle" ],
"extension": [ {
"url": "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension",
"valueString": "valid-eicr-report"
} ]
} ],
"output": [ {
"id": "submitted-eicr-report",
"type": "Bundle",
"profile": [ "http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle" ]
} ],
"description": "This action represents the routing and sending of the eICR.",
"textEquivalent": "Route and send eICR"
}, {
"id": "encounter-modified",
"code": [ {
"coding": [ {
"code": "initiate-reporting-workflow",
"system": "http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-plandefinition-actions",
"display": "Initiate a reporting workflow"
} ]
} ],
"trigger": [ {
"id": "encounter-modified-trigger",
"name": "encounter-modified",
"type": "named-event",
"extension": [ {
"url": "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension",
"valueCodeableConcept": {
"coding": [ {
"code": "encounter-modified",
"system": "http://hl7.org/fhir/us/ecr/CodeSystem/us-ph-triggerdefinition-namedevents",
"display": "Indicates modifications to data elements of an encounter"
} ]
}
} ]
} ],
"condition": [ {
"kind": "applicability",
"expression": {
"language": "text/fhirpath",
"expression": "%encounter.where(period.start + %normalReportingDuration < now())"
}
} ],
"description": "This action represents the start of the reporting workflow in response to the encounter-modified event",
"relatedAction": [ {
"actionId": "create-eicr",
"relationship": "before-start"
} ],
"textEquivalent": "Start the reporting workflow in response to an encounter-modified event"
} ],
"version": "2.1.1",
"contact": [ {
"name": "HL7 International / Public Health",
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/pher",
"system": "url"
} ]
} ]
}