OpenMRS FHIR2 Implementation Guide
0.1.0 - ci-build

OpenMRS FHIR2 Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions

Data Type Profile: OMRS Address

Official URL: http://fhir.openmrs.org/fhir/StructureDefinition/omrs-address Version: 0.1.0
Active as of 2022-09-20 Computable Name: OMRSAddress

Address profile specifies the geological location details

Usage:

Formal Views of Profile Content

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

This structure is derived from Address

Summary

This structure is derived from Address

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..*AddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..*AddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... id 0..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
... line Σ0..*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 Σ0..1stringName of city, town etc.
Example General: Erewhon
... district Σ0..1stringDistrict name (aka county)
Example General: Madison
... state Σ0..1stringSub-unit of country (abbreviations ok)
... postalCode Σ0..1stringPostal code for area
Example General: 9132
... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..*AddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)

doco Documentation for this format

This structure is derived from Address

Summary

Differential View

This structure is derived from Address

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..*AddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..*AddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... id 0..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
... line Σ0..*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 Σ0..1stringName of city, town etc.
Example General: Erewhon
... district Σ0..1stringDistrict name (aka county)
Example General: Madison
... state Σ0..1stringSub-unit of country (abbreviations ok)
... postalCode Σ0..1stringPostal code for area
Example General: 9132
... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Address.userequiredAddressUse
Address.typerequiredAddressType

Constraints

IdGradePathDetailsRequirements
ele-1errorAddressAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorAddress.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorAddress.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorAddress.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorAddress.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorAddress.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorAddress.lineAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorAddress.cityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorAddress.districtAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorAddress.stateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorAddress.postalCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorAddress.countryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorAddress.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())