FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packagehl7.fhir.us.ecr
Resource TypePlanDefinition
IdPlanDefinition-plandefinition-ersd-instance-relateddata-extension-example.json
FHIR VersionR4
Sourcehttps://build.fhir.org/ig/HL7/case-reporting/PlanDefinition-plandefinition-ersd-instance-relateddata-extension-example.html
URLhttp://hl7.org/fhir/us/ecr/PlanDefinition/plandefinition-ersd-instance-relateddata-extension-example
Version3.0.0-ballot
Statusactive
Date2020-07-31T12:32:29.858-05:00
NamePlanDefinition_eRSD_Instance_Simple_Example
TitleeRSD PlanDefinition Instance Simple Example
Realmus
Authorityhl7
DescriptionExample of an eRSD PlanDefinition demonstrating the use of the US Public Health RelatedData Extension for linking related resources.

Resources that use this resource

No resources found


Resources that this resource uses

No resources found


Narrative

Note: links and images are rebased to the (stated) source

Id: plandefinition-ersd-instance-relateddata-extension-example
Url: eRSD PlanDefinition Instance Simple Example
Version: 3.0.0-ballot

urn:oid:2.16.840.1.113883.4.642.40.46.34.5

Title: eRSD PlanDefinition Instance Simple Example
Experimental: true
Type:

system: http://terminology.hl7.org/CodeSystem/plan-definition-type

code: workflow-definition

display: Workflow Definition

Date: 2020-07-31 12:32:29-0500
Publisher: HL7 International / Public Health
Description:

Example of an eRSD PlanDefinition demonstrating the use of the US Public Health RelatedData Extension for linking related resources.

Jurisdiction: US
Actions:
Start the reporting workflow in response to an encounter-start event
When: Named Event: encounter-start
Check suspected disorders for immediate reportability and setup jobs for future reportability checks.
Then:
Check Trigger Codes based on Suspected Reportable Value set.
:
Check Reportability and setup jobs for future reportability checks.
Then:
Check Trigger Codes based on RCTC Value sets.
:
:
:
Create eICR
Validate eICR
Route and send eICR
Start the reporting workflow in response to an encounter-modified event
When: Named Event: encounter-modified
If: Applicability: (%encounter.where(period.start + %normalReportingDuration < now()))

Source1

{
  "resourceType": "PlanDefinition",
  "id": "plandefinition-ersd-instance-relateddata-extension-example",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/us/ecr/StructureDefinition/ersd-plandefinition"
    ]
  },
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/variable",
      "valueExpression": {
        "name": "normalReportingDuration",
        "language": "text/fhirpath",
        "expression": "2 weeks"
      }
    }
  ],
  "url": "http://hl7.org/fhir/us/ecr/PlanDefinition/plandefinition-ersd-instance-relateddata-extension-example",
  "identifier": [
    {
      "system": "urn:ietf:rfc:3986",
      "value": "urn:oid:2.16.840.1.113883.4.642.40.46.34.5"
    }
  ],
  "version": "3.0.0-ballot",
  "name": "PlanDefinition_eRSD_Instance_Simple_Example",
  "title": "eRSD PlanDefinition Instance Simple Example",
  "type": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/plan-definition-type",
        "code": "workflow-definition",
        "display": "Workflow Definition"
      }
    ]
  },
  "status": "active",
  "experimental": true,
  "date": "2020-07-31T12:32:29.858-05:00",
  "publisher": "HL7 International / Public Health",
  "contact": [
    {
      "name": "HL7 International / Public Health",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/pher"
        },
        {
          "system": "email",
          "value": "pher@lists.HL7.org"
        }
      ]
    }
  ],
  "description": "Example of an eRSD PlanDefinition demonstrating the use of the US Public Health RelatedData Extension for linking related resources.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "US"
        }
      ]
    }
  ],
  "action": [
    {
      "id": "start-workflow",
      "description": "This action represents the start of the reporting workflow in response to the encounter-start event.",
      "textEquivalent": "Start the reporting workflow in response to an encounter-start event",
      "code": [
        {
          "coding": [
            {
              "system": "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
              "code": "initiate-reporting-workflow",
              "display": "Initiate a reporting workflow"
            }
          ]
        }
      ],
      "trigger": [
        {
          "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/StructureDefinition/cqf-fhirQueryPattern",
              "valueString": "Patient/{{context.patientId}}"
            }
          ],
          "type": "Patient"
        },
        {
          "id": "encounter",
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/cqf-fhirQueryPattern",
              "valueString": "Encounter/{{context.encounterId}}"
            }
          ],
          "type": "Encounter"
        }
      ],
      "relatedAction": [
        {
          "actionId": "check-suspected-disorder",
          "relationship": "before-start",
          "offsetDuration": {
            "value": 1,
            "system": "http://unitsofmeasure.org",
            "code": "h"
          }
        }
      ]
    },
    {
      "id": "check-suspected-disorder",
      "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.",
      "code": [
        {
          "coding": [
            {
              "system": "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
              "code": "execute-reporting-workflow"
            }
          ]
        }
      ],
      "action": [
        {
          "id": "is-encounter-suspected-disorder",
          "description": "This action represents the check for suspected disorder reportability to create the patients eICR.",
          "textEquivalent": "Check Trigger Codes based on Suspected Reportable Value set.",
          "code": [
            {
              "coding": [
                {
                  "system": "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
                  "code": "check-trigger-codes"
                }
              ]
            }
          ]
        },
        {
          "id": "continue-check-reportable",
          "code": [
            {
              "coding": [
                {
                  "system": "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
                  "code": "evaluate-condition"
                }
              ]
            }
          ]
        }
      ]
    },
    {
      "id": "check-reportable",
      "description": "This action represents the check for suspected reportability of the eICR.",
      "textEquivalent": "Check Reportability and setup jobs for future reportability checks.",
      "code": [
        {
          "coding": [
            {
              "system": "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
              "code": "execute-reporting-workflow"
            }
          ]
        }
      ],
      "action": [
        {
          "id": "is-encounter-reportable",
          "description": "This action represents the check for reportability to create the patients eICR.",
          "textEquivalent": "Check Trigger Codes based on RCTC Value sets.",
          "code": [
            {
              "coding": [
                {
                  "system": "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
                  "code": "check-trigger-codes"
                }
              ]
            }
          ]
        },
        {
          "id": "check-update-eicr",
          "code": [
            {
              "coding": [
                {
                  "system": "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
                  "code": "evaluate-condition"
                }
              ]
            }
          ]
        },
        {
          "id": "is-encounter-in-progress",
          "code": [
            {
              "coding": [
                {
                  "system": "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
                  "code": "evaluate-condition"
                }
              ]
            }
          ]
        },
        {
          "id": "is-encounter-completed",
          "code": [
            {
              "coding": [
                {
                  "system": "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
                  "code": "complete-reporting"
                }
              ]
            }
          ]
        }
      ]
    },
    {
      "id": "create-eicr",
      "description": "This action represents the creation of the eICR. It subsequently calls validate.",
      "textEquivalent": "Create eICR",
      "code": [
        {
          "coding": [
            {
              "system": "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
              "code": "create-report"
            }
          ]
        }
      ],
      "input": [
        {
          "id": "patient-data",
          "extension": [
            {
              "url": "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-relateddata-extension",
              "valueString": "patient"
            }
          ],
          "type": "Patient",
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient|6.1.0"
          ]
        },
        {
          "id": "condition-data",
          "extension": [
            {
              "url": "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-relateddata-extension",
              "valueString": "conditions"
            }
          ],
          "type": "Condition",
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-encounter-diagnosis|6.1.0"
          ]
        },
        {
          "id": "encounter-data",
          "extension": [
            {
              "url": "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-relateddata-extension",
              "valueString": "encounters"
            }
          ],
          "type": "Encounter",
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter|6.1.0"
          ]
        },
        {
          "id": "mr-data",
          "extension": [
            {
              "url": "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-relateddata-extension",
              "valueString": "medicationOrders"
            }
          ],
          "type": "MedicationRequest",
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest|6.1.0"
          ]
        },
        {
          "id": "immz-data",
          "extension": [
            {
              "url": "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-relateddata-extension",
              "valueString": "immunizations"
            }
          ],
          "type": "Immunization",
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization|6.1.0"
          ]
        },
        {
          "id": "proc-data",
          "extension": [
            {
              "url": "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-relateddata-extension",
              "valueString": "procedures"
            }
          ],
          "type": "Procedure",
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure|6.1.0"
          ]
        },
        {
          "id": "labResult-data",
          "extension": [
            {
              "url": "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-relateddata-extension",
              "valueString": "labResults"
            }
          ],
          "type": "Observation",
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab|6.1.0"
          ]
        },
        {
          "id": "labOrder-data",
          "extension": [
            {
              "url": "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-relateddata-extension",
              "valueString": "labOrders"
            }
          ],
          "type": "ServiceRequest",
          "profile": [
            "http://hl7.org/fhir/StructureDefinition/ServiceRequest"
          ]
        },
        {
          "id": "diagnosticResult-data",
          "extension": [
            {
              "url": "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-relateddata-extension",
              "valueString": "diagnosticResults"
            }
          ],
          "type": "DiagnosticReport",
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab|6.1.0"
          ]
        },
        {
          "id": "diagnosticOrder-data",
          "extension": [
            {
              "url": "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-relateddata-extension",
              "valueString": "diagnosticOrders"
            }
          ],
          "type": "DiagnosticReport",
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab|6.1.0"
          ]
        }
      ],
      "output": [
        {
          "id": "eicr-report",
          "type": "Bundle",
          "profile": [
            "http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle"
          ]
        }
      ],
      "relatedAction": [
        {
          "actionId": "validate-eicr",
          "relationship": "before-start"
        }
      ]
    },
    {
      "id": "validate-eicr",
      "description": "This action represents the validation of the eICR. It subsequently calls route-and-send.",
      "textEquivalent": "Validate eICR",
      "code": [
        {
          "coding": [
            {
              "system": "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
              "code": "validate-report"
            }
          ]
        }
      ],
      "input": [
        {
          "id": "generated-eicr-report",
          "extension": [
            {
              "url": "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-relateddata-extension",
              "valueString": "eicr-report"
            }
          ],
          "type": "Bundle",
          "profile": [
            "http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle"
          ]
        }
      ],
      "output": [
        {
          "id": "valid-eicr-report",
          "type": "Bundle",
          "profile": [
            "http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle"
          ]
        }
      ],
      "relatedAction": [
        {
          "actionId": "route-and-send-eicr",
          "relationship": "before-start"
        }
      ]
    },
    {
      "id": "route-and-send-eicr",
      "description": "This action represents the routing and sending of the eICR.",
      "textEquivalent": "Route and send eICR",
      "code": [
        {
          "coding": [
            {
              "system": "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
              "code": "submit-report"
            }
          ]
        }
      ],
      "input": [
        {
          "id": "validated-eicr-report",
          "extension": [
            {
              "url": "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-relateddata-extension",
              "valueString": "valid-eicr-report"
            }
          ],
          "type": "Bundle",
          "profile": [
            "http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle"
          ]
        }
      ],
      "output": [
        {
          "id": "submitted-eicr-report",
          "type": "Bundle",
          "profile": [
            "http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle"
          ]
        }
      ]
    },
    {
      "id": "encounter-modified",
      "description": "This action represents the start of the reporting workflow in response to the encounter-modified event",
      "textEquivalent": "Start the reporting workflow in response to an encounter-modified event",
      "code": [
        {
          "coding": [
            {
              "system": "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
              "code": "initiate-reporting-workflow",
              "display": "Initiate a reporting workflow"
            }
          ]
        }
      ],
      "trigger": [
        {
          "id": "encounter-modified-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-modified",
                    "display": "Indicates modifications to data elements of an encounter"
                  }
                ]
              }
            }
          ],
          "type": "named-event",
          "name": "encounter-modified"
        }
      ],
      "condition": [
        {
          "kind": "applicability",
          "expression": {
            "language": "text/fhirpath",
            "expression": "%encounter.where(period.start + %normalReportingDuration < now())"
          }
        }
      ],
      "relatedAction": [
        {
          "actionId": "create-eicr",
          "relationship": "before-start"
        }
      ]
    }
  ]
}