StructureDefinition-ersd-plandefinition

Sourcehl7.fhir.us.ecr#current:HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm (v4.0.1)
resourceTypeStructureDefinition
idersd-plandefinition
canonicalhttp://hl7.org/fhir/us/ecr/StructureDefinition/ersd-plandefinition
version2.1.0
statusactive
publisherHL7 Public Health Work Group (http://www.hl7.org/Special/committees/pher/index.cfm)
nameERSDPlanDefinition
titleeRSD PlanDefinition
date2023-03-21T02:41:38+00:00
experimentalfalse
descriptionThis PlanDefinition profile defines the logic and rules around determining: whether or not a condition is reportable to public health, which jurisdiction(s) is/are responsible, which jurisdiction(s) need to be notified, and if the condition is reportable, gives timing information, next steps and condition information to the clinician. The rules for determining reportability described by an eRSD specification involve the use of triggering codes to determine potentially reportable events, and optionally locally evaluated rules for determining suspected reportable events. The final determination of reportability is made by the Public Health Agency or Agencies appropriate for the event, and may be performed by a combination of decisions occurring at various points during the processing of an eICR, as explained in the Reportability Response profile.
jurisdictionsus
fhirVersion4.0.1
kindresource
abstractfalse
sdTtypePlanDefinition
derivationconstraint
basehttp://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-plandefinition
Usages
Name Flags Card. Type Description & Constraints doco
. . PlanDefinition S USPublicHealthPlanDefinition eRSD - electronic Reporting and Surveillance Distribution
. . . Slices for extension S Slice: Unordered, Open by value:url
. . . variable S 0..* Expression Variable for processing
URL: http://hl7.org/fhir/StructureDefinition/variable
. . . 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
. . . . . . Slices for extension S Slice: Unordered, Open by value:url
. . . . . . us-ph-fhirquerypattern-extension S 0..1 string US Public Health FHIR Query Pattern Extension
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-fhirquerypattern-extension
. . . . . . . url S 1..1 "http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-fhirquerypattern-extension"
. . . . . relatedAction
. . . . . . offsetDuration S
. . . . action:encounterStart S 1..1 Encounter start code
. . . . . id S 1.. Fixed Value: start-workflow
. . . . . description S 1.. Description of the "start" action.
Fixed Value: This action represents the start of the reporting workflow in response to the encounter-start event.
. . . . . textEquivalent S 1.. Text equivalent of the "start" action.
Fixed Value: Start the reporting workflow in response to an encounter-start 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/ecr/CodeSystem/us-ph-plandefinition-actions
. . . . . . . code 1..1 code Symbol in syntax defined by the system
Fixed Value: initiate-reporting-workflow
. . . . . trigger S C 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/ecr/StructureDefinition/us-ph-named-eventtype-extension
Binding: US Public Health TriggerDefinition NamedEvent ( extensible ): US Public Health TriggerDefinition NamedEvents


. . . . . . type Fixed Value: named-event
. . . . . . name Fixed Value: encounter-start
. . . . . relatedAction S 1..1
. . . . . . actionId Fixed Value: check-suspected-disorder
. . . . . . relationship Fixed Value: before-start
. . . . . . offsetDuration 0..1 Duration Example Wait 1 hour before next action.: {"value":1,"unit":"h"}
. . . . action:checkSuspectedDisorder S 1..1 Check suspected disorder
. . . . . id S 1.. Fixed Value: check-suspected-disorder
. . . . . description S 1.. Description of the check for suspected disorders action.
Fixed Value: This action represents the start of the check suspected disorder reporting workflow in response to the encounter-start event.
. . . . . code S 1..1 Code for the "check-suspected-disorder" 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/ecr/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:isEncounterSuspectedDisorder S 1..1 BackboneElement
. . . . . . . id S 1.. Fixed Value: is-encounter-suspected-disorder
. . . . . . . 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/ecr/CodeSystem/us-ph-plandefinition-actions
. . . . . . . . . code 1..1 code Symbol in syntax defined by the system
Fixed Value: check-trigger-codes
. . . . . . . condition
. . . . . . . . kind Fixed Value: applicability
. . . . . . . . expression S 1..
. . . . . . . . . language Fixed Value: text/fhirpath
. . . . . . . input S
. . . . . . . . id S 1..1
. . . . . . . relatedAction
. . . . . . . . actionId Fixed Value: create-eicr
. . . . . . . . relationship Fixed Value: before-start
. . . . . . action:continueCheckReportable S 1..1 BackboneElement
. . . . . . . id S 1.. Fixed Value: continue-check-reportable
. . . . . . . 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/ecr/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
. . . . . . . relatedAction
. . . . . . . . actionId Fixed Value: check-reportable
. . . . . . . . relationship Fixed Value: before-start
. . . . . . . . offsetDuration 0..1 Duration Example Wait 6 hours before next action.: {"value":6,"unit":"h"}
. . . . action:checkReportable 1..1 Check the encounter for reportability
. . . . . id S 1.. Fixed Value: check-reportable
. . . . . description Description of the Periodic Update of eICR action.
Fixed Value: This action represents the check for suspected reportability of the eICR.
. . . . . 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/ecr/CodeSystem/us-ph-plandefinition-actions
. . . . . . . code 1..1 code Symbol in syntax defined by the system
Fixed Value: execute-reporting-workflow
. . . . . Slices for action 3 .. Slice: Unordered, Open by value:id
. . . . . . action:isEncounterReportable S 1..1 BackboneElement
. . . . . . . id S 1.. Fixed Value: is-encounter-reportable
. . . . . . . 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/ecr/CodeSystem/us-ph-plandefinition-actions
. . . . . . . . . code 1..1 code Symbol in syntax defined by the system
Fixed Value: check-trigger-codes
. . . . . . . condition
. . . . . . . . kind Fixed Value: applicability
. . . . . . . . expression S 1..
. . . . . . . . . language Fixed Value: text/fhirpath
. . . . . . . input S
. . . . . . . . id S 1..1
. . . . . . . relatedAction
. . . . . . . . actionId Fixed Value: create-eicr
. . . . . . . . relationship Fixed Value: before-start
. . . . . . action:checkUpdateEicr S 1..1 BackboneElement
. . . . . . . id S 1.. Fixed Value: check-update-eicr
. . . . . . . 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/ecr/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
. . . . . . . relatedAction
. . . . . . . . actionId Fixed Value: create-eicr
. . . . . . . . relationship Fixed Value: before-start
. . . . . . action:encounterInProgress S 1..1 BackboneElement
. . . . . . . id S 1.. Fixed Value: is-encounter-in-progress
. . . . . . . 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/ecr/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
. . . . . . . relatedAction
. . . . . . . . actionId Fixed Value: check-reportable
. . . . . . . . relationship Fixed Value: before-start
. . . . . . . . offsetDuration 0..1 Duration Example Wait 6 hours before next action.: {"value":6,"unit":"h"}
. . . . action:createEicr 1..1 Create the eICR
. . . . . id S 1.. Fixed Value: create-eicr
. . . . . description Fixed Value: This action represents the creation of the eICR. It subsequently calls validate.
. . . . . 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/ecr/CodeSystem/us-ph-plandefinition-actions
. . . . . . . code 1..1 code Symbol in syntax defined by the system
Fixed Value: create-report
. . . . . relatedAction S 1..1
. . . . . . actionId Fixed Value: validate-eicr
. . . . . . relationship Fixed Value: before-start
. . . . action:validateEicr 1..1 Validate the eICR
. . . . . id S 1.. Fixed Value: validate-eicr
. . . . . description Fixed Value: This action represents the validation of the eICR. It subsequently calls route-and-send.
. . . . . 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/ecr/CodeSystem/us-ph-plandefinition-actions
. . . . . . . code 1..1 code Symbol in syntax defined by the system
Fixed Value: validate-report
. . . . . relatedAction S 1..1
. . . . . . actionId Fixed Value: route-and-send-eicr
. . . . . . relationship Fixed Value: before-start
. . . . action:routeAndSendEicr 1..1 Route and send eICR
. . . . . id S 1.. Fixed Value: route-and-send-eicr
. . . . . description S 1.. Description of the route and send action.
Fixed Value: This action represents the routing and sending of the eICR.
. . . . . textEquivalent S 1.. Fixed Value: Route and send eICR
. . . . . 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/ecr/CodeSystem/us-ph-plandefinition-actions
. . . . . . . code 1..1 code Symbol in syntax defined by the system
Fixed Value: submit-report
. . . . action:encounterModified S 1..1 Encounter modified code
. . . . . id S 1.. Fixed Value: encounter-modified
. . . . . description S 1.. Description of the "encounter-modified" action.
Fixed Value: This action represents the start of the reporting workflow in response to the encounter-modified event
. . . . . textEquivalent S 1.. Text equivalent of the "encounter-modified" action.
Fixed Value: Start the reporting workflow in response to an encounter-modified event
. . . . . code S 1..1 Code for the "encounter-modified" 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/ecr/CodeSystem/us-ph-plandefinition-actions
. . . . . . . code 1..1 code Symbol in syntax defined by the system
Fixed Value: initiate-reporting-workflow
. . . . . trigger S C 1.. When the "encounter-modified" 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/ecr/StructureDefinition/us-ph-named-eventtype-extension
Binding: US Public Health TriggerDefinition NamedEvent ( extensible ): US Public Health TriggerDefinition NamedEvents


. . . . . . type Fixed Value: named-event
. . . . . . name Fixed Value: encounter-modified
. . . . . condition
. . . . . . kind Fixed Value: applicability
. . . . . . expression S 1..
. . . . . . . language Fixed Value: text/fhirpath
. . . . . relatedAction S 1..1
. . . . . . actionId Fixed Value: create-eicr
. . . . . . relationship Fixed Value: before-start

doco Documentation for this format

Produced 06 Apr 2023