Respiratory Virus Hospitalization Surveillance Network (RESP-NET) Content Implementation Guide
1.0.0-ballot - STU1 Ballot United States of America flag

This page is part of the Respiratory Virus Hospitalization Surveillance Network (RESP-NET) Content Implementation Guide (v1.0.0-ballot: STU1 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions

: Example of a Specification Bundle containing PlanDefinition - JSON Representation

Raw json | Download


{
  "resourceType" : "Bundle",
  "id" : "resp-net-specification-bundle-example",
  "meta" : {
    "versionId" : "1",
    "lastUpdated" : "2020-11-29T02:03:28.045+00:00",
    "profile" : [
      🔗 "http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-specification-bundle"
    ]
  },
  "type" : "collection",
  "timestamp" : "2020-11-20T11:15:33-10:00",
  "entry" : [
    {
      "fullUrl" : "http://hl7.org/fhir/us/resp-net/PlanDefinition/plandefinition-resp-net-example",
      "resource" : {
        "resourceType" : "PlanDefinition",
        "id" : "plandefinition-resp-net-example",
        "meta" : {
          "versionId" : "1",
          "lastUpdated" : "2020-11-29T02:03:28.045+00:00",
          "profile" : [
            🔗 "http://hl7.org/fhir/us/resp-net/StructureDefinition/resp-net-plandefinition"
          ]
        },
        "text" : {
          "status" : "extensions",
          "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative</b></p><p><b>Receiver Endpoint Address</b>: <a>Generated Summary: id: example-nchs-endpoint; status: active; <span title=\"{http://terminology.hl7.org/CodeSystem/endpoint-connection-type hl7-fhir-rest}\">HL7 FHIR</span>; name: PHAReceiver; endpointmanager@example.pha.org; period: 2020-11-20 --&gt; (ongoing); <span title=\"Codes: {http://hl7.org/fhir/resource-types Bundle}\">Bundle</span>; payloadMimeType: application/fhir+xml, payloadMimeType: application/fhir+json; address: http://example.pha.org/fhir</a></p><p><b>Author </b></p></div>"
        },
        "url" : "http://hl7.org/fhir/us/resp-net/StructureDefinition/plandefinition-resp-net-example",
        "version" : "1.0",
        "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" : true,
        "date" : "2023-06-01T12:32:29.858-05:00",
        "publisher" : "HL7 Public Health Work Group",
        "description" : "This is the RESP-NET Reporting Knowledge Artifact",
        "effectivePeriod" : {
          "start" : "2021-11-01"
        },
        "relatedArtifact" : [
          {
            "type" : "depends-on",
            "label" : "Health Care Survey Registered Participants",
            "resource" : "http://nchs/fhir/r4/Group/healthcare-survey-participants"
          }
        ],
        "action" : [
          {
            "id" : "start-workflow",
            "description" : "This action represents the start of the reporting workflow in response to the encounter-end event",
            "textEquivalent" : "Start the reporting workflow in response to an encounter-end event",
            "code" : [
              {
                "coding" : [
                  {
                    "system" : "http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions",
                    "code" : "initiate-reporting-workflow"
                  }
                ]
              }
            ],
            "trigger" : [
              {
                "id" : "encounter-end",
                "extension" : [
                  {
                    "url" : "http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-named-eventtype",
                    "valueCodeableConcept" : {
                      "coding" : [
                        {
                          "system" : "http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-triggerdefinition-namedevents",
                          "code" : "encounter-end",
                          "display" : "Indicates the end of an encounter"
                        }
                      ]
                    }
                  }
                ],
                "type" : "named-event",
                "name" : "encounter-end"
              }
            ],
            "relatedAction" : [
              {
                "actionId" : "check-reportability",
                "relationship" : "before-start",
                "offsetDuration" : {
                  "value" : 72,
                  "system" : "http://unitsofmeasure.org",
                  "code" : "h"
                }
              }
            ]
          },
          {
            "id" : "start-workflow-for-positive-lab-result",
            "description" : "This action represents the start of the reporting workflow in response to the labresult-change (e.g new lab result or modified existing lab result) event",
            "textEquivalent" : "Start the reporting workflow in response to an labresult-change event",
            "code" : [
              {
                "coding" : [
                  {
                    "system" : "http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions",
                    "code" : "initiate-reporting-workflow"
                  }
                ]
              }
            ],
            "trigger" : [
              {
                "id" : "labresult-change",
                "extension" : [
                  {
                    "url" : "http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-named-eventtype",
                    "valueCodeableConcept" : {
                      "coding" : [
                        {
                          "system" : "http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-triggerdefinition-namedevents",
                          "code" : "labresult-change",
                          "display" : "Indicates change in a patient's labresults"
                        }
                      ]
                    }
                  }
                ],
                "type" : "named-event",
                "name" : "labresult-change"
              }
            ],
            "relatedAction" : [
              {
                "actionId" : "check-reportability",
                "relationship" : "before-start",
                "offsetDuration" : {
                  "value" : 72,
                  "system" : "http://unitsofmeasure.org",
                  "code" : "h"
                }
              }
            ]
          },
          {
            "id" : "check-reportability",
            "description" : "This action represents the start of the check for reportable conditions in response to the encounter-end event. This is an example of executing a reporting workflow with other actions.",
            "textEquivalent" : "Check Reportability",
            "code" : [
              {
                "coding" : [
                  {
                    "system" : "http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions",
                    "code" : "execute-reporting-workflow"
                  }
                ]
              }
            ],
            "action" : [
              {
                "id" : "is-ambulatory-encounter-reportable",
                "description" : "This action represents the check for reportability of ambulatory encounters based on survey participation.",
                "textEquivalent" : "Check Participation of Provider to report on the encounter",
                "code" : [
                  {
                    "coding" : [
                      {
                        "system" : "http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions",
                        "code" : "evaluate-condition"
                      }
                    ]
                  }
                ],
                "condition" : [
                  {
                    "kind" : "applicability",
                    "expression" : {
                      "language" : "text/fhirpath",
                      "expression" : "%closedEncounter.participant.individual.identifier.where(system = 'http://hl7.org/fhir/sid/us-npi).value.subsetOf(participantGroup.member.entity.identifier.where(system = 'http://hl7.org/fhir/sid/us-npi).value)'"
                    }
                  }
                ],
                "input" : [
                  {
                    "id" : "closedEncounter",
                    "extension" : [
                      {
                        "url" : "http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension",
                        "valueString" : "Encounter/{{context.patientId}}"
                      }
                    ],
                    "type" : "Encounter"
                  },
                  {
                    "id" : "participantGroup",
                    "extension" : [
                      {
                        "url" : "http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension",
                        "valueString" : "Group/{{context.nchsGroupId}}"
                      }
                    ],
                    "type" : "Group"
                  }
                ],
                "relatedAction" : [
                  {
                    "actionId" : "create-resp-net-report",
                    "relationship" : "before-start"
                  }
                ]
              },
              {
                "id" : "is-inpatient-encounter-reportable",
                "description" : "This action represents the check for reportability of inpatient encounters based on survey requirements.",
                "textEquivalent" : "Check criteria to report on the encounter",
                "code" : [
                  {
                    "coding" : [
                      {
                        "system" : "http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions",
                        "code" : "evaluate-condition"
                      }
                    ]
                  }
                ],
                "condition" : [
                  {
                    "kind" : "applicability",
                    "expression" : {
                      "language" : "text/fhirpath",
                      "expression" : "%closedEncounter.exists()"
                    }
                  }
                ],
                "input" : [
                  {
                    "id" : "inpatientEncounter",
                    "extension" : [
                      {
                        "url" : "http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension",
                        "valueString" : "Encounter/{{context.patientId}}"
                      }
                    ],
                    "type" : "Encounter"
                  }
                ],
                "relatedAction" : [
                  {
                    "actionId" : "create-resp-net-report",
                    "relationship" : "before-start"
                  }
                ]
              }
            ]
          },
          {
            "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/medmorph/CodeSystem/us-ph-plandefinition-actions",
                    "code" : "create-report"
                  }
                ]
              }
            ],
            "input" : [
              {
                "id" : "patient",
                "extension" : [
                  {
                    "url" : "http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension",
                    "valueString" : "Patient/{{context.patientId}}"
                  }
                ],
                "type" : "Patient"
              },
              {
                "id" : "conditions",
                "extension" : [
                  {
                    "url" : "http://hl7.org/fhir/us/medmorph/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/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension",
                    "valueString" : "AllergyIntolerance?patient=Patient/{{context.patientId}}"
                  }
                ],
                "type" : "AllergyIntolerance"
              },
              {
                "id" : "careteam",
                "extension" : [
                  {
                    "url" : "http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension",
                    "valueString" : "CareTeam?patient=Patient/{{context.patientId}}"
                  }
                ],
                "type" : "CareTeam"
              },
              {
                "id" : "careplan",
                "extension" : [
                  {
                    "url" : "http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension",
                    "valueString" : "CarePlan?patient=Patient/{{context.patientId}}"
                  }
                ],
                "type" : "CarePlan"
              },
              {
                "id" : "goals",
                "extension" : [
                  {
                    "url" : "http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension",
                    "valueString" : "Goal?patient=Patient/{{context.patientId}}"
                  }
                ],
                "type" : "Goal"
              },
              {
                "id" : "encounter",
                "extension" : [
                  {
                    "url" : "http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension",
                    "valueString" : "Encounter/{{context.encounterId}}"
                  }
                ],
                "type" : "Encounter"
              },
              {
                "id" : "medRequests",
                "extension" : [
                  {
                    "url" : "http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension",
                    "valueString" : "MedicationRequest?patient=Patient/{{context.patientId}}&intent=order"
                  }
                ],
                "type" : "MedicationRequest"
              },
              {
                "id" : "medStatements",
                "extension" : [
                  {
                    "url" : "http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension",
                    "valueString" : "MedicationStatement?patient=Patient/{{context.patientId}}"
                  }
                ],
                "type" : "MedicationStatement"
              },
              {
                "id" : "medAdms",
                "extension" : [
                  {
                    "url" : "http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension",
                    "valueString" : "MedicationAdministration?patient=Patient/{{context.patientId}}"
                  }
                ],
                "type" : "MedicationAdministration"
              },
              {
                "id" : "vitals",
                "extension" : [
                  {
                    "url" : "http://hl7.org/fhir/us/medmorph/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/medmorph/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/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension",
                    "valueString" : "DiagnosticReport?patient=Patient/{{context.patientId}}"
                  }
                ],
                "type" : "DiagnosticReport"
              },
              {
                "id" : "serviceRequests",
                "extension" : [
                  {
                    "url" : "http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension",
                    "valueString" : "ServiceRequest?patient=Patient/{{context.patientId}}"
                  }
                ],
                "type" : "ServiceRequest"
              },
              {
                "id" : "procedures",
                "extension" : [
                  {
                    "url" : "http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension",
                    "valueString" : "Procedure?patient=Patient/{{context.patientId}}"
                  }
                ],
                "type" : "Procedure"
              },
              {
                "id" : "implantableDevices",
                "extension" : [
                  {
                    "url" : "http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension",
                    "valueString" : "Device?patient=Patient/{{context.patientId}}"
                  }
                ],
                "type" : "Device"
              },
              {
                "id" : "labs",
                "extension" : [
                  {
                    "url" : "http://hl7.org/fhir/us/medmorph/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/medmorph/CodeSystem/us-ph-plandefinition-actions",
                    "code" : "validate-report"
                  }
                ]
              }
            ],
            "input" : [
              {
                "id" : "created-resp-net-report",
                "extension" : [
                  {
                    "url" : "http://hl7.org/fhir/us/medmorph/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/medmorph/CodeSystem/us-ph-plandefinition-actions",
                    "code" : "submit-report"
                  }
                ]
              }
            ],
            "input" : [
              {
                "id" : "valid-resp-net-report",
                "extension" : [
                  {
                    "url" : "http://hl7.org/fhir/us/medmorph/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"
                ]
              }
            ]
          }
        ]
      }
    }
  ]
}