HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm CI Build

This page is part of the electronic Case Reporting (eCR) (v1.0.0: STU 1) based on FHIR R4. 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.15 StructureDefinition-rr-relevant-reportable-condition-plandefinition

This PlanDefinition in the Reportability Response transaction represents reportability information for a condition-jurisdiction pair, based on the PHA in which is located the patient’s home, the provider facility or both locations. The Determination of Reportability, Determination of Reportability Reason, and Determination of Reportability Rule are contained in extensions. This profile also contains extensions for the Responsible Agency, the Rules Authoring Agency, and the Routing Entity. The Relevant Reportable Condition is contained in goal.addresses and any External Resources are contained in action (one action may contain multiple External Resources (documentation)).

SD.15.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 Jan 29 20:30:08 UTC 2020 as a active by HL7 Public Health Work Group.

This profile builds on PlanDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition S0..*PlanDefinitionRelevant Reportable Condition PlanDefinition
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... rr-determination-of-reportability-extension S1..1CodeableConceptExtension Determination of Reportability
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-determination-of-reportability-extension
... rr-determination-of-reportability-reason-extension S0..*string, CodeableConceptDetermination of Reportability Reason
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-determination-of-reportability-reason-extension
... status 1..1codeFixed Value: active
... publisher S1..1stringRules Authoring Agency
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... rr-rules-authoring-agency-organization-extension S1..*Reference(Rules Authoring Agency Organization)eCR Organization
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-rules-authoring-agency-organization-extension
... jurisdiction S1..1CodeableConcept
.... extension 1..*ExtensionSlice: Unordered, Open by value:url
.... rr-location-relevance-extension S1..1CodeableConceptLocation relevance
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-location-relevance-extension
Binding: https://phinvads.cdc.gov/vads/ViewValueSet.action?oid=2.16.840.1.113883.10.20.15.2.5.6 (extensible)
.... rr-routing-entity-organization-extension S1..*Reference(Routing Entity Organization)eCR Organization
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-routing-entity-organization-extension
.... rr-responsible-agency-organization-extension S0..*Reference(Responsible Agency Organization)eCR Organization
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-responsible-agency-organization-extension
... goal S1..1BackboneElementGoal of the plan
.... description S1..1CodeableConcept
..... coding 0..0
..... text 1..1stringText description goal
Required Pattern: Reportability Feedback
.... addresses S1..1CodeableConceptRelevant Reportable Condition
..... coding S0..1Coding
...... system S0..1uriFixed Value: http://snomed.info/sct
..... text S0..1stringRelevant reportable condition text description
... action S1..1BackboneElementExternal resources and related information
.... documentation S1..*RelatedArtifactExternal Resource
..... extension 0..*ExtensionSlice: Unordered, Open by value:url
..... rr-external-resource-type-extension S1..1CodeableConceptExternal Resource Type/Category
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-external-resource-type-extension
Binding: https://phinvads.cdc.gov/vads/ViewValueSet.action?oid=2.16.840.1.113883.10.20.15.2.5.4 (extensible)
..... rr-priority-extension S1..1CodeableConceptReportability Response Priority
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-priority-extension
Binding: https://phinvads.cdc.gov/vads/ViewValueSet.action?oid=2.16.840.1.113883.10.20.15.2.5.5 (extensible)
..... type S1..1codeFixed Value: documentation
..... display S1..1stringExternal Resource Description
..... url S0..1urlExternal Resource Link
.... timing[x] S0..1DurationReporting timeframe

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition SI0..*PlanDefinitionRelevant Reportable Condition PlanDefinition
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... rr-determination-of-reportability-extension SI1..1CodeableConceptExtension Determination of Reportability
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-determination-of-reportability-extension
... rr-determination-of-reportability-reason-extension SI0..*string, CodeableConceptDetermination of Reportability Reason
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-determination-of-reportability-reason-extension
... rr-determination-of-reportability-rule-extension SI0..*stringDetermination of Reportability Rule
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-determination-of-reportability-rule-extension
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... url ΣI0..1uriCanonical identifier for this plan definition, represented as a URI (globally unique)
... identifier ΣI0..*IdentifierAdditional identifier for the plan definition
... version ΣI0..1stringBusiness version of the plan definition
... name ΣI0..1stringName for this plan definition (computer friendly)
... title ΣI0..1stringName for this plan definition (human friendly)
... subtitle I0..1stringSubordinate title of the plan definition
... type ΣI0..1CodeableConceptorder-set | clinical-protocol | eca-rule | workflow-definition
Binding: PlanDefinitionType (extensible)
... status ?!ΣI1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
Fixed Value: active
... experimental ΣI0..1booleanFor testing purposes, not real usage
... subject[x] I0..1Type of individual the plan definition is focused on
Binding: SubjectType (extensible)
.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date ΣI0..1dateTimeDate last changed
... publisher SΣI1..1stringRules Authoring Agency
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... rr-rules-authoring-agency-organization-extension SI1..*Reference(Rules Authoring Agency Organization)eCR Organization
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-rules-authoring-agency-organization-extension
.... value 0..1stringPrimitive value for string
Max Length: 1048576
... contact ΣI0..*ContactDetailContact details for the publisher
... description ΣI0..1markdownNatural language description of the plan definition
... useContext ΣI0..*UsageContextThe context that the content is intended to support
... jurisdiction SΣI1..1CodeableConceptIntended jurisdiction for plan definition (if applicable)
Binding: Jurisdiction ValueSet (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... extension I1..*ExtensionExtension
Slice: Unordered, Open by value:url
.... rr-location-relevance-extension SI1..1CodeableConceptLocation relevance
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-location-relevance-extension
Binding: https://phinvads.cdc.gov/vads/ViewValueSet.action?oid=2.16.840.1.113883.10.20.15.2.5.6 (extensible)
.... rr-routing-entity-organization-extension SI1..*Reference(Routing Entity Organization)eCR Organization
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-routing-entity-organization-extension
.... rr-responsible-agency-organization-extension SI0..*Reference(Responsible Agency Organization)eCR Organization
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-responsible-agency-organization-extension
.... coding ΣI0..*CodingCode defined by a terminology system
.... text ΣI0..1stringPlain text representation of the concept
... purpose I0..1markdownWhy this plan definition is defined
... usage I0..1stringDescribes the clinical usage of the plan
... copyright I0..1markdownUse and/or publishing restrictions
... approvalDate I0..1dateWhen the plan definition was approved by publisher
... lastReviewDate I0..1dateWhen the plan definition was last reviewed
... effectivePeriod ΣI0..1PeriodWhen the plan definition is expected to be used
... topic I0..*CodeableConceptE.g. Education, Treatment, Assessment
Binding: DefinitionTopic (example)
... author I0..*ContactDetailWho authored the content
... editor I0..*ContactDetailWho edited the content
... reviewer I0..*ContactDetailWho reviewed the content
... endorser I0..*ContactDetailWho endorsed the content
... relatedArtifact I0..*RelatedArtifactAdditional documentation, citations
... library I0..*canonical(Library)Logic used by the plan definition
... goal SI1..1BackboneElementGoal of the plan
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... category I0..1CodeableConceptE.g. Treatment, dietary, behavioral
Binding: GoalCategory (example)
.... description SI1..1CodeableConceptCode or text describing the goal
Binding: SNOMEDCTClinicalFindings (example)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... text ΣI1..1stringText description goal
Required Pattern: Reportability Feedback
.... priority I0..1CodeableConcepthigh-priority | medium-priority | low-priority
Binding: GoalPriority (preferred)
.... start I0..1CodeableConceptWhen goal pursuit begins
Binding: GoalStartEvent (example)
.... addresses SI1..1CodeableConceptRelevant Reportable Condition
Binding: Condition/Problem/DiagnosisCodes (example)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding SΣI0..1CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣI0..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version ΣI0..1stringVersion of the system - if relevant
...... code ΣI0..1codeSymbol in syntax defined by the system
...... display ΣI0..1stringRepresentation defined by the system
...... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
..... text SΣI0..1stringRelevant reportable condition text description
.... documentation I0..*RelatedArtifactSupporting documentation for the goal
.... target I0..*BackboneElementTarget outcome for the goal
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... measure I0..1CodeableConceptThe parameter whose value is to be tracked
Binding: LOINCCodes (example)
..... detail[x] I0..1The target value to be achieved
...... detailQuantityQuantity
...... detailRangeRange
...... detailCodeableConceptCodeableConcept
..... due I0..1DurationReach goal within
... action SI1..1BackboneElementExternal resources and related information
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... prefix I0..1stringUser-visible prefix for the action (e.g. 1. or A.)
.... title I0..1stringUser-visible title
.... description I0..1stringBrief description of the action
.... textEquivalent I0..1stringStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
.... priority I0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required)
.... code I0..*CodeableConceptCode representing the meaning of the action or sub-actions
.... reason I0..*CodeableConceptWhy the action should be performed
.... documentation SI1..*RelatedArtifactExternal Resource
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... rr-external-resource-type-extension SI1..1CodeableConceptExternal Resource Type/Category
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-external-resource-type-extension
Binding: https://phinvads.cdc.gov/vads/ViewValueSet.action?oid=2.16.840.1.113883.10.20.15.2.5.4 (extensible)
..... rr-priority-extension SI1..1CodeableConceptReportability Response Priority
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-priority-extension
Binding: https://phinvads.cdc.gov/vads/ViewValueSet.action?oid=2.16.840.1.113883.10.20.15.2.5.5 (extensible)
..... type SΣI1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required)
Fixed Value: documentation
..... label ΣI0..1stringShort label
..... display SΣI1..1stringExternal Resource Description
..... citation ΣI0..1markdownBibliographic citation for the artifact
..... url SΣI0..1urlExternal Resource Link
..... document ΣI0..1AttachmentWhat document is being referenced
..... resource ΣI0..1canonical(Resource)What resource is being referenced
.... goalId I0..*idWhat goals this action supports
.... subject[x] I0..1Type of individual the action is focused on
Binding: SubjectType (extensible)
..... subjectCodeableConceptCodeableConcept
..... subjectReferenceReference(Group)
.... trigger I0..*TriggerDefinitionWhen the action should be triggered
.... condition I0..*BackboneElementWhether or not the action is applicable
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... kind I1..1codeapplicability | start | stop
Binding: ActionConditionKind (required)
..... expression I0..1ExpressionBoolean-valued expression
.... input I0..*DataRequirementInput data requirements
.... output I0..*DataRequirementOutput data definition
.... relatedAction I0..*BackboneElementRelationship to another action
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... actionId I1..1idWhat action is this related to
..... relationship I1..1codebefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Binding: ActionRelationshipType (required)
..... offset[x] I0..1Time offset for the relationship
...... offsetDurationDuration
...... offsetRangeRange
.... timing[x] SI0..1DurationReporting timeframe
.... participant I0..*BackboneElementWho should participate in the action
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type I1..1codepatient | practitioner | related-person | device
Binding: ActionParticipantType (required)
..... role I0..1CodeableConceptE.g. Nurse, Surgeon, Parent
Binding: ActionParticipantRole (example)
.... type I0..1CodeableConceptcreate | update | remove | fire-event
Binding: ActionType (extensible)
.... groupingBehavior I0..1codevisual-group | logical-group | sentence-group
Binding: ActionGroupingBehavior (required)
.... selectionBehavior I0..1codeany | all | all-or-none | exactly-one | at-most-one | one-or-more
Binding: ActionSelectionBehavior (required)
.... requiredBehavior I0..1codemust | could | must-unless-documented
Binding: ActionRequiredBehavior (required)
.... precheckBehavior I0..1codeyes | no
Binding: ActionPrecheckBehavior (required)
.... cardinalityBehavior I0..1codesingle | multiple
Binding: ActionCardinalityBehavior (required)
.... definition[x] I0..1Description of the activity to be performed
..... definitionCanonicalcanonical(ActivityDefinition | PlanDefinition | Questionnaire)
..... definitionUriuri
.... transform I0..1canonical(StructureMap)Transform to apply the template
.... dynamicValue I0..*BackboneElementDynamic aspects of the definition
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... path I0..1stringThe path to the element to be set dynamically
..... expression I0..1ExpressionAn expression that provides the dynamic value for the customization
.... action I0..*Unknown reference to #PlanDefinition.action
A sub-action

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition S0..*PlanDefinitionRelevant Reportable Condition PlanDefinition
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... rr-determination-of-reportability-extension S1..1CodeableConceptExtension Determination of Reportability
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-determination-of-reportability-extension
... rr-determination-of-reportability-reason-extension S0..*string, CodeableConceptDetermination of Reportability Reason
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-determination-of-reportability-reason-extension
... status 1..1codeFixed Value: active
... publisher S1..1stringRules Authoring Agency
.... extension 0..*ExtensionSlice: Unordered, Open by value:url
.... rr-rules-authoring-agency-organization-extension S1..*Reference(Rules Authoring Agency Organization)eCR Organization
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-rules-authoring-agency-organization-extension
... jurisdiction S1..1CodeableConcept
.... extension 1..*ExtensionSlice: Unordered, Open by value:url
.... rr-location-relevance-extension S1..1CodeableConceptLocation relevance
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-location-relevance-extension
Binding: https://phinvads.cdc.gov/vads/ViewValueSet.action?oid=2.16.840.1.113883.10.20.15.2.5.6 (extensible)
.... rr-routing-entity-organization-extension S1..*Reference(Routing Entity Organization)eCR Organization
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-routing-entity-organization-extension
.... rr-responsible-agency-organization-extension S0..*Reference(Responsible Agency Organization)eCR Organization
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-responsible-agency-organization-extension
... goal S1..1BackboneElementGoal of the plan
.... description S1..1CodeableConcept
..... coding 0..0
..... text 1..1stringText description goal
Required Pattern: Reportability Feedback
.... addresses S1..1CodeableConceptRelevant Reportable Condition
..... coding S0..1Coding
...... system S0..1uriFixed Value: http://snomed.info/sct
..... text S0..1stringRelevant reportable condition text description
... action S1..1BackboneElementExternal resources and related information
.... documentation S1..*RelatedArtifactExternal Resource
..... extension 0..*ExtensionSlice: Unordered, Open by value:url
..... rr-external-resource-type-extension S1..1CodeableConceptExternal Resource Type/Category
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-external-resource-type-extension
Binding: https://phinvads.cdc.gov/vads/ViewValueSet.action?oid=2.16.840.1.113883.10.20.15.2.5.4 (extensible)
..... rr-priority-extension S1..1CodeableConceptReportability Response Priority
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-priority-extension
Binding: https://phinvads.cdc.gov/vads/ViewValueSet.action?oid=2.16.840.1.113883.10.20.15.2.5.5 (extensible)
..... type S1..1codeFixed Value: documentation
..... display S1..1stringExternal Resource Description
..... url S0..1urlExternal Resource Link
.... timing[x] S0..1DurationReporting timeframe

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition SI0..*PlanDefinitionRelevant Reportable Condition PlanDefinition
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... rr-determination-of-reportability-extension SI1..1CodeableConceptExtension Determination of Reportability
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-determination-of-reportability-extension
... rr-determination-of-reportability-reason-extension SI0..*string, CodeableConceptDetermination of Reportability Reason
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-determination-of-reportability-reason-extension
... rr-determination-of-reportability-rule-extension SI0..*stringDetermination of Reportability Rule
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-determination-of-reportability-rule-extension
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... url ΣI0..1uriCanonical identifier for this plan definition, represented as a URI (globally unique)
... identifier ΣI0..*IdentifierAdditional identifier for the plan definition
... version ΣI0..1stringBusiness version of the plan definition
... name ΣI0..1stringName for this plan definition (computer friendly)
... title ΣI0..1stringName for this plan definition (human friendly)
... subtitle I0..1stringSubordinate title of the plan definition
... type ΣI0..1CodeableConceptorder-set | clinical-protocol | eca-rule | workflow-definition
Binding: PlanDefinitionType (extensible)
... status ?!ΣI1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
Fixed Value: active
... experimental ΣI0..1booleanFor testing purposes, not real usage
... subject[x] I0..1Type of individual the plan definition is focused on
Binding: SubjectType (extensible)
.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date ΣI0..1dateTimeDate last changed
... publisher SΣI1..1stringRules Authoring Agency
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... rr-rules-authoring-agency-organization-extension SI1..*Reference(Rules Authoring Agency Organization)eCR Organization
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-rules-authoring-agency-organization-extension
.... value 0..1stringPrimitive value for string
Max Length: 1048576
... contact ΣI0..*ContactDetailContact details for the publisher
... description ΣI0..1markdownNatural language description of the plan definition
... useContext ΣI0..*UsageContextThe context that the content is intended to support
... jurisdiction SΣI1..1CodeableConceptIntended jurisdiction for plan definition (if applicable)
Binding: Jurisdiction ValueSet (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... extension I1..*ExtensionExtension
Slice: Unordered, Open by value:url
.... rr-location-relevance-extension SI1..1CodeableConceptLocation relevance
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-location-relevance-extension
Binding: https://phinvads.cdc.gov/vads/ViewValueSet.action?oid=2.16.840.1.113883.10.20.15.2.5.6 (extensible)
.... rr-routing-entity-organization-extension SI1..*Reference(Routing Entity Organization)eCR Organization
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-routing-entity-organization-extension
.... rr-responsible-agency-organization-extension SI0..*Reference(Responsible Agency Organization)eCR Organization
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-responsible-agency-organization-extension
.... coding ΣI0..*CodingCode defined by a terminology system
.... text ΣI0..1stringPlain text representation of the concept
... purpose I0..1markdownWhy this plan definition is defined
... usage I0..1stringDescribes the clinical usage of the plan
... copyright I0..1markdownUse and/or publishing restrictions
... approvalDate I0..1dateWhen the plan definition was approved by publisher
... lastReviewDate I0..1dateWhen the plan definition was last reviewed
... effectivePeriod ΣI0..1PeriodWhen the plan definition is expected to be used
... topic I0..*CodeableConceptE.g. Education, Treatment, Assessment
Binding: DefinitionTopic (example)
... author I0..*ContactDetailWho authored the content
... editor I0..*ContactDetailWho edited the content
... reviewer I0..*ContactDetailWho reviewed the content
... endorser I0..*ContactDetailWho endorsed the content
... relatedArtifact I0..*RelatedArtifactAdditional documentation, citations
... library I0..*canonical(Library)Logic used by the plan definition
... goal SI1..1BackboneElementGoal of the plan
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... category I0..1CodeableConceptE.g. Treatment, dietary, behavioral
Binding: GoalCategory (example)
.... description SI1..1CodeableConceptCode or text describing the goal
Binding: SNOMEDCTClinicalFindings (example)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... text ΣI1..1stringText description goal
Required Pattern: Reportability Feedback
.... priority I0..1CodeableConcepthigh-priority | medium-priority | low-priority
Binding: GoalPriority (preferred)
.... start I0..1CodeableConceptWhen goal pursuit begins
Binding: GoalStartEvent (example)
.... addresses SI1..1CodeableConceptRelevant Reportable Condition
Binding: Condition/Problem/DiagnosisCodes (example)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding SΣI0..1CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣI0..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version ΣI0..1stringVersion of the system - if relevant
...... code ΣI0..1codeSymbol in syntax defined by the system
...... display ΣI0..1stringRepresentation defined by the system
...... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
..... text SΣI0..1stringRelevant reportable condition text description
.... documentation I0..*RelatedArtifactSupporting documentation for the goal
.... target I0..*BackboneElementTarget outcome for the goal
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... measure I0..1CodeableConceptThe parameter whose value is to be tracked
Binding: LOINCCodes (example)
..... detail[x] I0..1The target value to be achieved
...... detailQuantityQuantity
...... detailRangeRange
...... detailCodeableConceptCodeableConcept
..... due I0..1DurationReach goal within
... action SI1..1BackboneElementExternal resources and related information
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... prefix I0..1stringUser-visible prefix for the action (e.g. 1. or A.)
.... title I0..1stringUser-visible title
.... description I0..1stringBrief description of the action
.... textEquivalent I0..1stringStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
.... priority I0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required)
.... code I0..*CodeableConceptCode representing the meaning of the action or sub-actions
.... reason I0..*CodeableConceptWhy the action should be performed
.... documentation SI1..*RelatedArtifactExternal Resource
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... rr-external-resource-type-extension SI1..1CodeableConceptExternal Resource Type/Category
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-external-resource-type-extension
Binding: https://phinvads.cdc.gov/vads/ViewValueSet.action?oid=2.16.840.1.113883.10.20.15.2.5.4 (extensible)
..... rr-priority-extension SI1..1CodeableConceptReportability Response Priority
URL: http://hl7.org/fhir/us/ecr/StructureDefinition/rr-priority-extension
Binding: https://phinvads.cdc.gov/vads/ViewValueSet.action?oid=2.16.840.1.113883.10.20.15.2.5.5 (extensible)
..... type SΣI1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required)
Fixed Value: documentation
..... label ΣI0..1stringShort label
..... display SΣI1..1stringExternal Resource Description
..... citation ΣI0..1markdownBibliographic citation for the artifact
..... url SΣI0..1urlExternal Resource Link
..... document ΣI0..1AttachmentWhat document is being referenced
..... resource ΣI0..1canonical(Resource)What resource is being referenced
.... goalId I0..*idWhat goals this action supports
.... subject[x] I0..1Type of individual the action is focused on
Binding: SubjectType (extensible)
..... subjectCodeableConceptCodeableConcept
..... subjectReferenceReference(Group)
.... trigger I0..*TriggerDefinitionWhen the action should be triggered
.... condition I0..*BackboneElementWhether or not the action is applicable
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... kind I1..1codeapplicability | start | stop
Binding: ActionConditionKind (required)
..... expression I0..1ExpressionBoolean-valued expression
.... input I0..*DataRequirementInput data requirements
.... output I0..*DataRequirementOutput data definition
.... relatedAction I0..*BackboneElementRelationship to another action
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... actionId I1..1idWhat action is this related to
..... relationship I1..1codebefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Binding: ActionRelationshipType (required)
..... offset[x] I0..1Time offset for the relationship
...... offsetDurationDuration
...... offsetRangeRange
.... timing[x] SI0..1DurationReporting timeframe
.... participant I0..*BackboneElementWho should participate in the action
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type I1..1codepatient | practitioner | related-person | device
Binding: ActionParticipantType (required)
..... role I0..1CodeableConceptE.g. Nurse, Surgeon, Parent
Binding: ActionParticipantRole (example)
.... type I0..1CodeableConceptcreate | update | remove | fire-event
Binding: ActionType (extensible)
.... groupingBehavior I0..1codevisual-group | logical-group | sentence-group
Binding: ActionGroupingBehavior (required)
.... selectionBehavior I0..1codeany | all | all-or-none | exactly-one | at-most-one | one-or-more
Binding: ActionSelectionBehavior (required)
.... requiredBehavior I0..1codemust | could | must-unless-documented
Binding: ActionRequiredBehavior (required)
.... precheckBehavior I0..1codeyes | no
Binding: ActionPrecheckBehavior (required)
.... cardinalityBehavior I0..1codesingle | multiple
Binding: ActionCardinalityBehavior (required)
.... definition[x] I0..1Description of the activity to be performed
..... definitionCanonicalcanonical(ActivityDefinition | PlanDefinition | Questionnaire)
..... definitionUriuri
.... transform I0..1canonical(StructureMap)Transform to apply the template
.... dynamicValue I0..*BackboneElementDynamic aspects of the definition
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... path I0..1stringThe path to the element to be set dynamically
..... expression I0..1ExpressionAn expression that provides the dynamic value for the customization
.... action I0..*Unknown reference to #PlanDefinition.action
A sub-action

doco Documentation for this format

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