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

FHIR IG analytics

Packagehl7.fhir.us.health-care-surveys-reporting.r4b
Resource TypePlanDefinition
IdPlanDefinition-hcs-plandefinition-example.json
FHIR VersionR4B

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

Generated Narrative: PlanDefinition hcs-plandefinition-example

US Public Health Receiver Address Extension: Endpoint PHAReceiver

US Public Health Receiver JWKS Url Extension: http://example.org/jwks/123

US Public Health Data Encryption Algorithm Extension: RSA384

url: PlanDefinition PlanDefinition National Health Care Surveys Example

identifier: Uniform Resource Identifier (URI)/urn:oid:2.16.840.1.113883.4.642.40.59.34.1

version: 2.0.0-ballot

name: PlanDefinitionNationalHealthCareSurveysExample

title: PlanDefinition National Health Care Surveys Example

type: Workflow Definition

status: Active

experimental: true

date: 2025-07-31 12:32:29-0500

publisher: HL7 International / Public Health

contact: HL7 International / Public Health: http://www.hl7.org/Special/committees/pher,ord@lists.HL7.org

description:

An example National Health Care Surveys PlanDefinition

jurisdiction: United States of America

effectivePeriod: 2025-12-01 --> (ongoing)

library: http://example.org/fhir/Library/RuleFilters|1.0.0

action

id

start-workflow

description: Start the workflow action.

textEquivalent: Start the reporting workflow in response to an encounter-end event

code: Initiate a reporting workflow

Triggers

-TypeName
*Named Eventencounter-end

RelatedActions

-ActionIdRelationship
*check-reportabilityBefore Start

action

id

check-reportability

code: Execute a series of actions to accomplish reporting

action

id

is-ambulatory-encounter-reportable

code: Evaluate condition to determine reportability

action

id

is-inpatient-encounter-reportable

code: Evaluate condition to determine reportability

action

id

create-hcs-report

code: Create a Report containing Patient's data for patients who passed the check-reportability test

action

id

validate-hcs-report

action

id

submit-hcs-report

textEquivalent: Route and send HCS Report


Source1

{
  "resourceType": "PlanDefinition",
  "id": "hcs-plandefinition-example",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/us/health-care-surveys-reporting/StructureDefinition/hcs-plandefinition"
    ]
  },
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-receiver-address-extension",
      "valueReference": {
        "reference": "Endpoint/ph-endpoint"
      }
    },
    {
      "url": "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-receiver-jwks-url-extension",
      "valueUrl": "http://example.org/jwks/123"
    },
    {
      "url": "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encryption-algorithm-extension",
      "valueCode": "RSA384"
    }
  ],
  "url": "https://build.fhir.org/ig/HL7/fhir-health-care-surveys-reporting-ig/PlanDefinition/hcs-plandefinition-example",
  "identifier": [
    {
      "system": "urn:ietf:rfc:3986",
      "value": "urn:oid:2.16.840.1.113883.4.642.40.59.34.1"
    }
  ],
  "version": "2.0.0-ballot",
  "name": "PlanDefinitionNationalHealthCareSurveysExample",
  "title": "PlanDefinition National Health Care Surveys Example",
  "type": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/plan-definition-type",
        "code": "workflow-definition",
        "display": "Workflow Definition"
      }
    ]
  },
  "status": "active",
  "experimental": true,
  "date": "2025-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": "ord@lists.HL7.org"
        }
      ]
    }
  ],
  "description": "An example National Health Care Surveys PlanDefinition",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "US"
        }
      ]
    }
  ],
  "effectivePeriod": {
    "start": "2025-12-01"
  },
  "library": [
    "http://example.org/fhir/Library/RuleFilters|1.0.0"
  ],
  "action": [
    {
      "id": "start-workflow",
      "description": "Start the workflow action.",
      "textEquivalent": "Start the reporting workflow in response to an encounter-end event",
      "code": [
        {
          "coding": [
            {
              "system": "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
              "code": "initiate-reporting-workflow"
            }
          ]
        }
      ],
      "trigger": [
        {
          "type": "named-event",
          "name": "encounter-end"
        }
      ],
      "relatedAction": [
        {
          "actionId": "check-reportability",
          "relationship": "before-start"
        }
      ]
    },
    {
      "id": "check-reportability",
      "code": [
        {
          "coding": [
            {
              "system": "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
              "code": "execute-reporting-workflow"
            }
          ]
        }
      ],
      "action": [
        {
          "id": "is-ambulatory-encounter-reportable",
          "code": [
            {
              "coding": [
                {
                  "system": "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
                  "code": "evaluate-condition"
                }
              ]
            }
          ]
        },
        {
          "id": "is-inpatient-encounter-reportable",
          "code": [
            {
              "coding": [
                {
                  "system": "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
                  "code": "evaluate-condition"
                }
              ]
            }
          ]
        }
      ]
    },
    {
      "id": "create-hcs-report",
      "code": [
        {
          "coding": [
            {
              "system": "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
              "code": "create-report"
            }
          ]
        }
      ]
    },
    {
      "id": "validate-hcs-report"
    },
    {
      "id": "submit-hcs-report",
      "textEquivalent": "Route and send HCS Report"
    }
  ]
}