electronic Case Reporting (eCR) Implementation Guide Release For Comment Ballot Version

This page is part of the electronic Case Reporting (eCR) (v0.1.0: STU 1 Ballot 1) based on FHIR R3. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

SD.27 StructureDefinition-rr-plandefinition

source file: source/pages/_includes/rr-plandefinition-intro.md

ECR Profile: Reportability Response PlanDefinition Profile

Scope and Usage

The Reportability Response Plan Definition profile establishes the core elements, extensions, vocabularies and value sets for representing the following for electronic case reporting:

  • The Reportability Response case definitions and reporting requirements which include:

    • The data that are needed to determine reportability
    • For a given condition , the mandated timeframe in which the condition should be reported to the PHA.
  • The name of the Responsible Agency(ies) in which the condition was determined to be or not be reportable
  • The External Resources (text and links)in association with specific conditions

Additional Profile specific implementation guidance:

  • None

Examples

SD.27.1 Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: http://fhir.hl7.org/us/ecr/StructureDefinition/rr-plandefinition

Published on Sat Jul 15 00:00:00 AEST 2017 as a draft by .

This profile builds on PlanDefinition

Summary

Mandatory: 0 element (2 nested mandatory elements)
Must-Support: 11 elements
Fixed Value: 1 element

Extensions

This structure refers to these extensions:

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition I0..*The definition of a plan for a series of actions, independent of any specific patient or context
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ0..1uriLogical URI to reference this plan definition (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the plan definition
... version Σ0..1stringBusiness version of the plan definition
... name Σ0..1stringName for this plan definition (computer friendly)
... title Σ0..1stringName for this plan definition (human friendly)
... type Σ0..1CodeableConceptorder-set | protocol | eca-rule
Binding: PlanDefinitionType (extensible)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... experimental ?!Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate this was last changed
... publisher SΣ0..1stringAuthoring agency name
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension-publisher-reference SI0..1Reference(eCR Organization Profile)Authoring agency reference
URL: http://fhir.hl7.org/us/ecr/StructureDefinition/extension-publisher-reference
.... value 0..1Primitive value for string
Max Length: 1048576
... description Σ0..1markdownNatural language description of the plan definition
... purpose 0..1markdownWhy this plan definition is defined
... usage 0..1stringDescribes the clinical usage of the asset
... approvalDate 0..1dateWhen the plan definition was approved by publisher
... lastReviewDate 0..1dateWhen the plan definition was last reviewed
... effectivePeriod Σ0..1PeriodWhen the plan definition is expected to be used
... useContext Σ0..*UsageContextContext the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for plan definition (if applicable)
Binding: Jurisdiction ValueSet (extensible)
... topic 0..*CodeableConceptE.g. Education, Treatment, Assessment, etc
Binding: DefinitionTopic (example)
... contributor 0..*ContributorA content contributor
... contact Σ0..*ContactDetailContact details for the publisher
... copyright 0..1markdownUse and/or publishing restrictions
... relatedArtifact S0..*RelatedArtifactExternal Resource
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension-rel-artifact-category S0..1codeExternal Resource Category
URL: http://fhir.hl7.org/us/ecr/StructureDefinition/extension-rel-artifact-category
Binding: External Resource Type (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"http://fhir.hl7.org/us/ecr/StructureDefinition/extension-rel-artifact-category"
..... valueCode 0..1codeValue of extension
Binding: External Resource Type (extensible)
.... extension-rel-artifact-priority S0..1codeExternal Resource Priority
URL: http://fhir.hl7.org/us/ecr/StructureDefinition/extension-rel-artifact-priority
Binding: Reportability Priority (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"http://fhir.hl7.org/us/ecr/StructureDefinition/extension-rel-artifact-priority"
..... valueCode 0..1codeValue of extension
Binding: Reportability Priority (extensible)
.... type SΣ1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required)
Fixed Value: documentation
.... display SΣ0..1stringExternal Resource Description
.... citation Σ0..1stringBibliographic citation for the artifact
.... url SΣ0..1uriExternal Resource Link
.... document Σ0..1AttachmentWhat document is being referenced
.... resource Σ0..1Reference(Resource)What resource is being referenced
... library 0..*Reference(Library)Logic used by the plan definition
... goal I0..*BackboneElementWhat the plan is trying to accomplish
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... category 0..1CodeableConceptE.g. Treatment, dietary, behavioral, etc
Binding: GoalCategory (example)
.... description 1..1CodeableConceptCode or text describing the goal
Binding: SNOMED CT Clinical Findings (example)
.... priority 0..1CodeableConcepthigh-priority | medium-priority | low-priority
Binding: GoalPriority (preferred)
.... start 0..1CodeableConceptWhen goal pursuit begins
Binding: GoalStartEvent (example)
.... addresses 0..*CodeableConceptWhat does the goal address
Binding: Condition/Problem/Diagnosis Codes (example)
.... documentation 0..*RelatedArtifactSupporting documentation for the goal
.... target I0..*BackboneElementTarget outcome for the goal
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... measure 0..1CodeableConceptThe parameter whose value is to be tracked
Binding: LOINC Codes (example)
..... detail[x] 0..1Quantity, Range, CodeableConceptThe target value to be achieved
..... due 0..1DurationReach goal within
... action SI0..*BackboneElementAction defined by the plan
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... label 0..1stringUser-visible label for the action (e.g. 1. or A.)
.... title 0..1stringUser-visible title
.... description 0..1stringShort description of the action
.... textEquivalent 0..1stringStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
.... code 0..*CodeableConceptCode representing the meaning of the action or sub-actions
.... reason 0..*CodeableConceptWhy the action should be performed
.... documentation 0..*RelatedArtifactSupporting documentation for the intended performer of the action
.... goalId 0..*idWhat goals this action supports
.... triggerDefinition 0..*TriggerDefinitionWhen the action should be triggered
.... condition I0..*BackboneElementWhether or not the action is applicable
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... kind 1..1codeapplicability | start | stop
Binding: ActionConditionKind (required)
..... description 0..1stringNatural language description of the condition
..... language 0..1stringLanguage of the expression
..... expression 0..1stringBoolean-valued expression
.... input 0..*DataRequirementInput data requirements
.... output 0..*DataRequirementOutput data definition
.... relatedAction I0..*BackboneElementRelationship to another action
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... actionId 1..1idWhat action is this related to
..... relationship 1..1codebefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Binding: ActionRelationshipType (required)
..... offset[x] 0..1Duration, RangeTime offset for the relationship
.... timing[x] S0..1TimingWhen the action should take place
..... id 0..1stringxml:id (or equivalent in JSON)
..... event Σ0..*dateTimeWhen the event occurs
..... repeat ΣI0..1ElementWhen the event is to occur
tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV)
tim-5: period SHALL be a non-negative value
tim-6: If there's a periodMax, there must be a period
tim-7: If there's a durationMax, there must be a duration
tim-8: If there's a countMax, there must be a count
tim-1: if there's a duration, there needs to be duration units
tim-10: If there's a timeOfDay, there cannot be be a when, or vice versa
tim-2: if there's a period, there needs to be period units
tim-4: duration SHALL be a non-negative value
...... id 0..1stringxml:id (or equivalent in JSON)
...... bounds[x] Σ0..1Duration, Range, PeriodLength/Range of lengths, or (Start and/or end) limits
...... count Σ0..1integerNumber of times to repeat
...... countMax Σ0..1integerMaximum number of times to repeat
...... duration Σ0..1decimalHow long when it happens
...... durationMax Σ0..1decimalHow long when it happens (Max)
...... durationUnit Σ0..1codes | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required)
...... frequency Σ0..1integerEvent occurs frequency times per period
...... frequencyMax Σ0..1integerEvent occurs up to frequencyMax times per period
...... period Σ0..1decimalEvent occurs frequency times per period
...... periodMax Σ0..1decimalUpper limit of period (3-4 hours)
...... periodUnit Σ0..1codes | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required)
...... dayOfWeek Σ0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
...... timeOfDay Σ0..*timeTime of day for action
...... when Σ0..*codeRegular life events the event is tied to
Binding: EventTiming (required)
...... offset Σ0..1unsignedIntMinutes from event (before or after)
..... code SΣ1..1CodeableConceptReporting Timeframe
Binding: ReportingTimeframe (extensible)
.... participant I0..*BackboneElementWho should participate in the action
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... type 1..1codepatient | practitioner | related-person
Binding: ActionParticipantType (required)
..... role 0..1CodeableConceptE.g. Nurse, Surgeon, Parent, etc
Binding: ActionParticipantRole (example)
.... type 0..1Codingcreate | update | remove | fire-event
Binding: ActionType (required)
.... groupingBehavior 0..1codevisual-group | logical-group | sentence-group
Binding: ActionGroupingBehavior (required)
.... selectionBehavior 0..1codeany | all | all-or-none | exactly-one | at-most-one | one-or-more
Binding: ActionSelectionBehavior (required)
.... requiredBehavior 0..1codemust | could | must-unless-documented
Binding: ActionRequiredBehavior (required)
.... precheckBehavior 0..1codeyes | no
Binding: ActionPrecheckBehavior (required)
.... cardinalityBehavior 0..1codesingle | multiple
Binding: ActionCardinalityBehavior (required)
.... definition 0..1Reference(ActivityDefinition), Reference(PlanDefinition)Description of the activity to be performed
.... transform 0..1Reference(StructureMap)Transform to apply the template
.... dynamicValue I0..*BackboneElementDynamic aspects of the definition
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... description 0..1stringNatural language description of the dynamic value
..... path 0..1stringThe path to the element to be set dynamically
..... language 0..1stringLanguage of the expression
..... expression 0..1stringAn expression that provides the dynamic value for the customization
.... action 0..*Unknown reference to #PlanDefinition.action
A sub-action

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

SD.27.2 Quick Start

Below is an overview of the required set of RESTful FHIR interactions - for example, search and read operations - for this profile. See the Conformance requirements for a complete list of supported RESTful interactions for this IG.

...todo...