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.31 StructureDefinition-travel-history-address-extension

This Extension profile represents where the patient traveled to 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.

SD.31.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/travel-history-address-extension

Published on Wed Jan 29 20:30:08 UTC 2020 as a active by HL7 Public Health Work Group.

This profile builds on Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1ExtensionTravel history address
... url 1..1uri"http://hl7.org/fhir/us/ecr/StructureDefinition/travel-history-address-extension"
... value[x] S0..1AddressExample for Address: {"text":"Nadi FIJI","city":"Nadi","country":"FIJI"}
.... use S0..1code
.... type S0..1code
.... line S0..*string
.... city S0..1string
.... district S0..1string
.... state S0..1stringBinding: USPS Two Letter Alphabetic Codes (preferred)
.... postalCode S0..1string
.... country S1..1string

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension I0..1ExtensionTravel history address
... id 0..1stringUnique id for inter-element referencing
... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... url 1..1uri"http://hl7.org/fhir/us/ecr/StructureDefinition/travel-history-address-extension"
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!SΣI0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
Example General: home
.... type SΣI0..1codepostal | physical | both
Binding: AddressType (required)
Example General: both
.... text ΣI0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣI0..*stringStreet 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ΣI0..1stringName of city, town etc.
Example General: Erewhon
.... district SΣI0..1stringDistrict name (aka county)
Example General: Madison
.... state SΣI0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (preferred)
.... postalCode SΣI0..1stringPostal code for area
Example General: 9132
.... country SΣI1..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period ΣI0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23T00:00:00+00:00","end":"2010-07-01T00:00:00+00:00"}

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1ExtensionTravel history address
... url 1..1uri"http://hl7.org/fhir/us/ecr/StructureDefinition/travel-history-address-extension"
... value[x] S0..1AddressExample for Address: {"text":"Nadi FIJI","city":"Nadi","country":"FIJI"}
.... use S0..1code
.... type S0..1code
.... line S0..*string
.... city S0..1string
.... district S0..1string
.... state S0..1stringBinding: USPS Two Letter Alphabetic Codes (preferred)
.... postalCode S0..1string
.... country S1..1string

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension I0..1ExtensionTravel history address
... id 0..1stringUnique id for inter-element referencing
... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... url 1..1uri"http://hl7.org/fhir/us/ecr/StructureDefinition/travel-history-address-extension"
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!SΣI0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
Example General: home
.... type SΣI0..1codepostal | physical | both
Binding: AddressType (required)
Example General: both
.... text ΣI0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣI0..*stringStreet 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ΣI0..1stringName of city, town etc.
Example General: Erewhon
.... district SΣI0..1stringDistrict name (aka county)
Example General: Madison
.... state SΣI0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (preferred)
.... postalCode SΣI0..1stringPostal code for area
Example General: 9132
.... country SΣI1..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period ΣI0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23T00:00:00+00:00","end":"2010-07-01T00:00:00+00:00"}

doco Documentation for this format

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

 

See the Conformance requirements for a complete list of supported RESTful interactions for this IG.