HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm
2.1.1 - STU 2.1.1 United States of America flag

This page is part of the electronic Case Reporting (eCR) (v2.1.1: STU 2) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in it's permanent location. For a full list of available versions, see the Directory of published versions

Extension: US Public Health Initiation Reason Extension

Official URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-initiation-reason-extension Version: 2.1.1
Active as of 2023-12-14 Computable Name: USPublicHealthInitiationReasonExtension

This extension contains an explanation for the manual or alternate initiation of the public health report.

If there are multiple distinct reasons for manual or alternate initiation then each reason should be contained in a separate US Public Health Initiation Reason Extension.

The reason may be entered either as:

  • free text (string)
  • coded value (valueCodeableConcept) (not necessarily initiated by a provider of care but might be “programmed-in” by the EHR implementer for some purpose)

Context of Use

This extension may be used on the following element(s):

  • Element ID Composition

Usage info

Usage:

Formal Views of Extension Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Extension

Summary

Simple Extension of type string, CodeableConcept: This extension contains an explanation for the manual or alternate initiation of the public health report.

If there are multiple distinct reasons for manual or alternate initiation then each reason should be contained in a separate US Public Health Initiation Reason Extension.

The reason may be entered either as:

  • free text (string)
  • coded value (valueCodeableConcept) (not necessarily initiated by a provider of care but might be "programmed-in" by the EHR implementer for some purpose)

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionInitial Case Report Initiation Reason
... url 1..1uri"http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-initiation-reason-extension"
... value[x] S1..1Value of extension
Example valueString: Free text containing the reason for the initiation
Example valueCodeableConcept: {"coding":[{"system":"http://snomed.info/sct","code":"772146005","display":"Pertussis suspected (situation)"}]}
.... valueStringstring
.... valueCodeableConceptCodeableConcept

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionInitial Case Report Initiation Reason
... id 0..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... url 1..1uri"http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-initiation-reason-extension"
.... valueStringstring
.... valueCodeableConceptCodeableConcept

doco Documentation for this format

This structure is derived from Extension

Summary

Simple Extension of type string, CodeableConcept: This extension contains an explanation for the manual or alternate initiation of the public health report.

If there are multiple distinct reasons for manual or alternate initiation then each reason should be contained in a separate US Public Health Initiation Reason Extension.

The reason may be entered either as:

  • free text (string)
  • coded value (valueCodeableConcept) (not necessarily initiated by a provider of care but might be "programmed-in" by the EHR implementer for some purpose)

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionInitial Case Report Initiation Reason
... url 1..1uri"http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-initiation-reason-extension"
... value[x] S1..1Value of extension
Example valueString: Free text containing the reason for the initiation
Example valueCodeableConcept: {"coding":[{"system":"http://snomed.info/sct","code":"772146005","display":"Pertussis suspected (situation)"}]}
.... valueStringstring
.... valueCodeableConceptCodeableConcept

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionInitial Case Report Initiation Reason
... id 0..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... url 1..1uri"http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-initiation-reason-extension"
.... valueStringstring
.... valueCodeableConceptCodeableConcept

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()