Health Care Surveys Content Implementation Guide
0.1.0 - STU 1 Ballot

This page is part of the Making EHR Data MOre available for Research and Public Health (MedMorph) Healthcare Surveys Reporting Content IG (v0.1.0: STU 1 Ballot 1) based on FHIR 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" : "healthcare-survey-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" : "PlanDefinition/plandefinition-healthcare-survey-example",
      "resource" : {
        "resourceType" : "PlanDefinition",
        "id" : "plandefinition-healthcare-survey-example",
        "meta" : {
          "versionId" : "1",
          "lastUpdated" : "2020-11-29T02:03:28.045+00:00",
          "profile" : [
            "http://hl7.org/fhir/us/health-care-surveys-reporting/StructureDefinition/hcs-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 Signature</b>: </p><p><b style=\"color: maroon\">Exception generating Narrative: type org.hl7.fhir.r5.model.Signature not handled - should not be here</b></p></div>"
        },
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-receiverAddress",
            "valueReference" : {
              "reference" : "Endpoint/example-ph-endpoint"
            }
          },
          {
            "url" : "http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-authorSignature",
            "valueSignature" : {
              "type" : [
                {
                  "system" : "urn:iso-astm:E1762-95:2013",
                  "code" : "1.2.840.10065.1.12.1.5",
                  "display" : "Verification Signature"
                }
              ],
              "when" : "2020-11-04T08:39:24+10:00",
              "who" : {
                "reference" : "Organization/example-pha-org"
              },
              "targetFormat" : "application/fhir+xml",
              "sigFormat" : "application/signature+xml",
              "data" : "L44u"
            }
          }
        ],
        "url" : "http://hl7.org/fhir/us/health-care-surveys-reporting/StructureDefinition/plandefinition-healthcare-survey-example",
        "version" : "1.0",
        "name" : "PlanDefinitionHealthcareSurveyExample",
        "title" : "PlanDefinition Health Care Survey Reporting Example",
        "type" : {
          "coding" : [
            {
              "system" : "http://terminology.hl7.org/CodeSystem/plan-definition-type",
              "code" : "workflow-definition",
              "display" : "Workflow Definition"
            }
          ]
        },
        "status" : "draft",
        "experimental" : true,
        "date" : "2020-11-04T12:32:29.858-05:00",
        "publisher" : "HL7 Public Health Work Group",
        "description" : "This is the Health Care Survey 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-close event",
            "textEquivalent" : "Start the reporting workflow in response to an encounter-close event",
            "code" : [
              {
                "coding" : [
                  {
                    "system" : "http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions",
                    "code" : "initiate-reporting-workflow"
                  }
                ]
              }
            ],
            "trigger" : [
              {
                "id" : "encounter-close",
                "extension" : [
                  {
                    "url" : "http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-us-ph-namedEventType",
                    "valueCodeableConcept" : {
                      "coding" : [
                        {
                          "system" : "http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-triggerdefinition-namedevents",
                          "code" : "encounter-close",
                          "display" : "Indicates the close of an encounter"
                        }
                      ]
                    }
                  }
                ],
                "type" : "named-event",
                "name" : "encounter-close"
              }
            ],
            "relatedAction" : [
              {
                "actionId" : "check-survey-participants",
                "relationship" : "before-start",
                "offsetDuration" : {
                  "value" : 5,
                  "system" : "http://unitsofmeasure.org",
                  "code" : "min"
                }
              }
            ]
          },
          {
            "id" : "check-survey-participants",
            "description" : "This action represents the check if Practitioner is registered to report on health care surveys.",
            "textEquivalent" : "Check Participant Registration",
            "code" : [
              {
                "coding" : [
                  {
                    "system" : "http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions",
                    "code" : "check-participant-registration"
                  }
                ]
              }
            ],
            "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",
                "type" : "Encounter",
                "profile" : [
                  "http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter"
                ]
              },
              {
                "id" : "participantGroup",
                "type" : "Group",
                "profile" : [
                  "http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-survey-practitioner-group"
                ]
              }
            ],
            "relatedAction" : [
              {
                "actionId" : "report-to-nchs",
                "relationship" : "before-start"
              }
            ]
          },
          {
            "id" : "report-to-nchs",
            "description" : "This action represents the creation, validation and submission of the health care survey report.",
            "textEquivalent" : "Create Report and send to NCHS.",
            "code" : [
              {
                "coding" : [
                  {
                    "system" : "http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions",
                    "code" : "execute-reporting-workflow"
                  }
                ]
              }
            ],
            "action" : [
              {
                "id" : "create-hcs-report",
                "description" : "This action represents the creation of the HCS Report.",
                "textEquivalent" : "Health Care Survey Report",
                "code" : [
                  {
                    "coding" : [
                      {
                        "system" : "http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions",
                        "code" : "create-report"
                      }
                    ]
                  }
                ],
                "input" : [
                  {
                    "id" : "patient",
                    "type" : "Patient",
                    "profile" : [
                      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
                    ]
                  },
                  {
                    "id" : "condition",
                    "type" : "Condition",
                    "profile" : [
                      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"
                    ]
                  },
                  {
                    "id" : "encounter",
                    "type" : "Encounter",
                    "profile" : [
                      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter"
                    ]
                  },
                  {
                    "id" : "mr",
                    "type" : "MedicationRequest",
                    "profile" : [
                      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest"
                    ]
                  },
                  {
                    "id" : "vitals",
                    "type" : "Observation",
                    "profile" : [
                      "http://hl7.org/fhir/StructureDefinition/vitalsigns"
                    ]
                  },
                  {
                    "id" : "labs",
                    "type" : "Observation",
                    "profile" : [
                      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab"
                    ]
                  }
                ],
                "output" : [
                  {
                    "id" : "hcs-report",
                    "type" : "Bundle",
                    "profile" : [
                      "http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-reporting-bundle"
                    ]
                  }
                ],
                "relatedAction" : [
                  {
                    "actionId" : "validate-report",
                    "relationship" : "before-start"
                  }
                ]
              },
              {
                "id" : "validate-hcs-report",
                "description" : "This action represents the validation of the HCS Report",
                "textEquivalent" : "Validate Report",
                "code" : [
                  {
                    "coding" : [
                      {
                        "system" : "http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions",
                        "code" : "validate-report"
                      }
                    ]
                  }
                ],
                "input" : [
                  {
                    "id" : "created-hcs-report",
                    "type" : "Bundle",
                    "profile" : [
                      "http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-reporting-bundle"
                    ]
                  }
                ],
                "output" : [
                  {
                    "id" : "validated-hcs-report",
                    "type" : "Bundle",
                    "profile" : [
                      "http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-reporting-bundle"
                    ]
                  }
                ],
                "relatedAction" : [
                  {
                    "actionId" : "submit-report",
                    "relationship" : "before-start"
                  }
                ]
              },
              {
                "id" : "route-and-send-hcs-report",
                "description" : "This action represents the routing and sending of the HCS Report",
                "textEquivalent" : "Route and send HCS Report",
                "code" : [
                  {
                    "coding" : [
                      {
                        "system" : "http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions",
                        "code" : "submit-report"
                      }
                    ]
                  }
                ],
                "input" : [
                  {
                    "id" : "valid-hcs-report",
                    "type" : "Bundle",
                    "profile" : [
                      "http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-reporting-bundle"
                    ]
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  ]
}