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
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
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Location
This structure is derived from Location
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Location | Details and position information for a physical place | |
![]() ![]() ![]() | 0..1 | id | Logical id of this artifact | |
![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() | 0..* | Coding | Tags applied to this resource | |
![]() ![]() ![]() | 0..1 | code | active | suspended | inactive Binding: Location Status ValueSet (required) | |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 1..1 | string | Name of the location as used by humans | |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 1..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name | |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..* | OMRSLocationContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) | |
![]() ![]() ![]() | 0..1 | OMRSAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
![]() ![]() ![]() ![]() | 0..* | string | Street name, number, direction & P.O. Box etc. | |
![]() ![]() ![]() ![]() | 0..1 | string | Name of city, town etc. | |
![]() ![]() ![]() ![]() | 0..1 | string | District name (aka county) | |
![]() ![]() ![]() ![]() | 0..1 | string | Sub-unit of country (abbreviations ok) | |
![]() ![]() ![]() ![]() | 0..1 | string | Postal code for area | |
![]() ![]() ![]() ![]() | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() | 1..1 | decimal | Longitude with WGS84 datum | |
![]() ![]() ![]() ![]() | 1..1 | decimal | Latitude with WGS84 datum | |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..1 | Reference(Location) | Another Location this one is physically a part of | |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..0 | |||
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() | 0..* | Location | Details and position information for a physical place | |||||
![]() ![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() ![]() | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() ![]() | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() ![]() | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() | Σ | 0..* | Identifier | Unique code or number identifying the location to its users | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | code | active | suspended | inactive Binding: Location Status ValueSet (required) | ||||
![]() ![]() ![]() | Σ | 1..1 | string | Name of the location as used by humans | ||||
![]() ![]() ![]() | Σ | 1..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name | ||||
![]() ![]() ![]() | Σ | 0..* | CodeableConcept | Type of function performed Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location. | ||||
![]() ![]() ![]() | C | 0..* | OMRSLocationContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) | ||||
![]() ![]() ![]() | 0..1 | OMRSAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
![]() ![]() ![]() ![]() | Σ | 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 | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Postal code for area Example General: 9132 | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
![]() ![]() ![]() | 0..1 | BackboneElement | The absolute geographic location | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | 1..1 | decimal | Longitude with WGS84 datum | |||||
![]() ![]() ![]() ![]() | 1..1 | decimal | Latitude with WGS84 datum | |||||
![]() ![]() ![]() ![]() | 0..1 | decimal | Altitude with WGS84 datum | |||||
![]() ![]() ![]() | 0..1 | Reference(Location) | Another Location this one is physically a part of | |||||
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Location | Details and position information for a physical place | |
![]() |
This structure is derived from Location
Differential View
This structure is derived from Location
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Location | Details and position information for a physical place | |
![]() ![]() ![]() | 0..1 | id | Logical id of this artifact | |
![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() | 0..* | Coding | Tags applied to this resource | |
![]() ![]() ![]() | 0..1 | code | active | suspended | inactive Binding: Location Status ValueSet (required) | |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 1..1 | string | Name of the location as used by humans | |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 1..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name | |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..* | OMRSLocationContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) | |
![]() ![]() ![]() | 0..1 | OMRSAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
![]() ![]() ![]() ![]() | 0..* | string | Street name, number, direction & P.O. Box etc. | |
![]() ![]() ![]() ![]() | 0..1 | string | Name of city, town etc. | |
![]() ![]() ![]() ![]() | 0..1 | string | District name (aka county) | |
![]() ![]() ![]() ![]() | 0..1 | string | Sub-unit of country (abbreviations ok) | |
![]() ![]() ![]() ![]() | 0..1 | string | Postal code for area | |
![]() ![]() ![]() ![]() | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() | 1..1 | decimal | Longitude with WGS84 datum | |
![]() ![]() ![]() ![]() | 1..1 | decimal | Latitude with WGS84 datum | |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..1 | Reference(Location) | Another Location this one is physically a part of | |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..0 | |||
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() | 0..* | Location | Details and position information for a physical place | |||||
![]() ![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() ![]() | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() ![]() | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() ![]() | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() | Σ | 0..* | Identifier | Unique code or number identifying the location to its users | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | code | active | suspended | inactive Binding: Location Status ValueSet (required) | ||||
![]() ![]() ![]() | Σ | 1..1 | string | Name of the location as used by humans | ||||
![]() ![]() ![]() | Σ | 1..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name | ||||
![]() ![]() ![]() | Σ | 0..* | CodeableConcept | Type of function performed Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location. | ||||
![]() ![]() ![]() | C | 0..* | OMRSLocationContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) | ||||
![]() ![]() ![]() | 0..1 | OMRSAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
![]() ![]() ![]() ![]() | Σ | 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 | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Postal code for area Example General: 9132 | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
![]() ![]() ![]() | 0..1 | BackboneElement | The absolute geographic location | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | 1..1 | decimal | Longitude with WGS84 datum | |||||
![]() ![]() ![]() ![]() | 1..1 | decimal | Latitude with WGS84 datum | |||||
![]() ![]() ![]() ![]() | 0..1 | decimal | Altitude with WGS84 datum | |||||
![]() ![]() ![]() | 0..1 | Reference(Location) | Another Location this one is physically a part of | |||||
![]() |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet | ||||
Location.meta.security | extensible | All Security Labels | ||||
Location.meta.tag | example | CommonTags | ||||
Location.language | preferred | CommonLanguages
| ||||
Location.status | required | LocationStatusVS | ||||
Location.type | extensible | ServiceDeliveryLocationRoleType | ||||
Location.address.use | required | AddressUse | ||||
Location.address.type | required | AddressType | ||||
Location.hoursOfOperation.daysOfWeek | required | DaysOfWeek |
Id | Grade | Path(s) | Details | Requirements |
cpt-2 | error | Location.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |