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

HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 2.1.2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/case-reporting/ and changes regularly. See the Directory of published versions

Extension: US Public Health Address Extension

Official URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-address-extension Version: 2.1.2
Active as of 2024-10-30 Computable Name: USPublicHealthAddressExtension
Other Identifiers: OID:2.16.840.1.113883.4.642.40.46.42.30

This Extension profile represents where the patient traveled to or visited as an address e.g.: country, state, city, street address (if applicable).

At the least, address must contain the country. State is required if the country is US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies.

Context of Use

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

  • Element ID Observation.component
  • Element ID Observation

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 Address: This Extension profile represents where the patient traveled to or visited as an address e.g.: country, state, city, street address (if applicable).

At the least, address must contain the country. State is required if the country is US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies.

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSetURI
Extension.value[x].userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Extension.value[x].typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Extension.value[x].statepreferredUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state

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()