StructureDefinition-hcs-plandefinition

Sourcehl7.fhir.us.health-care-surveys-reporting#current:Health Care Surveys Content Implementation Guide (IG) (v4.0.1)
resourceTypeStructureDefinition
idhcs-plandefinition
canonicalhttp://hl7.org/fhir/us/health-care-surveys-reporting/StructureDefinition/hcs-plandefinition
version1.0.0
statusactive
publisherHL7 International - Public Health Work Group
nameHCSPlanDefinition
titleHealth Care Surveys PlanDefinition
date2023-08-22T18:57:55+00:00
experimentalfalse
descriptionThis PlanDefinition profile defines the logic and rules around determining: whether or not data from an encounter is reportable to National Center for Health Statistics (NCHS).
jurisdictionsus
fhirVersion4.0.1
kindresource
abstractfalse
sdTtypePlanDefinition
derivationconstraint
basehttp://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-plandefinition
Usages(none)
Name Flags Card. Type Description & Constraints doco
. . PlanDefinition S USPublicHealthPlanDefinition Health Care Surveys Knowledge Artifact
. . . Slices for action S 5 .. Slice: Ordered, Open by value:id
. . . . action:All Slices Content/Rules for all slices
. . . . . code S 0..1 Binding: US Public Health PlanDefinition Action ( extensible ): The set of actions that can be used to create plan definition

. . . . . input
. . . . action:startWorkflow S 1..1 Start Workflow Action
. . . . . id S 1.. Fixed Value: start-workflow
. . . . . description S 1.. Starts the workflow
Fixed Value: This action represents the start of the reporting workflow in response to the encounter-end event
. . . . . textEquivalent S 1.. Text equivalent of the start workflow action.
Fixed Value: Start the reporting workflow in response to an encounter-end event
. . . . . code S 1..1 Code for the "start" action.
Required Pattern: At least the following
. . . . . . coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
. . . . . . . system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions
. . . . . . . code 1..1 code Symbol in syntax defined by the system
Fixed Value: initiate-reporting-workflow
. . . . . trigger S 1.. When the "start" action should be triggered.
. . . . . . Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
. . . . . . namedEventType S 0..1 CodeableConcept Indicates the types of named events to subscribe to from the HER.
URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-named-eventtype
Binding: US Public Health TriggerDefinition NamedEvent ( extensible ): US Public Health TriggerDefinition NamedEvents


. . . . . . type Fixed Value: named-event
. . . . . . name Fixed Value: encounter-end
. . . . . relatedAction S 1..1
. . . . . . actionId Fixed Value: check-reportability
. . . . . . relationship Fixed Value: before-start
. . . . . . offsetDuration 0..1 Duration Example Wait 72 hour before next action.: {"value":72,"unit":"h"}
. . . . action:executeReportingWorkflow S 1..1 Execute Reporting Workflow
. . . . . id S 1.. Fixed Value: check-reportability
. . . . . description S 1.. Check for reportability conditions
Fixed Value: 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.
. . . . . code S 1..1 Code for the "execute-reporting-workflow" action.
Required Pattern: At least the following
. . . . . . coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
. . . . . . . system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions
. . . . . . . code 1..1 code Symbol in syntax defined by the system
Fixed Value: execute-reporting-workflow
. . . . . Slices for action 2 .. Slice: Unordered, Open by value:id
. . . . . . action:isAmbulatoryEncounterReportable S 1..1 BackboneElement
. . . . . . . id S 1.. Fixed Value: is-ambulatory-encounter-reportable
. . . . . . . code 1..1 Required Pattern: At least the following
. . . . . . . . coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
. . . . . . . . . system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions
. . . . . . . . . code 1..1 code Symbol in syntax defined by the system
Fixed Value: evaluate-condition
. . . . . . . condition
. . . . . . . . kind Fixed Value: applicability
. . . . . . . . expression S 1..
. . . . . . . . . language Fixed Value: text/fhirpath
. . . . . . . input S
. . . . . . . . id S 1..1
. . . . . . . relatedAction
. . . . . . . . actionId Fixed Value: create-hcs-report
. . . . . . . . relationship Fixed Value: before-start
. . . . . . action:isInpatientEncounterReportable S 1..1 BackboneElement
. . . . . . . id S 1.. Fixed Value: is-inpatient-encounter-reportable
. . . . . . . code 1..1 Required Pattern: At least the following
. . . . . . . . coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
. . . . . . . . . system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions
. . . . . . . . . code 1..1 code Symbol in syntax defined by the system
Fixed Value: evaluate-condition
. . . . . . . condition
. . . . . . . . kind Fixed Value: applicability
. . . . . . . . expression S 1..
. . . . . . . . . language Fixed Value: text/fhirpath
. . . . . . . input S
. . . . . . . . id S 1..1
. . . . . . . relatedAction
. . . . . . . . actionId Fixed Value: create-hcs-report
. . . . . . . . relationship Fixed Value: before-start
. . . . action:createReport 1..1
. . . . . id S 1.. Fixed Value: create-hcs-report
. . . . . description Fixed Value: This action represents the creation, validation and submission of the health care survey report.
. . . . . code 1.. Required Pattern: At least the following
. . . . . . coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
. . . . . . . system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions
. . . . . . . code 1..1 code Symbol in syntax defined by the system
Fixed Value: create-report
. . . . . input S
. . . . . . id S 1..1
. . . . . output S
. . . . . . id S 1..1
. . . . . relatedAction
. . . . . . actionId Fixed Value: validate-hcs-report
. . . . . . relationship Fixed Value: before-start
. . . . action:validateReport 1..1
. . . . . id S 1.. Fixed Value: validate-hcs-report
. . . . . description Fixed Value: This action represents the validation of the HCS Report
. . . . . code Required Pattern: At least the following
. . . . . . coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
. . . . . . . system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions
. . . . . . . code 1..1 code Symbol in syntax defined by the system
Fixed Value: validate-report
. . . . . input S
. . . . . . id S 1..1
. . . . . output S
. . . . . . id S 1..1
. . . . . relatedAction
. . . . . . actionId Fixed Value: submit-hcs-report
. . . . . . relationship Fixed Value: before-start
. . . . action:submitHcsReport 1..1 Route and send HCS Report
. . . . . id S 1.. Fixed Value: submit-hcs-report
. . . . . description S 1.. Description of the route and send action.
Fixed Value: This action represents the routing and sending of the HCS Report
. . . . . textEquivalent S 1.. Fixed Value: Route and send HCS Report
. . . . . code Required Pattern: At least the following
. . . . . . coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
. . . . . . . system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions
. . . . . . . code 1..1 code Symbol in syntax defined by the system
Fixed Value: submit-report
. . . . . input S
. . . . . . id S 1..1

doco Documentation for this format

Produced 08 Sep 2023