electronic Case Reporting (eCR) Implementation Guide: STU2 Ballot

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

SD.23 StructureDefinition-rr-relevant-reportable-condition-plandefinition

eCR Profile: rr-relevant-reportable-condition-plandefinition

Scope and Usage

The Relevant Reportable Condition Information PlanDefinition 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.23.1 Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

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

Published on Wed Aug 01 00:00:00 AEST 2018 as a draft by .

This profile builds on PlanDefinition

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition S0..*Relevant Reportable Condition PlanDefinition
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... extension-rr-determination-of-reportability S1..1CodeableConceptExtension Determination of Reportability
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-determination-of-reportability
Binding: Determination of Reportability (eCR) (extensible)
... extension-rr-determination-of-reportability-reason 0..*string, CodeableConceptDetermination of Reportability Reason
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-determination-of-reportability-reason
... extension-rr-determination-of-reportability-rule 0..*stringDetermination of Reportability Rule
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-determination-of-reportability-rule
... status 1..1codeFixed Value: active
... publisher S1..1stringRules Authoring Agency
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... extension-ecr-organization S1..*Reference(eCR Organization Profile)eCR Organization
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/extension-ecr-organization
..... url 1..1uri"http://hl7.org/fhir/us/ecr/StructureDefinition/extension-ecr-organization"
..... valueReference 1..1Reference(Rules Authoring Agency)
... jurisdiction S0..*CodeableConcept
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... extension-rr-location-relevance S1..*CodeableConceptLocation relevance
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-location-relevance
Binding: Location Relevance (eCR) (extensible)
.... extension-ecr-organization S1..*Reference(eCR Organization Profile)eCR Organization
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/extension-ecr-organization
..... url 1..1uri"http://hl7.org/fhir/us/ecr/StructureDefinition/extension-ecr-organization"
..... valueReference 1..1Reference(Routing Entity)
.... extension-ecr-organization S0..*Reference(eCR Organization Profile)eCR Organization
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/extension-ecr-organization
..... url 1..1uri"http://hl7.org/fhir/us/ecr/StructureDefinition/extension-ecr-organization"
..... valueReference 1..1Reference(Responsible Agency)
... goal S1..1BackboneElementGoal of the plan
.... description S1..1CodeableConcept
..... coding 0..0
..... text 1..1stringText description goal
Example General': Clinical feedback
.... addresses S1..1CodeableConceptRelevant Reportable Condition
..... coding S0..1Coding
...... system 0..1uriFixed Value: http://snomed.info/sct
..... text S0..1stringRelevant reportable condition text description
... action S0..*BackboneElementExternal resources and related information
.... documentation S1..*RelatedArtifactExternal Resource
..... extension 0..*ExtensionSlice: Unordered, Open by value:url
..... extension-rr-external-resource-type S0..*CodeableConceptExternal Resource Type/Category
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-external-resource-type
Binding: External Resource Type (eCR) (extensible)
..... extension-rr-priority S0..*CodeableConceptReportability Response Priority
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-priority
Binding: Reportability Priority (eCR) (extensible)
..... type S1..1codeFixed Value: documentation
..... display S1..1stringExternal Resource Description
..... url S0..1uriExternal Resource Link
.... timingDuration S0..1DurationReporting Timeframe
Required Pattern: {"system":"http://unitsofmeasure.org"}
..... value S1..1decimal
..... unit S1..1string

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition SI0..*Relevant Reportable Condition PlanDefinition
... 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..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension-rr-determination-of-reportability SI1..1CodeableConceptExtension
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-determination-of-reportability
Binding: Determination of Reportability (eCR) (extensible)
... extension-rr-determination-of-reportability-reason I0..*string, CodeableConceptExtension
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-determination-of-reportability-reason
... extension-rr-determination-of-reportability-rule I0..*stringExtension
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-determination-of-reportability-rule
... 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)
Fixed Value: active
... experimental ?!Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate this was last changed
... publisher SΣ1..1stringRules Authoring Agency
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... extension-ecr-organization SI1..*Reference(eCR Organization Profile)Extension
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/extension-ecr-organization
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"http://hl7.org/fhir/us/ecr/StructureDefinition/extension-ecr-organization"
..... valueReference 1..1Reference(Rules Authoring Agency)Value of extension
.... 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 SΣ0..*CodeableConceptIntended jurisdiction for plan definition (if applicable)
Binding: Jurisdiction ValueSet (extensible)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... extension-rr-location-relevance S1..*CodeableConceptExtension
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-location-relevance
Binding: Location Relevance (eCR) (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-location-relevance"
..... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: Location Relevance (eCR) (extensible)
Example General': {"coding":[{"system":"urn:oid:2.16.840.1.114222.4.5.274","code":"RRVS5","display":"Patient home address"}]}
.... extension-ecr-organization S1..*Reference(eCR Organization Profile)Extension
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/extension-ecr-organization
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"http://hl7.org/fhir/us/ecr/StructureDefinition/extension-ecr-organization"
..... valueReference 1..1Reference(Routing Entity)Value of extension
.... extension-ecr-organization S0..*Reference(eCR Organization Profile)Extension
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/extension-ecr-organization
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"http://hl7.org/fhir/us/ecr/StructureDefinition/extension-ecr-organization"
..... valueReference 1..1Reference(Responsible Agency)Value of extension
.... coding Σ0..*CodingCode defined by a terminology system
.... text Σ0..1stringPlain text representation of the concept
... 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 0..*RelatedArtifactRelated artifacts for the asset
... library 0..*Reference(Library)Logic used by the plan definition
... goal SI1..1BackboneElementGoal of the plan
.... 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 S1..1CodeableConceptCode or text describing the goal
Binding: SNOMED CT Clinical Findings (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... text Σ1..1stringText description goal
Example General': Clinical feedback
.... priority 0..1CodeableConcepthigh-priority | medium-priority | low-priority
Binding: GoalPriority (preferred)
.... start 0..1CodeableConceptWhen goal pursuit begins
Binding: GoalStartEvent (example)
.... addresses S1..1CodeableConceptRelevant Reportable Condition
Binding: Condition/Problem/Diagnosis Codes (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding SΣ0..1CodingCode defined by a terminology system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ0..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text SΣ0..1stringRelevant reportable condition text description
.... 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..*BackboneElementExternal resources and related information
.... 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 S1..*RelatedArtifactExternal Resource
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... extension-rr-external-resource-type S0..*CodeableConceptExtension
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-external-resource-type
Binding: External Resource Type (eCR) (extensible)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-external-resource-type"
...... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: External Resource Type (eCR) (extensible)
..... extension-rr-priority S0..*CodeableConceptExtension
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-priority
Binding: Reportability Priority (eCR) (extensible)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-priority"
...... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: Reportability Priority (eCR) (extensible)
Example General': {"coding":[{"system":"urn:oid:2.16.840.1.114222.4.5.232","code":"RRVS17","display":"Action required"}]}
..... type SΣ1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required)
Fixed Value: documentation
..... display SΣ1..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
.... 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
.... timingDuration S0..1DurationReporting Timeframe
Example General': {}
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... value SΣ1..1decimalNumerical value (with implicit precision)
..... comparator ?!Σ0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required)
..... unit SΣ1..1stringUnit representation
..... system ΣI0..1uriSystem that defines coded unit form
..... code Σ0..1codeCoded form of the unit
.... 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 | 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