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

Resource Profile: OpenMRS Location

Defining URL:http://fhir.openmrs.org/fhir/StructureDefinition/omrs-location
Version:0.1.0
Name:OMRSLocation
Title:OpenMRS Location
Status:Active as of 2022-11-29 05:06:49+0000
Definition:

An OpenMRS location

Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

http://fhir.openmrs.org/fhir/StructureDefinition/omrs-location

Formal Views of Profile Content

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

This structure is derived from Location

This structure is derived from Location

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*LocationDetails and position information for a physical place
... id 0..1idLogical id of this artifact
... meta
.... tag 0..*CodingTags applied to this resource
... status 0..1codeactive | suspended | inactive
Binding: Location Status ValueSet (required)
... name 1..1stringName of the location as used by humans
... alias 0..0
... description 1..1stringAdditional details about the location that could be displayed as further information to identify the location beyond its name
... mode 0..0
... telecom 0..*OMRSLocationContactPointDetails of a Technology mediated contact point (phone, fax, email, etc.)
... address 0..1OMRSAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
.... line 0..*stringStreet name, number, direction & P.O. Box etc.
.... city 0..1stringName of city, town etc.
.... district 0..1stringDistrict name (aka county)
.... state 0..1stringSub-unit of country (abbreviations ok)
.... postalCode 0..1stringPostal code for area
.... country 0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
... physicalType 0..0
... position
.... longitude 1..1decimalLongitude with WGS84 datum
.... latitude 1..1decimalLatitude with WGS84 datum
... managingOrganization 0..0
... partOf 0..1Reference(Location)Another Location this one is physically a part of
... hoursOfOperation 0..0
... availabilityExceptions 0..0
... endpoint 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*LocationDetails and position information for a physical place
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique code or number identifying the location to its users
... status ?!Σ0..1codeactive | suspended | inactive
Binding: Location Status ValueSet (required)
... name Σ1..1stringName of the location as used by humans
... description Σ1..1stringAdditional details about the location that could be displayed as further information to identify the location beyond its name
... type Σ0..*CodeableConceptType of function performed
Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.


... telecom C0..*OMRSLocationContactPointDetails of a Technology mediated contact point (phone, fax, email, etc.)
... address 0..1OMRSAddressAn 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
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... 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"}
... position 0..1BackboneElementThe absolute geographic location
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... longitude 1..1decimalLongitude with WGS84 datum
.... latitude 1..1decimalLatitude with WGS84 datum
.... altitude 0..1decimalAltitude with WGS84 datum
... partOf 0..1Reference(Location)Another Location this one is physically a part of

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*LocationDetails and position information for a physical place

doco Documentation for this format

This structure is derived from Location

Differential View

This structure is derived from Location

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*LocationDetails and position information for a physical place
... id 0..1idLogical id of this artifact
... meta
.... tag 0..*CodingTags applied to this resource
... status 0..1codeactive | suspended | inactive
Binding: Location Status ValueSet (required)
... name 1..1stringName of the location as used by humans
... alias 0..0
... description 1..1stringAdditional details about the location that could be displayed as further information to identify the location beyond its name
... mode 0..0
... telecom 0..*OMRSLocationContactPointDetails of a Technology mediated contact point (phone, fax, email, etc.)
... address 0..1OMRSAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
.... line 0..*stringStreet name, number, direction & P.O. Box etc.
.... city 0..1stringName of city, town etc.
.... district 0..1stringDistrict name (aka county)
.... state 0..1stringSub-unit of country (abbreviations ok)
.... postalCode 0..1stringPostal code for area
.... country 0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
... physicalType 0..0
... position
.... longitude 1..1decimalLongitude with WGS84 datum
.... latitude 1..1decimalLatitude with WGS84 datum
... managingOrganization 0..0
... partOf 0..1Reference(Location)Another Location this one is physically a part of
... hoursOfOperation 0..0
... availabilityExceptions 0..0
... endpoint 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*LocationDetails and position information for a physical place
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique code or number identifying the location to its users
... status ?!Σ0..1codeactive | suspended | inactive
Binding: Location Status ValueSet (required)
... name Σ1..1stringName of the location as used by humans
... description Σ1..1stringAdditional details about the location that could be displayed as further information to identify the location beyond its name
... type Σ0..*CodeableConceptType of function performed
Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.


... telecom C0..*OMRSLocationContactPointDetails of a Technology mediated contact point (phone, fax, email, etc.)
... address 0..1OMRSAddressAn 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
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... 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"}
... position 0..1BackboneElementThe absolute geographic location
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... longitude 1..1decimalLongitude with WGS84 datum
.... latitude 1..1decimalLatitude with WGS84 datum
.... altitude 0..1decimalAltitude with WGS84 datum
... partOf 0..1Reference(Location)Another Location this one is physically a part of

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Location.meta.securityextensibleAll Security Labels
Location.meta.tagexampleCommonTags
Location.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Location.statusrequiredLocationStatusVS
Location.typeextensibleServiceDeliveryLocationRoleType
Location.address.userequiredAddressUse
Location.address.typerequiredAddressType
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorLocation.telecomA system is required if a value is provided.
: value.empty() or system.exists()
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()