Health Care Surveys Content Implementation Guide (IG)
1.0.0 - STU1 Release 1
Health Care Surveys Content Implementation Guide (IG)
1.0.0 - STU1 Release 1
This page is part of the Making EHR Data MOre available for Research and Public Health (MedMorph) Healthcare Surveys Reporting Content IG (v1.0.0: STU1 Release 1) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions 
| Active as of 2023-06-01 |
{
"resourceType" : "PlanDefinition",
"id" : "plandefinition-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\">Placeholder</div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-receiver-endpoint",
"valueReference" : {
"reference" : "Endpoint/example-ph-endpoint"
}
}
],
"url" : "http://hl7.org/fhir/us/health-care-surveys-reporting/StructureDefinition/plandefinition-example",
"version" : "1.0.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" : "active",
"experimental" : true,
"date" : "2023-06-01T12:32:29.858-05:00",
"publisher" : "HL7 International - Public Health Work Group",
"contact" : [
{
"telecom" : [
{
"system" : "url",
"value" : "http://hl7.org/Special/committees/pher"
}
]
}
],
"description" : "This is the Health Care Survey Reporting Knowledge Artifact",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "US"
}
]
}
],
"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" : "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-hcs-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-hcs-report",
"relationship" : "before-start"
}
]
}
]
},
{
"id" : "create-hcs-report",
"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" : "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" : "hcs-report",
"type" : "Bundle",
"profile" : [
"http://hl7.org/fhir/us/health-care-surveys-reporting/StructureDefinition/hcs-reporting-bundle"
]
}
],
"relatedAction" : [
{
"actionId" : "validate-hcs-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",
"extension" : [
{
"url" : "http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-relateddata-extension",
"valueString" : "hcs-report"
}
],
"type" : "Bundle",
"profile" : [
"http://hl7.org/fhir/us/health-care-surveys-reporting/StructureDefinition/hcs-reporting-bundle"
]
}
],
"output" : [
{
"id" : "validated-hcs-report",
"type" : "Bundle",
"profile" : [
"http://hl7.org/fhir/us/health-care-surveys-reporting/StructureDefinition/hcs-reporting-bundle"
]
}
],
"relatedAction" : [
{
"actionId" : "submit-hcs-report",
"relationship" : "before-start"
}
]
},
{
"id" : "submit-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",
"extension" : [
{
"url" : "http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-relateddata-extension",
"valueString" : "validated-hcs-report"
}
],
"type" : "Bundle",
"profile" : [
"http://hl7.org/fhir/us/health-care-surveys-reporting/StructureDefinition/hcs-reporting-bundle"
]
}
]
}
]
}
IG © 2021+ HL7 International - Public Health Work Group. Package hl7.fhir.us.health-care-surveys-reporting#1.0.0 based on FHIR 4.0.1. Generated 2023-08-22
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change