Integrated Campaign Registry (ICR) Implementation Guide
0.1.0 - ci-build International flag

Integrated Campaign Registry (ICR) Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: ICR Location

Official URL: https://icr.healthcampaigns.org/StructureDefinition/ICRLocation Version: 0.1.0
Draft as of 2026-08-07 Computable Name: ICRLocation

The most-customized ICR resource — the ICR's georegistry layer, covering the WHO IDHC administrative boundary, health facility and school master lists: nested administrative hierarchy (6+ levels in campaign countries), operational geography linkable-but-distinct from admin units, GeoJSON boundaries, and multi-system geospatial identity — Overture Maps GERS IDs (building / place / division) as the preferred cross-campaign join key, with P-codes and national codes as coequal aliases. Per the IDHC georegistry rule, this layer holds only identify/classify/locate/contact data; programmatic data references it but never lives in it (working doc 7.7, 7.7,

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:boundary S 0..1 Attachment District polygon, settlement area, or catchment zone — the geometry Crosscut enriches and pushes back
URL: https://icr.healthcampaigns.org/StructureDefinition/location-boundary-geojson
.... extension:deliveryStrategy 0..1 CodeableConcept For delivery sites (fixed/temporary posts): the strategy this site serves
URL: https://icr.healthcampaigns.org/StructureDefinition/delivery-strategy
Binding: ICR Delivery Strategy (required)
.... extension:overlaysAdminUnit 0..* Reference(ICR Location) For operational geography (supervisory/operational areas): the admin unit(s) this area overlays — linkable-but-distinct from the admin hierarchy (working doc §9)
URL: https://icr.healthcampaigns.org/StructureDefinition/overlays-admin-unit
.... extension:settlementType S 0..1 CodeableConcept Settlement / special-population type (urban-slum, refugee-IDP, nomad-pastoralist, security-compromised, hard-to-reach…) — vulnerability/equity attribute for HTRA targeting (v0.21.0)
URL: https://icr.healthcampaigns.org/StructureDefinition/settlement-type
Binding: ICR Settlement / Special-population Type (extensible)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:gers SΣ 0..1 Identifier Overture Maps GERS ID (building / place / division). Record the Overture release version alongside (working doc §9.1).
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: https://icr.healthcampaigns.org/identifiers/overture-gers
.... identifier:pcode SΣ 0..1 Identifier OCHA P-code for administrative units
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: https://icr.healthcampaigns.org/identifiers/pcode
... status ?!SΣ 0..1 code active | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.
... name SΣ 0..1 string Name of the location as used by humans
... type SΣ 0..* CodeableConcept admin-unit / settlement / facility / school / community-distribution-point / temporary-post / household / supervisory-area / operational-area
Binding: ICR Location Type (extensible)
... physicalType SΣ 0..1 CodeableConcept jurisdiction / site / building / household
Binding: LocationType (example): Physical form of the location.
... position S 0..1 BackboneElement GPS point (longitude/latitude/altitude)
.... 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
... managingOrganization SΣ 0..1 Reference(ICR Facility Organization) For facilities: the accountable facility Organization (mCSD pairing) — carries the registry codes, national classification, and ownership; this Location carries only the physical place. Absent on admin units and other non-facility places.
... partOf S 0..1 Reference(ICR Location) Nested admin hierarchy: country → region → district → ward → settlement

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Location.identifier:gers.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Location.identifier:pcode.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Location.status Base required LocationStatus 📍4.0.1 FHIR Std.
Location.type Base extensible ICR Location Type 📦0.1.0 This IG
Location.physicalType Base example Location type 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Location 0..* Location Details and position information for a physical place
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:boundary S 0..1 Attachment District polygon, settlement area, or catchment zone — the geometry Crosscut enriches and pushes back
URL: https://icr.healthcampaigns.org/StructureDefinition/location-boundary-geojson
.... extension:deliveryStrategy 0..1 CodeableConcept For delivery sites (fixed/temporary posts): the strategy this site serves
URL: https://icr.healthcampaigns.org/StructureDefinition/delivery-strategy
Binding: ICR Delivery Strategy (required)
.... extension:overlaysAdminUnit 0..* Reference(ICR Location) For operational geography (supervisory/operational areas): the admin unit(s) this area overlays — linkable-but-distinct from the admin hierarchy (working doc §9)
URL: https://icr.healthcampaigns.org/StructureDefinition/overlays-admin-unit
.... extension:settlementType S 0..1 CodeableConcept Settlement / special-population type (urban-slum, refugee-IDP, nomad-pastoralist, security-compromised, hard-to-reach…) — vulnerability/equity attribute for HTRA targeting (v0.21.0)
URL: https://icr.healthcampaigns.org/StructureDefinition/settlement-type
Binding: ICR Settlement / Special-population Type (extensible)
... Slices for identifier S 0..* Identifier Multi-system identity: GERS (preferred cross-campaign join key), P-code, national codes
Slice: Unordered, Open by value:system
.... identifier:gers S 0..1 Identifier Overture Maps GERS ID (building / place / division). Record the Overture release version alongside (working doc §9.1).
..... system 1..1 uri The namespace for the identifier value
Required Pattern: https://icr.healthcampaigns.org/identifiers/overture-gers
.... identifier:pcode S 0..1 Identifier OCHA P-code for administrative units
..... system 1..1 uri The namespace for the identifier value
Required Pattern: https://icr.healthcampaigns.org/identifiers/pcode
... status S 0..1 code active | suspended | inactive
... type S 0..* CodeableConcept admin-unit / settlement / facility / school / community-distribution-point / temporary-post / household / supervisory-area / operational-area
Binding: ICR Location Type (extensible)
... physicalType S 0..1 CodeableConcept jurisdiction / site / building / household
... position S 0..1 BackboneElement GPS point (longitude/latitude/altitude)
... managingOrganization S 0..1 Reference(ICR Facility Organization) For facilities: the accountable facility Organization (mCSD pairing) — carries the registry codes, national classification, and ownership; this Location carries only the physical place. Absent on admin units and other non-facility places.
... partOf S 0..1 Reference(ICR Location) Nested admin hierarchy: country → region → district → ward → settlement

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Location.type Base extensible ICR Location Type 📦0.1.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:boundary S 0..1 Attachment District polygon, settlement area, or catchment zone — the geometry Crosscut enriches and pushes back
URL: https://icr.healthcampaigns.org/StructureDefinition/location-boundary-geojson
.... extension:deliveryStrategy 0..1 CodeableConcept For delivery sites (fixed/temporary posts): the strategy this site serves
URL: https://icr.healthcampaigns.org/StructureDefinition/delivery-strategy
Binding: ICR Delivery Strategy (required)
.... extension:overlaysAdminUnit 0..* Reference(ICR Location) For operational geography (supervisory/operational areas): the admin unit(s) this area overlays — linkable-but-distinct from the admin hierarchy (working doc §9)
URL: https://icr.healthcampaigns.org/StructureDefinition/overlays-admin-unit
.... extension:settlementType S 0..1 CodeableConcept Settlement / special-population type (urban-slum, refugee-IDP, nomad-pastoralist, security-compromised, hard-to-reach…) — vulnerability/equity attribute for HTRA targeting (v0.21.0)
URL: https://icr.healthcampaigns.org/StructureDefinition/settlement-type
Binding: ICR Settlement / Special-population Type (extensible)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 0..* Identifier Multi-system identity: GERS (preferred cross-campaign join key), P-code, national codes
Slice: Unordered, Open by value:system
.... identifier:gers SΣ 0..1 Identifier Overture Maps GERS ID (building / place / division). Record the Overture release version alongside (working doc §9.1).
..... 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 Σ 0..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.
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: https://icr.healthcampaigns.org/identifiers/overture-gers
..... value Σ 0..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:pcode SΣ 0..1 Identifier OCHA P-code for administrative units
..... 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 Σ 0..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.
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: https://icr.healthcampaigns.org/identifiers/pcode
..... value Σ 0..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 ?!SΣ 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Σ 0..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 Σ 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 SΣ 0..* CodeableConcept admin-unit / settlement / facility / school / community-distribution-point / temporary-post / household / supervisory-area / operational-area
Binding: ICR Location Type (extensible)
... telecom 0..* ContactPoint Contact details of the location
... address 0..1 Address Physical location
... physicalType SΣ 0..1 CodeableConcept jurisdiction / site / building / household
Binding: LocationType (example): Physical form of the location.
... position S 0..1 BackboneElement GPS point (longitude/latitude/altitude)
.... 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 SΣ 0..1 Reference(ICR Facility Organization) For facilities: the accountable facility Organization (mCSD pairing) — carries the registry codes, national classification, and ownership; this Location carries only the physical place. Absent on admin units and other non-facility places.
... partOf S 0..1 Reference(ICR Location) Nested admin hierarchy: country → region → district → ward → settlement
... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Location.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Location.identifier:gers.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Location.identifier:gers.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Location.identifier:pcode.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Location.identifier:pcode.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Location.status Base required LocationStatus 📍4.0.1 FHIR Std.
Location.operationalStatus Base preferred hl7VS-bedStatus 📦3.0.0 THO v7.3
Location.mode Base required LocationMode 📍4.0.1 FHIR Std.
Location.type Base extensible ICR Location Type 📦0.1.0 This IG
Location.physicalType Base example Location type 📍4.0.1 FHIR Std.
Location.hoursOfOperation.​daysOfWeek Base required DaysOfWeek 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:boundary S 0..1 Attachment District polygon, settlement area, or catchment zone — the geometry Crosscut enriches and pushes back
URL: https://icr.healthcampaigns.org/StructureDefinition/location-boundary-geojson
.... extension:deliveryStrategy 0..1 CodeableConcept For delivery sites (fixed/temporary posts): the strategy this site serves
URL: https://icr.healthcampaigns.org/StructureDefinition/delivery-strategy
Binding: ICR Delivery Strategy (required)
.... extension:overlaysAdminUnit 0..* Reference(ICR Location) For operational geography (supervisory/operational areas): the admin unit(s) this area overlays — linkable-but-distinct from the admin hierarchy (working doc §9)
URL: https://icr.healthcampaigns.org/StructureDefinition/overlays-admin-unit
.... extension:settlementType S 0..1 CodeableConcept Settlement / special-population type (urban-slum, refugee-IDP, nomad-pastoralist, security-compromised, hard-to-reach…) — vulnerability/equity attribute for HTRA targeting (v0.21.0)
URL: https://icr.healthcampaigns.org/StructureDefinition/settlement-type
Binding: ICR Settlement / Special-population Type (extensible)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:gers SΣ 0..1 Identifier Overture Maps GERS ID (building / place / division). Record the Overture release version alongside (working doc §9.1).
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: https://icr.healthcampaigns.org/identifiers/overture-gers
.... identifier:pcode SΣ 0..1 Identifier OCHA P-code for administrative units
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: https://icr.healthcampaigns.org/identifiers/pcode
... status ?!SΣ 0..1 code active | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.
... name SΣ 0..1 string Name of the location as used by humans
... type SΣ 0..* CodeableConcept admin-unit / settlement / facility / school / community-distribution-point / temporary-post / household / supervisory-area / operational-area
Binding: ICR Location Type (extensible)
... physicalType SΣ 0..1 CodeableConcept jurisdiction / site / building / household
Binding: LocationType (example): Physical form of the location.
... position S 0..1 BackboneElement GPS point (longitude/latitude/altitude)
.... 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
... managingOrganization SΣ 0..1 Reference(ICR Facility Organization) For facilities: the accountable facility Organization (mCSD pairing) — carries the registry codes, national classification, and ownership; this Location carries only the physical place. Absent on admin units and other non-facility places.
... partOf S 0..1 Reference(ICR Location) Nested admin hierarchy: country → region → district → ward → settlement

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Location.identifier:gers.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Location.identifier:pcode.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Location.status Base required LocationStatus 📍4.0.1 FHIR Std.
Location.type Base extensible ICR Location Type 📦0.1.0 This IG
Location.physicalType Base example Location type 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()

Differential View

This structure is derived from Location

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Location 0..* Location Details and position information for a physical place
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:boundary S 0..1 Attachment District polygon, settlement area, or catchment zone — the geometry Crosscut enriches and pushes back
URL: https://icr.healthcampaigns.org/StructureDefinition/location-boundary-geojson
.... extension:deliveryStrategy 0..1 CodeableConcept For delivery sites (fixed/temporary posts): the strategy this site serves
URL: https://icr.healthcampaigns.org/StructureDefinition/delivery-strategy
Binding: ICR Delivery Strategy (required)
.... extension:overlaysAdminUnit 0..* Reference(ICR Location) For operational geography (supervisory/operational areas): the admin unit(s) this area overlays — linkable-but-distinct from the admin hierarchy (working doc §9)
URL: https://icr.healthcampaigns.org/StructureDefinition/overlays-admin-unit
.... extension:settlementType S 0..1 CodeableConcept Settlement / special-population type (urban-slum, refugee-IDP, nomad-pastoralist, security-compromised, hard-to-reach…) — vulnerability/equity attribute for HTRA targeting (v0.21.0)
URL: https://icr.healthcampaigns.org/StructureDefinition/settlement-type
Binding: ICR Settlement / Special-population Type (extensible)
... Slices for identifier S 0..* Identifier Multi-system identity: GERS (preferred cross-campaign join key), P-code, national codes
Slice: Unordered, Open by value:system
.... identifier:gers S 0..1 Identifier Overture Maps GERS ID (building / place / division). Record the Overture release version alongside (working doc §9.1).
..... system 1..1 uri The namespace for the identifier value
Required Pattern: https://icr.healthcampaigns.org/identifiers/overture-gers
.... identifier:pcode S 0..1 Identifier OCHA P-code for administrative units
..... system 1..1 uri The namespace for the identifier value
Required Pattern: https://icr.healthcampaigns.org/identifiers/pcode
... status S 0..1 code active | suspended | inactive
... type S 0..* CodeableConcept admin-unit / settlement / facility / school / community-distribution-point / temporary-post / household / supervisory-area / operational-area
Binding: ICR Location Type (extensible)
... physicalType S 0..1 CodeableConcept jurisdiction / site / building / household
... position S 0..1 BackboneElement GPS point (longitude/latitude/altitude)
... managingOrganization S 0..1 Reference(ICR Facility Organization) For facilities: the accountable facility Organization (mCSD pairing) — carries the registry codes, national classification, and ownership; this Location carries only the physical place. Absent on admin units and other non-facility places.
... partOf S 0..1 Reference(ICR Location) Nested admin hierarchy: country → region → district → ward → settlement

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Location.type Base extensible ICR Location Type 📦0.1.0 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:boundary S 0..1 Attachment District polygon, settlement area, or catchment zone — the geometry Crosscut enriches and pushes back
URL: https://icr.healthcampaigns.org/StructureDefinition/location-boundary-geojson
.... extension:deliveryStrategy 0..1 CodeableConcept For delivery sites (fixed/temporary posts): the strategy this site serves
URL: https://icr.healthcampaigns.org/StructureDefinition/delivery-strategy
Binding: ICR Delivery Strategy (required)
.... extension:overlaysAdminUnit 0..* Reference(ICR Location) For operational geography (supervisory/operational areas): the admin unit(s) this area overlays — linkable-but-distinct from the admin hierarchy (working doc §9)
URL: https://icr.healthcampaigns.org/StructureDefinition/overlays-admin-unit
.... extension:settlementType S 0..1 CodeableConcept Settlement / special-population type (urban-slum, refugee-IDP, nomad-pastoralist, security-compromised, hard-to-reach…) — vulnerability/equity attribute for HTRA targeting (v0.21.0)
URL: https://icr.healthcampaigns.org/StructureDefinition/settlement-type
Binding: ICR Settlement / Special-population Type (extensible)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 0..* Identifier Multi-system identity: GERS (preferred cross-campaign join key), P-code, national codes
Slice: Unordered, Open by value:system
.... identifier:gers SΣ 0..1 Identifier Overture Maps GERS ID (building / place / division). Record the Overture release version alongside (working doc §9.1).
..... 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 Σ 0..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.
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: https://icr.healthcampaigns.org/identifiers/overture-gers
..... value Σ 0..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:pcode SΣ 0..1 Identifier OCHA P-code for administrative units
..... 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 Σ 0..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.
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: https://icr.healthcampaigns.org/identifiers/pcode
..... value Σ 0..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 ?!SΣ 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Σ 0..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 Σ 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 SΣ 0..* CodeableConcept admin-unit / settlement / facility / school / community-distribution-point / temporary-post / household / supervisory-area / operational-area
Binding: ICR Location Type (extensible)
... telecom 0..* ContactPoint Contact details of the location
... address 0..1 Address Physical location
... physicalType SΣ 0..1 CodeableConcept jurisdiction / site / building / household
Binding: LocationType (example): Physical form of the location.
... position S 0..1 BackboneElement GPS point (longitude/latitude/altitude)
.... 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 SΣ 0..1 Reference(ICR Facility Organization) For facilities: the accountable facility Organization (mCSD pairing) — carries the registry codes, national classification, and ownership; this Location carries only the physical place. Absent on admin units and other non-facility places.
... partOf S 0..1 Reference(ICR Location) Nested admin hierarchy: country → region → district → ward → settlement
... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Location.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Location.identifier:gers.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Location.identifier:gers.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Location.identifier:pcode.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Location.identifier:pcode.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Location.status Base required LocationStatus 📍4.0.1 FHIR Std.
Location.operationalStatus Base preferred hl7VS-bedStatus 📦3.0.0 THO v7.3
Location.mode Base required LocationMode 📍4.0.1 FHIR Std.
Location.type Base extensible ICR Location Type 📦0.1.0 This IG
Location.physicalType Base example Location type 📍4.0.1 FHIR Std.
Location.hoursOfOperation.​daysOfWeek Base required DaysOfWeek 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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: 0 element(2 nested mandatory elements)
Must-Support: 12 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Location.identifier

 

Other representations of profile: CSV, Excel, Schematron