DHIS2 Example FHIR Implementation Guide
1.0.0 - ci-build
DHIS2 Example FHIR Implementation Guide, published by DHIS2. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/JohanGHole/alldevs-demo-ig and changes regularly. See the Directory of published versions
Official URL: https://dhis2.org/StructureDefinition/MDOrganisationUnitLocation | Version: 1.0.0 | |||
Draft as of 2023-09-28 | Computable Name: MDOrganisationUnitLocation |
MDOrganisationUnit Location
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Location
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Location | 0..* | Location | Details and position information for a physical place | |
Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |
shortName | S | 1..1 | string | ShortName URL: https://dhis2.org/StructureDefinition/ShortName |
level | S | 1..1 | integer | MDOrganisationUnit Hiearchy Level URL: https://dhis2.org/StructureDefinition/Level |
organisationUnitGroup | S | 0..* | Identifier | MDOrganisationUnitGroup Identifier URL: https://dhis2.org/StructureDefinition/OrganisationUnitGroup |
attributeValue | S | 0..* | (Complex) | MDAttributeValue URL: https://dhis2.org/StructureDefinition/AttributeValue |
geometry | S | 0..1 | Attachment | A boundary shape that represents the outside edge of the location (in GeoJSON format) URL: http://hl7.org/fhir/StructureDefinition/location-boundary-geojson |
Slices for identifier | S | 1..* | Identifier | Unique code or number identifying the location to its users Slice: Unordered, Open by pattern:type |
identifier:id | S | 1..1 | Identifier | Unique code or number identifying the location to its users |
type | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://dhis2.org/identifiertypes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: id | |
value | S | 1..1 | string | The value that is unique |
identifier:code | S | 0..1 | Identifier | Unique code or number identifying the location to its users |
type | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://dhis2.org/identifiertypes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: code | |
value | S | 1..1 | string | The value that is unique |
identifier:href | S | 0..1 | Identifier | Unique code or number identifying the location to its users |
type | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://dhis2.org/identifiertypes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: href | |
value | S | 1..1 | string | The value that is unique |
name | S | 1..1 | string | Name of the location as used by humans |
description | S | 0..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name |
managingOrganization | 1..1 | Reference(MDOrganisationUnit Organization) | Organization responsible for provisioning and upkeep | |
partOf | S | 0..1 | Reference(Location) | Another Location this one is physically a part of |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Location | 0..* | Location | Details and position information for a physical place | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |
shortName | S | 1..1 | string | ShortName URL: https://dhis2.org/StructureDefinition/ShortName |
level | S | 1..1 | integer | MDOrganisationUnit Hiearchy Level URL: https://dhis2.org/StructureDefinition/Level |
organisationUnitGroup | S | 0..* | Identifier | MDOrganisationUnitGroup Identifier URL: https://dhis2.org/StructureDefinition/OrganisationUnitGroup |
attributeValue | S | 0..* | (Complex) | MDAttributeValue URL: https://dhis2.org/StructureDefinition/AttributeValue |
geometry | S | 0..1 | Attachment | A boundary shape that represents the outside edge of the location (in GeoJSON format) URL: http://hl7.org/fhir/StructureDefinition/location-boundary-geojson |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | SΣ | 1..* | Identifier | Unique code or number identifying the location to its users Slice: Unordered, Open by pattern:type |
identifier:id | SΣ | 1..1 | Identifier | Unique code or number identifying the location to its users |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://dhis2.org/identifiertypes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: id | |
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
identifier:code | SΣ | 0..1 | Identifier | Unique code or number identifying the location to its users |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://dhis2.org/identifiertypes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: code | |
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
identifier:href | SΣ | 0..1 | Identifier | Unique code or number identifying the location to its users |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://dhis2.org/identifiertypes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: href | |
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
status | ?!Σ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. |
name | SΣ | 1..1 | string | Name of the location as used by humans |
description | SΣ | 0..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name |
managingOrganization | Σ | 1..1 | Reference(MDOrganisationUnit Organization) | Organization responsible for provisioning and upkeep |
partOf | S | 0..1 | Reference(Location) | Another Location this one is physically a part of |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Location.identifier:id.use | required | IdentifierUse |
Location.identifier:id.type | extensible | Pattern: id |
Location.identifier:code.use | required | IdentifierUse |
Location.identifier:code.type | extensible | Pattern: code |
Location.identifier:href.use | required | IdentifierUse |
Location.identifier:href.type | extensible | Pattern: href |
Location.status | required | LocationStatus |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Location | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Location | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Location | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Location | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Location | A resource should have narrative for robust management : text.`div`.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() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Location | 0..* | Location | Details and position information for a physical place | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
shortName | S | 1..1 | string | ShortName URL: https://dhis2.org/StructureDefinition/ShortName | ||||
level | S | 1..1 | integer | MDOrganisationUnit Hiearchy Level URL: https://dhis2.org/StructureDefinition/Level | ||||
organisationUnitGroup | S | 0..* | Identifier | MDOrganisationUnitGroup Identifier URL: https://dhis2.org/StructureDefinition/OrganisationUnitGroup | ||||
attributeValue | S | 0..* | (Complex) | MDAttributeValue URL: https://dhis2.org/StructureDefinition/AttributeValue | ||||
geometry | S | 0..1 | Attachment | A boundary shape that represents the outside edge of the location (in GeoJSON format) URL: http://hl7.org/fhir/StructureDefinition/location-boundary-geojson | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | SΣ | 1..* | Identifier | Unique code or number identifying the location to its users Slice: Unordered, Open by pattern:type | ||||
identifier:id | SΣ | 1..1 | Identifier | Unique code or number identifying the location to its users | ||||
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 | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://dhis2.org/identifiertypes | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: id | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
identifier:code | SΣ | 0..1 | Identifier | Unique code or number identifying the location to its users | ||||
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 | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://dhis2.org/identifiertypes | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: code | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
identifier:href | SΣ | 0..1 | Identifier | Unique code or number identifying the location to its users | ||||
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 | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://dhis2.org/identifiertypes | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: href | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
status | ?!Σ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. | ||||
operationalStatus | Σ | 0..1 | Coding | The operational status of the location (typically only for a bed/room) Binding: hl7VS-bedStatus (preferred): The operational status if the location (where typically a bed/room). | ||||
name | SΣ | 1..1 | string | Name of the location as used by humans | ||||
alias | 0..* | string | A list of alternate names that the location is known as, or was known as, in the past | |||||
description | SΣ | 0..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name | ||||
mode | Σ | 0..1 | code | instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations. | ||||
type | Σ | 0..* | CodeableConcept | Type of function performed Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location. | ||||
telecom | 0..* | ContactPoint | Contact details of the location | |||||
address | 0..1 | Address | Physical location | |||||
physicalType | Σ | 0..1 | CodeableConcept | Physical form of the location Binding: LocationType (example): Physical form of the location. | ||||
position | 0..1 | BackboneElement | The absolute geographic location | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
longitude | 1..1 | decimal | Longitude with WGS84 datum | |||||
latitude | 1..1 | decimal | Latitude with WGS84 datum | |||||
altitude | 0..1 | decimal | Altitude with WGS84 datum | |||||
managingOrganization | Σ | 1..1 | Reference(MDOrganisationUnit Organization) | Organization responsible for provisioning and upkeep | ||||
partOf | S | 0..1 | Reference(Location) | Another Location this one is physically a part of | ||||
hoursOfOperation | 0..* | BackboneElement | What days/times during a week is this location usually open | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
allDay | 0..1 | boolean | The Location is open all day | |||||
openingTime | 0..1 | time | Time that the Location opens | |||||
closingTime | 0..1 | time | Time that the Location closes | |||||
availabilityExceptions | 0..1 | string | Description of availability exceptions | |||||
endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the location | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
Location.language | preferred | CommonLanguages
| ||||
Location.identifier:id.use | required | IdentifierUse | ||||
Location.identifier:id.type | extensible | Pattern: id | ||||
Location.identifier:code.use | required | IdentifierUse | ||||
Location.identifier:code.type | extensible | Pattern: code | ||||
Location.identifier:href.use | required | IdentifierUse | ||||
Location.identifier:href.type | extensible | Pattern: href | ||||
Location.status | required | LocationStatus | ||||
Location.operationalStatus | preferred | Hl7VSBedStatus | ||||
Location.mode | required | LocationMode | ||||
Location.type | extensible | ServiceDeliveryLocationRoleType | ||||
Location.physicalType | example | LocationType | ||||
Location.hoursOfOperation.daysOfWeek | required | DaysOfWeek |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Location | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Location | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Location | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Location | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Location | A resource should have narrative for robust management : text.`div`.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() |
This structure is derived from Location
Summary
Mandatory: 8 elements (4 nested mandatory elements)
Must-Support: 15 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Location
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Location | 0..* | Location | Details and position information for a physical place | |
Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |
shortName | S | 1..1 | string | ShortName URL: https://dhis2.org/StructureDefinition/ShortName |
level | S | 1..1 | integer | MDOrganisationUnit Hiearchy Level URL: https://dhis2.org/StructureDefinition/Level |
organisationUnitGroup | S | 0..* | Identifier | MDOrganisationUnitGroup Identifier URL: https://dhis2.org/StructureDefinition/OrganisationUnitGroup |
attributeValue | S | 0..* | (Complex) | MDAttributeValue URL: https://dhis2.org/StructureDefinition/AttributeValue |
geometry | S | 0..1 | Attachment | A boundary shape that represents the outside edge of the location (in GeoJSON format) URL: http://hl7.org/fhir/StructureDefinition/location-boundary-geojson |
Slices for identifier | S | 1..* | Identifier | Unique code or number identifying the location to its users Slice: Unordered, Open by pattern:type |
identifier:id | S | 1..1 | Identifier | Unique code or number identifying the location to its users |
type | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://dhis2.org/identifiertypes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: id | |
value | S | 1..1 | string | The value that is unique |
identifier:code | S | 0..1 | Identifier | Unique code or number identifying the location to its users |
type | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://dhis2.org/identifiertypes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: code | |
value | S | 1..1 | string | The value that is unique |
identifier:href | S | 0..1 | Identifier | Unique code or number identifying the location to its users |
type | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://dhis2.org/identifiertypes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: href | |
value | S | 1..1 | string | The value that is unique |
name | S | 1..1 | string | Name of the location as used by humans |
description | S | 0..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name |
managingOrganization | 1..1 | Reference(MDOrganisationUnit Organization) | Organization responsible for provisioning and upkeep | |
partOf | S | 0..1 | Reference(Location) | Another Location this one is physically a part of |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Location | 0..* | Location | Details and position information for a physical place | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |
shortName | S | 1..1 | string | ShortName URL: https://dhis2.org/StructureDefinition/ShortName |
level | S | 1..1 | integer | MDOrganisationUnit Hiearchy Level URL: https://dhis2.org/StructureDefinition/Level |
organisationUnitGroup | S | 0..* | Identifier | MDOrganisationUnitGroup Identifier URL: https://dhis2.org/StructureDefinition/OrganisationUnitGroup |
attributeValue | S | 0..* | (Complex) | MDAttributeValue URL: https://dhis2.org/StructureDefinition/AttributeValue |
geometry | S | 0..1 | Attachment | A boundary shape that represents the outside edge of the location (in GeoJSON format) URL: http://hl7.org/fhir/StructureDefinition/location-boundary-geojson |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | SΣ | 1..* | Identifier | Unique code or number identifying the location to its users Slice: Unordered, Open by pattern:type |
identifier:id | SΣ | 1..1 | Identifier | Unique code or number identifying the location to its users |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://dhis2.org/identifiertypes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: id | |
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
identifier:code | SΣ | 0..1 | Identifier | Unique code or number identifying the location to its users |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://dhis2.org/identifiertypes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: code | |
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
identifier:href | SΣ | 0..1 | Identifier | Unique code or number identifying the location to its users |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://dhis2.org/identifiertypes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: href | |
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
status | ?!Σ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. |
name | SΣ | 1..1 | string | Name of the location as used by humans |
description | SΣ | 0..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name |
managingOrganization | Σ | 1..1 | Reference(MDOrganisationUnit Organization) | Organization responsible for provisioning and upkeep |
partOf | S | 0..1 | Reference(Location) | Another Location this one is physically a part of |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Location.identifier:id.use | required | IdentifierUse |
Location.identifier:id.type | extensible | Pattern: id |
Location.identifier:code.use | required | IdentifierUse |
Location.identifier:code.type | extensible | Pattern: code |
Location.identifier:href.use | required | IdentifierUse |
Location.identifier:href.type | extensible | Pattern: href |
Location.status | required | LocationStatus |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Location | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Location | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Location | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Location | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Location | A resource should have narrative for robust management : text.`div`.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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Location | 0..* | Location | Details and position information for a physical place | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
shortName | S | 1..1 | string | ShortName URL: https://dhis2.org/StructureDefinition/ShortName | ||||
level | S | 1..1 | integer | MDOrganisationUnit Hiearchy Level URL: https://dhis2.org/StructureDefinition/Level | ||||
organisationUnitGroup | S | 0..* | Identifier | MDOrganisationUnitGroup Identifier URL: https://dhis2.org/StructureDefinition/OrganisationUnitGroup | ||||
attributeValue | S | 0..* | (Complex) | MDAttributeValue URL: https://dhis2.org/StructureDefinition/AttributeValue | ||||
geometry | S | 0..1 | Attachment | A boundary shape that represents the outside edge of the location (in GeoJSON format) URL: http://hl7.org/fhir/StructureDefinition/location-boundary-geojson | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | SΣ | 1..* | Identifier | Unique code or number identifying the location to its users Slice: Unordered, Open by pattern:type | ||||
identifier:id | SΣ | 1..1 | Identifier | Unique code or number identifying the location to its users | ||||
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 | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://dhis2.org/identifiertypes | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: id | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
identifier:code | SΣ | 0..1 | Identifier | Unique code or number identifying the location to its users | ||||
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 | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://dhis2.org/identifiertypes | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: code | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
identifier:href | SΣ | 0..1 | Identifier | Unique code or number identifying the location to its users | ||||
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 | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://dhis2.org/identifiertypes | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: href | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
status | ?!Σ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. | ||||
operationalStatus | Σ | 0..1 | Coding | The operational status of the location (typically only for a bed/room) Binding: hl7VS-bedStatus (preferred): The operational status if the location (where typically a bed/room). | ||||
name | SΣ | 1..1 | string | Name of the location as used by humans | ||||
alias | 0..* | string | A list of alternate names that the location is known as, or was known as, in the past | |||||
description | SΣ | 0..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name | ||||
mode | Σ | 0..1 | code | instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations. | ||||
type | Σ | 0..* | CodeableConcept | Type of function performed Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location. | ||||
telecom | 0..* | ContactPoint | Contact details of the location | |||||
address | 0..1 | Address | Physical location | |||||
physicalType | Σ | 0..1 | CodeableConcept | Physical form of the location Binding: LocationType (example): Physical form of the location. | ||||
position | 0..1 | BackboneElement | The absolute geographic location | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
longitude | 1..1 | decimal | Longitude with WGS84 datum | |||||
latitude | 1..1 | decimal | Latitude with WGS84 datum | |||||
altitude | 0..1 | decimal | Altitude with WGS84 datum | |||||
managingOrganization | Σ | 1..1 | Reference(MDOrganisationUnit Organization) | Organization responsible for provisioning and upkeep | ||||
partOf | S | 0..1 | Reference(Location) | Another Location this one is physically a part of | ||||
hoursOfOperation | 0..* | BackboneElement | What days/times during a week is this location usually open | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
allDay | 0..1 | boolean | The Location is open all day | |||||
openingTime | 0..1 | time | Time that the Location opens | |||||
closingTime | 0..1 | time | Time that the Location closes | |||||
availabilityExceptions | 0..1 | string | Description of availability exceptions | |||||
endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the location | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
Location.language | preferred | CommonLanguages
| ||||
Location.identifier:id.use | required | IdentifierUse | ||||
Location.identifier:id.type | extensible | Pattern: id | ||||
Location.identifier:code.use | required | IdentifierUse | ||||
Location.identifier:code.type | extensible | Pattern: code | ||||
Location.identifier:href.use | required | IdentifierUse | ||||
Location.identifier:href.type | extensible | Pattern: href | ||||
Location.status | required | LocationStatus | ||||
Location.operationalStatus | preferred | Hl7VSBedStatus | ||||
Location.mode | required | LocationMode | ||||
Location.type | extensible | ServiceDeliveryLocationRoleType | ||||
Location.physicalType | example | LocationType | ||||
Location.hoursOfOperation.daysOfWeek | required | DaysOfWeek |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Location | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Location | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Location | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Location | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Location | A resource should have narrative for robust management : text.`div`.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() |
This structure is derived from Location
Summary
Mandatory: 8 elements (4 nested mandatory elements)
Must-Support: 15 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron