HL7.FHIR.US.ECR\Travel History Address Extension

This page is part of the electronic Case Reporting (eCR) (v1.1.0: STU 2 on FHIR R4 Ballot 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

Extension: Travel History Address Extension

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

The official URL for this extension is:

http://hl7.org/fhir/us/ecr/StructureDefinition/address-extension

Status: active
Extension maintained by: HL7 Public Health Work Group (http://www.hl7.org/Special/committees/pher/index.cfm)

Context of Use

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

Observation.component
Observation

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.

Usage info

Usage:

Use this Extension: Travel History Observation, US Public Health Exposure Contact Information

Formal Views of Extension Content

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

Text Summary
Differential Table
Snapshot Table
All

This structure is derived from Extension

Summary

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

This structure is derived from Extension

Name	Flags	Card.	Type	Description & Constraints
Extension		0..1	Extension	Address
url		1..1	uri	"http://hl7.org/fhir/us/ecr/StructureDefinition/address-extension"
value[x]	S	0..1	Address	Value of extension Example for Address: {"text":"Nadi FIJI","city":"Nadi","country":"FIJI"}
use	S	0..1	code	home \| work \| temp \| old \| billing - purpose of this address
type	S	0..1	code	postal \| physical \| both
line	S	0..*	string	Street name, number, direction & P.O. Box etc.
city	S	0..1	string	Name of city, town etc.
district	S	0..1	string	District name (aka county)
state	S	0..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (preferred): United States Postal Service Two-Letter State and Possession Abbreviations
postalCode	S	0..1	string	Postal code for area
country	S	1..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Extension		0..1	Extension	Address
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org/fhir/us/ecr/StructureDefinition/address-extension"
value[x]	S	0..1	Address	Value of extension Example for Address: {"text":"Nadi FIJI","city":"Nadi","country":"FIJI"}
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!SΣ	0..1	code	home \| work \| temp \| old \| billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	SΣ	0..1	code	postal \| physical \| both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	SΣ	0..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	SΣ	0..1	string	Name of city, town etc. Example General: Erewhon
district	SΣ	0..1	string	District name (aka county) Example General: Madison
state	SΣ	0..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (preferred): United States Postal Service Two-Letter State and Possession Abbreviations
postalCode	SΣ	0..1	string	Postal code for area Example General: 9132
country	SΣ	1..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
Documentation for this format

This structure is derived from Extension

Summary

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

Differential View

This structure is derived from Extension

Name	Flags	Card.	Type	Description & Constraints
Extension		0..1	Extension	Address
url		1..1	uri	"http://hl7.org/fhir/us/ecr/StructureDefinition/address-extension"
value[x]	S	0..1	Address	Value of extension Example for Address: {"text":"Nadi FIJI","city":"Nadi","country":"FIJI"}
use	S	0..1	code	home \| work \| temp \| old \| billing - purpose of this address
type	S	0..1	code	postal \| physical \| both
line	S	0..*	string	Street name, number, direction & P.O. Box etc.
city	S	0..1	string	Name of city, town etc.
district	S	0..1	string	District name (aka county)
state	S	0..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (preferred): United States Postal Service Two-Letter State and Possession Abbreviations
postalCode	S	0..1	string	Postal code for area
country	S	1..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Extension		0..1	Extension	Address
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org/fhir/us/ecr/StructureDefinition/address-extension"
value[x]	S	0..1	Address	Value of extension Example for Address: {"text":"Nadi FIJI","city":"Nadi","country":"FIJI"}
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!SΣ	0..1	code	home \| work \| temp \| old \| billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	SΣ	0..1	code	postal \| physical \| both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	SΣ	0..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	SΣ	0..1	string	Name of city, town etc. Example General: Erewhon
district	SΣ	0..1	string	District name (aka county) Example General: Madison
state	SΣ	0..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (preferred): United States Postal Service Two-Letter State and Possession Abbreviations
postalCode	SΣ	0..1	string	Postal code for area Example General: 9132
country	SΣ	1..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
Documentation for this format

Other representations of extension: Schematron

Terminology Bindings

Path	Conformance	ValueSet
Extension.value[x].use	required	AddressUse
Extension.value[x].type	required	AddressType
Extension.value[x].state	preferred	UspsTwoLetterAlphabeticCodes

Constraints

Id	Path	Details	Requirements
ele-1	Extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Extension.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Extension.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Extension.value[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Extension.value[x].extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Extension.value[x].extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Extension.value[x].use	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Extension.value[x].type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Extension.value[x].text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Extension.value[x].line	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Extension.value[x].city	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Extension.value[x].district	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Extension.value[x].state	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Extension.value[x].postalCode	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Extension.value[x].country	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Extension.value[x].period	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())