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: ICRLocation - Detailed Descriptions

Draft as of 2026-08-20

Definitions for the ICRLocation resource profile.

Guidance on how to interpret the contents of this table can be foundhere

0. Location
Definition

Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.

ShortDetails and position information for a physical place
Control0..*
Is Modifierfalse
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
icr-loc-admin-id: An administrative unit must carry at least one identifier (any system — P-code, GERS, ISO, or the country's own code); without one it cannot be joined to any other system or campaign. (type.coding.where(system = 'https://icr.healthcampaigns.org/CodeSystem/icr-location-type-cs' and code = 'admin-unit').exists() implies identifier.exists())
icr-loc-admin-official: An administrative unit should mark its authoritative country code with identifier.use = 'official' — the uniform cross-country join key. Warning in v0.x; expected to be promoted to error at v1.0. (type.coding.where(system = 'https://icr.healthcampaigns.org/CodeSystem/icr-location-type-cs' and code = 'admin-unit').exists() implies identifier.where(use = 'official').exists())
2. Location.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Location.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortExtensionAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Location.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. Location.extension:boundary
    Slice Nameboundary
    Definition

    Boundary geometry for a Location — district polygons, settlement areas, catchment zones — as a GeoJSON attachment. R4 extension mirroring the R5 standard boundary extension; alignment path is working doc §10 question 6.

    ShortDistrict polygon, settlement area, or catchment zone (GeoJSON)
    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(Location Boundary (GeoJSON)) (Extension Type: Attachment)
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    8. Location.extension:settlementType
    Slice NamesettlementType
    Definition

    The settlement or special-population classification of a place (urban / rural / slum / refugee-IDP / nomad-pastoralist / security-compromised / hard-to-reach / cross-border / immigrant) — the recurring 'type of settlement' axis on the polio SIA monitoring/tally forms. A vulnerability/equity attribute of a Location that drives hard-to-reach-area targeting and equity disaggregation (forms-v1 / jul3-form-analysis §Aggregate #5).

    ShortSettlement / special-population type (urban-slum, refugee-IDP, nomad-pastoralist, security-compromised, hard-to-reach…) — vulnerability/equity attribute for HTRA targeting (v0.21.0)
    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(Settlement / Special-population Type) (Extension Type: CodeableConcept)
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    10. Location.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
    Summaryfalse
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    12. Location.identifier
    Definition

    Unique code or number identifying the location to its users.

    ShortMulti-system identity, all slices optional: GERS (preferred cross-campaign join key), P-code, ISO 3166. The country's own admin code rides the open list under the country's system URI, marked use = official — the uniform join key: identifier.where(use = 'official')Unique code or number identifying the location to its users
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..*
    TypeIdentifier
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Requirements

    Organization label locations in registries, need to keep track of those.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    SlicingThis element introduces a set of slices on Location.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ system
    • 14. Location.identifier:gers
      Slice Namegers
      Definition

      Unique code or number identifying the location to its users.

      ShortOverture Maps GERS ID (building / place / division). Record the Overture release version alongside (working doc §9.1).Unique code or number identifying the location to its users
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control0..1*
      TypeIdentifier
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Requirements

      Organization label locations in registries, need to keep track of those.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      16. Location.identifier:gers.use
      Definition

      The purpose of this identifier.

      Shortusual | official | temp | secondary | old (If known)
      Comments

      Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

      Control0..1
      BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
      (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

      Identifies the purpose for this identifier, if known .

      Typecode
      Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      18. Location.identifier:gers.system
      Definition

      Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

      ShortThe namespace for the identifier value
      Comments

      Identifier.system is always case sensitive.

      Control10..1
      Typeuri
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

      Pattern Valuehttps://icr.healthcampaigns.org/identifiers/overture-gers
      ExampleGeneral: http://www.acme.com/identifiers/patient
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      20. Location.identifier:pcode
      Slice Namepcode
      Definition

      Unique code or number identifying the location to its users.

      ShortOCHA P-code for administrative unitsUnique code or number identifying the location to its users
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control0..1*
      TypeIdentifier
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Requirements

      Organization label locations in registries, need to keep track of those.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      22. Location.identifier:pcode.use
      Definition

      The purpose of this identifier.

      Shortusual | official | temp | secondary | old (If known)
      Comments

      Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

      Control0..1
      BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
      (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

      Identifies the purpose for this identifier, if known .

      Typecode
      Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      24. Location.identifier:pcode.system
      Definition

      Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

      ShortThe namespace for the identifier value
      Comments

      Identifier.system is always case sensitive.

      Control10..1
      Typeuri
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

      Pattern Valuehttps://icr.healthcampaigns.org/identifiers/pcode
      ExampleGeneral: http://www.acme.com/identifiers/patient
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      26. Location.identifier:isoCountry
      Slice NameisoCountry
      Definition

      Unique code or number identifying the location to its users.

      ShortISO 3166-1 country code (admin level 0) — FHIR-designated system URIUnique code or number identifying the location to its users
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control0..1*
      TypeIdentifier
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Requirements

      Organization label locations in registries, need to keep track of those.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      28. Location.identifier:isoCountry.use
      Definition

      The purpose of this identifier.

      Shortusual | official | temp | secondary | old (If known)
      Comments

      Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

      Control0..1
      BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
      (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

      Identifies the purpose for this identifier, if known .

      Typecode
      Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      30. Location.identifier:isoCountry.system
      Definition

      Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

      ShortThe namespace for the identifier value
      Comments

      Identifier.system is always case sensitive.

      Control10..1
      Typeuri
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

      Pattern Valueurn:iso:std:iso:3166
      ExampleGeneral: http://www.acme.com/identifiers/patient
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      32. Location.identifier:isoSubdivision
      Slice NameisoSubdivision
      Definition

      Unique code or number identifying the location to its users.

      ShortISO 3166-2 subdivision code (first-level subdivisions) — FHIR-designated system URIUnique code or number identifying the location to its users
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control0..1*
      TypeIdentifier
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Requirements

      Organization label locations in registries, need to keep track of those.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      34. Location.identifier:isoSubdivision.use
      Definition

      The purpose of this identifier.

      Shortusual | official | temp | secondary | old (If known)
      Comments

      Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

      Control0..1
      BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
      (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

      Identifies the purpose for this identifier, if known .

      Typecode
      Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      36. Location.identifier:isoSubdivision.system
      Definition

      Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

      ShortThe namespace for the identifier value
      Comments

      Identifier.system is always case sensitive.

      Control10..1
      Typeuri
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

      Pattern Valueurn:iso:std:iso:3166:-2
      ExampleGeneral: http://www.acme.com/identifiers/patient
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      38. Location.status
      Definition

      The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.

      Shortactive | suspended | inactive
      Control0..1
      BindingThe codes SHALL be taken from LocationStatushttp://hl7.org/fhir/ValueSet/location-status|4.0.1
      (required to http://hl7.org/fhir/ValueSet/location-status|4.0.1)

      Indicates whether the location is still in use.

      Typecode
      Is Modifiertrue because This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      40. Location.name
      Definition

      Name of the location as used by humans. Does not need to be unique.

      ShortName of the location as used by humans
      Comments

      If the name of a location changes, consider putting the old name in the alias column so that it can still be located through searches.

      Control0..1
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      42. Location.type
      Definition

      Indicates the type of function performed at the location.

      Shortadmin-unit / settlement / facility / school / community-distribution-point / temporary-post / household / supervisory-area / operational-areaType of function performed
      Control0..*
      BindingUnless not suitable, these codes SHALL be taken from ICR Location Typehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
      (extensible to https://icr.healthcampaigns.org/ValueSet/icr-location-type)
      TypeCodeableConcept
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      44. Location.physicalType
      Definition

      Physical form of the location, e.g. building, room, vehicle, road.

      Shortjurisdiction / site / building / householdPhysical form of the location
      Control0..1
      BindingFor example codes, see LocationTypehttp://hl7.org/fhir/ValueSet/location-physical-type|4.0.1
      (example to http://hl7.org/fhir/ValueSet/location-physical-type|4.0.1)

      Physical form of the location.

      TypeCodeableConcept
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Requirements

      For purposes of showing relevant locations in queries, we need to categorize locations.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      46. Location.position
      Definition

      The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).

      ShortGPS point (longitude/latitude/altitude)The absolute geographic location
      Control0..1
      TypeBackboneElement
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Requirements

      For mobile applications and automated route-finding knowing the exact location of the Location is required.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      48. Location.position.modifierExtension
      Definition

      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

      ShortExtensions that cannot be ignored even if unrecognized
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control0..*
      TypeExtension
      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
      Summarytrue
      Requirements

      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

      Alternate Namesextensions, user content, modifiers
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      50. Location.position.longitude
      Definition

      Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below).

      ShortLongitude with WGS84 datum
      Control1..1
      Typedecimal
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      52. Location.position.latitude
      Definition

      Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below).

      ShortLatitude with WGS84 datum
      Control1..1
      Typedecimal
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      54. Location.managingOrganization
      Definition

      The organization responsible for the provisioning and upkeep of the location.

      ShortFor 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.Organization responsible for provisioning and upkeep
      Comments

      This can also be used as the part of the organization hierarchy where this location provides services. These services can be defined through the HealthcareService resource.

      Control0..1
      TypeReference(ICR Facility Organization, Organization)
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Requirements

      Need to know who manages the location.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      56. Location.partOf
      Definition

      Another Location of which this Location is physically a part of.

      ShortSingle containment tree: the one parent that fully contains this Location. Admin units chain upward (country → region → district → ward); settlements, facilities, and operational areas attach at the lowest admin unit that fully contains them — a supervisory area inside one district is partOf that district; one spanning districts attaches at region/state levelAnother Location this one is physically a part of
      Control0..1
      TypeReference(ICR Location, Location)
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Requirements

      For purposes of location, display and identification, knowing which locations are located within other locations is important.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

      Guidance on how to interpret the contents of this table can be foundhere

      0. Location
      Invariantsicr-loc-admin-id: An administrative unit must carry at least one identifier (any system — P-code, GERS, ISO, or the country's own code); without one it cannot be joined to any other system or campaign. (type.coding.where(system = 'https://icr.healthcampaigns.org/CodeSystem/icr-location-type-cs' and code = 'admin-unit').exists() implies identifier.exists())
      icr-loc-admin-official: An administrative unit should mark its authoritative country code with identifier.use = 'official' — the uniform cross-country join key. Warning in v0.x; expected to be promoted to error at v1.0. (type.coding.where(system = 'https://icr.healthcampaigns.org/CodeSystem/icr-location-type-cs' and code = 'admin-unit').exists() implies identifier.where(use = 'official').exists())
      2. Location.extension
      SlicingThis element introduces a set of slices on Location.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 4. Location.extension:boundary
        Slice Nameboundary
        ShortDistrict polygon, settlement area, or catchment zone (GeoJSON)
        Control0..1
        TypeExtension(Location Boundary (GeoJSON)) (Extension Type: Attachment)
        Must Supporttrue
        6. Location.extension:settlementType
        Slice NamesettlementType
        ShortSettlement / special-population type (urban-slum, refugee-IDP, nomad-pastoralist, security-compromised, hard-to-reach…) — vulnerability/equity attribute for HTRA targeting (v0.21.0)
        Control0..1
        TypeExtension(Settlement / Special-population Type) (Extension Type: CodeableConcept)
        Must Supporttrue
        8. Location.identifier
        ShortMulti-system identity, all slices optional: GERS (preferred cross-campaign join key), P-code, ISO 3166. The country's own admin code rides the open list under the country's system URI, marked use = official — the uniform join key: identifier.where(use = 'official')
        NoteThis is a business identifier, not a resource identifier (see discussion)
        Must Supporttrue
        SlicingThis element introduces a set of slices on Location.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ system
        • 10. Location.identifier:gers
          Slice Namegers
          ShortOverture Maps GERS ID (building / place / division). Record the Overture release version alongside (working doc §9.1).
          NoteThis is a business identifier, not a resource identifier (see discussion)
          Control0..1
          Must Supporttrue
          12. Location.identifier:gers.system
          Control1..?
          Pattern Valuehttps://icr.healthcampaigns.org/identifiers/overture-gers
          14. Location.identifier:pcode
          Slice Namepcode
          ShortOCHA P-code for administrative units
          NoteThis is a business identifier, not a resource identifier (see discussion)
          Control0..1
          Must Supporttrue
          16. Location.identifier:pcode.system
          Control1..?
          Pattern Valuehttps://icr.healthcampaigns.org/identifiers/pcode
          18. Location.identifier:isoCountry
          Slice NameisoCountry
          ShortISO 3166-1 country code (admin level 0) — FHIR-designated system URI
          NoteThis is a business identifier, not a resource identifier (see discussion)
          Control0..1
          Must Supporttrue
          20. Location.identifier:isoCountry.system
          Control1..?
          Pattern Valueurn:iso:std:iso:3166
          22. Location.identifier:isoSubdivision
          Slice NameisoSubdivision
          ShortISO 3166-2 subdivision code (first-level subdivisions) — FHIR-designated system URI
          NoteThis is a business identifier, not a resource identifier (see discussion)
          Control0..1
          Must Supporttrue
          24. Location.identifier:isoSubdivision.system
          Control1..?
          Pattern Valueurn:iso:std:iso:3166:-2
          26. Location.status
          Must Supporttrue
          28. Location.name
          Must Supporttrue
          30. Location.type
          Shortadmin-unit / settlement / facility / school / community-distribution-point / temporary-post / household / supervisory-area / operational-area
          BindingUnless not suitable, these codes SHALL be taken from ICR Location Type
          (extensible to https://icr.healthcampaigns.org/ValueSet/icr-location-type)
          Must Supporttrue
          32. Location.physicalType
          Shortjurisdiction / site / building / household
          Must Supporttrue
          34. Location.position
          ShortGPS point (longitude/latitude/altitude)
          Must Supporttrue
          36. Location.managingOrganization
          ShortFor 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.
          TypeReference(ICR Facility Organization)
          Must Supporttrue
          38. Location.partOf
          ShortSingle containment tree: the one parent that fully contains this Location. Admin units chain upward (country → region → district → ward); settlements, facilities, and operational areas attach at the lowest admin unit that fully contains them — a supervisory area inside one district is partOf that district; one spanning districts attaches at region/state level
          TypeReference(ICR Location)
          Must Supporttrue

          Guidance on how to interpret the contents of this table can be foundhere

          0. Location
          Definition

          Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.

          ShortDetails and position information for a physical place
          Control0..*
          Is Modifierfalse
          Summaryfalse
          Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
          dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
          dom-6: A resource should have narrative for robust management (text.`div`.exists())
          icr-loc-admin-id: An administrative unit must carry at least one identifier (any system — P-code, GERS, ISO, or the country's own code); without one it cannot be joined to any other system or campaign. (type.coding.where(system = 'https://icr.healthcampaigns.org/CodeSystem/icr-location-type-cs' and code = 'admin-unit').exists() implies identifier.exists())
          icr-loc-admin-official: An administrative unit should mark its authoritative country code with identifier.use = 'official' — the uniform cross-country join key. Warning in v0.x; expected to be promoted to error at v1.0. (type.coding.where(system = 'https://icr.healthcampaigns.org/CodeSystem/icr-location-type-cs' and code = 'admin-unit').exists() implies identifier.where(use = 'official').exists())
          2. Location.id
          Definition

          The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

          ShortLogical id of this artifact
          Comments

          The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

          Control0..1
          Typeid
          Is Modifierfalse
          Summarytrue
          4. Location.meta
          Definition

          The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

          ShortMetadata about the resource
          Control0..1
          TypeMeta
          Is Modifierfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          6. Location.implicitRules
          Definition

          A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

          ShortA set of rules under which this content was created
          Comments

          Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

          Control0..1
          Typeuri
          Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          8. Location.language
          Definition

          The base language in which the resource is written.

          ShortLanguage of the resource content
          Comments

          Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

          Control0..1
          BindingThe codes SHOULD be taken from CommonLanguages
          (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

          A human language.

          Additional BindingsPurpose
          AllLanguagesMax Binding
          Typecode
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          10. Location.text
          Definition

          A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

          ShortText summary of the resource, for human interpretation
          Comments

          Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

          Control0..1
          TypeNarrative
          Is Modifierfalse
          Summaryfalse
          Alternate Namesnarrative, html, xhtml, display
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          12. Location.contained
          Definition

          These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

          ShortContained, inline Resources
          Comments

          This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

          Control0..*
          TypeResource
          Is Modifierfalse
          Summaryfalse
          Alternate Namesinline resources, anonymous resources, contained resources
          14. Location.extension
          Definition

          An Extension

          ShortExtension
          Control0..*
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          SlicingThis element introduces a set of slices on Location.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 16. Location.extension:boundary
            Slice Nameboundary
            Definition

            Boundary geometry for a Location — district polygons, settlement areas, catchment zones — as a GeoJSON attachment. R4 extension mirroring the R5 standard boundary extension; alignment path is working doc §10 question 6.

            ShortDistrict polygon, settlement area, or catchment zone (GeoJSON)
            Control0..1
            This element is affected by the following invariants: ele-1
            TypeExtension(Location Boundary (GeoJSON)) (Extension Type: Attachment)
            Is Modifierfalse
            Must Supporttrue
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            18. Location.extension:settlementType
            Slice NamesettlementType
            Definition

            The settlement or special-population classification of a place (urban / rural / slum / refugee-IDP / nomad-pastoralist / security-compromised / hard-to-reach / cross-border / immigrant) — the recurring 'type of settlement' axis on the polio SIA monitoring/tally forms. A vulnerability/equity attribute of a Location that drives hard-to-reach-area targeting and equity disaggregation (forms-v1 / jul3-form-analysis §Aggregate #5).

            ShortSettlement / special-population type (urban-slum, refugee-IDP, nomad-pastoralist, security-compromised, hard-to-reach…) — vulnerability/equity attribute for HTRA targeting (v0.21.0)
            Control0..1
            This element is affected by the following invariants: ele-1
            TypeExtension(Settlement / Special-population Type) (Extension Type: CodeableConcept)
            Is Modifierfalse
            Must Supporttrue
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            20. Location.modifierExtension
            Definition

            May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

            Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

            ShortExtensions that cannot be ignored
            Comments

            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

            Control0..*
            TypeExtension
            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
            Summaryfalse
            Requirements

            Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

            Alternate Namesextensions, user content
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            22. Location.identifier
            Definition

            Unique code or number identifying the location to its users.

            ShortMulti-system identity, all slices optional: GERS (preferred cross-campaign join key), P-code, ISO 3166. The country's own admin code rides the open list under the country's system URI, marked use = official — the uniform join key: identifier.where(use = 'official')
            NoteThis is a business identifier, not a resource identifier (see discussion)
            Control0..*
            TypeIdentifier
            Is Modifierfalse
            Must Supporttrue
            Summarytrue
            Requirements

            Organization label locations in registries, need to keep track of those.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            SlicingThis element introduces a set of slices on Location.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ system
            • 24. Location.identifier:gers
              Slice Namegers
              Definition

              Unique code or number identifying the location to its users.

              ShortOverture Maps GERS ID (building / place / division). Record the Overture release version alongside (working doc §9.1).
              NoteThis is a business identifier, not a resource identifier (see discussion)
              Control0..1
              TypeIdentifier
              Is Modifierfalse
              Must Supporttrue
              Summarytrue
              Requirements

              Organization label locations in registries, need to keep track of those.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              26. Location.identifier:gers.id
              Definition

              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

              ShortUnique id for inter-element referencing
              Control0..1
              Typestring
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              28. Location.identifier:gers.extension
              Definition

              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

              ShortAdditional content defined by implementations
              Comments

              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

              Control0..*
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              Alternate Namesextensions, user content
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              SlicingThis element introduces a set of slices on Location.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 30. Location.identifier:gers.use
                Definition

                The purpose of this identifier.

                Shortusual | official | temp | secondary | old (If known)
                Comments

                Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                Control0..1
                BindingThe codes SHALL be taken from IdentifierUse
                (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

                Identifies the purpose for this identifier, if known .

                Typecode
                Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Requirements

                Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                32. Location.identifier:gers.type
                Definition

                A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                ShortDescription of identifier
                Comments

                This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                Control0..1
                BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
                (extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.0.1)

                A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

                TypeCodeableConcept
                Is Modifierfalse
                Summarytrue
                Requirements

                Allows users to make use of identifiers when the identifier system is not known.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                34. Location.identifier:gers.system
                Definition

                Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

                ShortThe namespace for the identifier value
                Comments

                Identifier.system is always case sensitive.

                Control1..1
                Typeuri
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Requirements

                There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                Pattern Valuehttps://icr.healthcampaigns.org/identifiers/overture-gers
                ExampleGeneral: http://www.acme.com/identifiers/patient
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                36. Location.identifier:gers.value
                Definition

                The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                ShortThe value that is unique
                Comments

                If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                Control0..1
                Typestring
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                ExampleGeneral: 123456
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                38. Location.identifier:gers.period
                Definition

                Time period during which identifier is/was valid for use.

                ShortTime period when id is/was valid for use
                Control0..1
                TypePeriod
                Is Modifierfalse
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                40. Location.identifier:gers.assigner
                Definition

                Organization that issued/manages the identifier.

                ShortOrganization that issued id (may be just text)
                Comments

                The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

                Control0..1
                TypeReference(Organization)
                Is Modifierfalse
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                42. Location.identifier:pcode
                Slice Namepcode
                Definition

                Unique code or number identifying the location to its users.

                ShortOCHA P-code for administrative units
                NoteThis is a business identifier, not a resource identifier (see discussion)
                Control0..1
                TypeIdentifier
                Is Modifierfalse
                Must Supporttrue
                Summarytrue
                Requirements

                Organization label locations in registries, need to keep track of those.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                44. Location.identifier:pcode.id
                Definition

                Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                ShortUnique id for inter-element referencing
                Control0..1
                Typestring
                Is Modifierfalse
                XML FormatIn the XML format, this property is represented as an attribute.
                Summaryfalse
                46. Location.identifier:pcode.extension
                Definition

                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                ShortAdditional content defined by implementations
                Comments

                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                Control0..*
                TypeExtension
                Is Modifierfalse
                Summaryfalse
                Alternate Namesextensions, user content
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                SlicingThis element introduces a set of slices on Location.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 48. Location.identifier:pcode.use
                  Definition

                  The purpose of this identifier.

                  Shortusual | official | temp | secondary | old (If known)
                  Comments

                  Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                  Control0..1
                  BindingThe codes SHALL be taken from IdentifierUse
                  (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

                  Identifies the purpose for this identifier, if known .

                  Typecode
                  Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Requirements

                  Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  50. Location.identifier:pcode.type
                  Definition

                  A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                  ShortDescription of identifier
                  Comments

                  This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                  Control0..1
                  BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
                  (extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.0.1)

                  A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

                  TypeCodeableConcept
                  Is Modifierfalse
                  Summarytrue
                  Requirements

                  Allows users to make use of identifiers when the identifier system is not known.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  52. Location.identifier:pcode.system
                  Definition

                  Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

                  ShortThe namespace for the identifier value
                  Comments

                  Identifier.system is always case sensitive.

                  Control1..1
                  Typeuri
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Requirements

                  There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                  Pattern Valuehttps://icr.healthcampaigns.org/identifiers/pcode
                  ExampleGeneral: http://www.acme.com/identifiers/patient
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  54. Location.identifier:pcode.value
                  Definition

                  The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                  ShortThe value that is unique
                  Comments

                  If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                  Control0..1
                  Typestring
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  ExampleGeneral: 123456
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  56. Location.identifier:pcode.period
                  Definition

                  Time period during which identifier is/was valid for use.

                  ShortTime period when id is/was valid for use
                  Control0..1
                  TypePeriod
                  Is Modifierfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  58. Location.identifier:pcode.assigner
                  Definition

                  Organization that issued/manages the identifier.

                  ShortOrganization that issued id (may be just text)
                  Comments

                  The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

                  Control0..1
                  TypeReference(Organization)
                  Is Modifierfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  60. Location.identifier:isoCountry
                  Slice NameisoCountry
                  Definition

                  Unique code or number identifying the location to its users.

                  ShortISO 3166-1 country code (admin level 0) — FHIR-designated system URI
                  NoteThis is a business identifier, not a resource identifier (see discussion)
                  Control0..1
                  TypeIdentifier
                  Is Modifierfalse
                  Must Supporttrue
                  Summarytrue
                  Requirements

                  Organization label locations in registries, need to keep track of those.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  62. Location.identifier:isoCountry.id
                  Definition

                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                  ShortUnique id for inter-element referencing
                  Control0..1
                  Typestring
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  64. Location.identifier:isoCountry.extension
                  Definition

                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                  ShortAdditional content defined by implementations
                  Comments

                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                  Control0..*
                  TypeExtension
                  Is Modifierfalse
                  Summaryfalse
                  Alternate Namesextensions, user content
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  SlicingThis element introduces a set of slices on Location.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 66. Location.identifier:isoCountry.use
                    Definition

                    The purpose of this identifier.

                    Shortusual | official | temp | secondary | old (If known)
                    Comments

                    Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                    Control0..1
                    BindingThe codes SHALL be taken from IdentifierUse
                    (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

                    Identifies the purpose for this identifier, if known .

                    Typecode
                    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Requirements

                    Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    68. Location.identifier:isoCountry.type
                    Definition

                    A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                    ShortDescription of identifier
                    Comments

                    This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                    Control0..1
                    BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
                    (extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.0.1)

                    A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

                    TypeCodeableConcept
                    Is Modifierfalse
                    Summarytrue
                    Requirements

                    Allows users to make use of identifiers when the identifier system is not known.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    70. Location.identifier:isoCountry.system
                    Definition

                    Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

                    ShortThe namespace for the identifier value
                    Comments

                    Identifier.system is always case sensitive.

                    Control1..1
                    Typeuri
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Requirements

                    There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                    Pattern Valueurn:iso:std:iso:3166
                    ExampleGeneral: http://www.acme.com/identifiers/patient
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    72. Location.identifier:isoCountry.value
                    Definition

                    The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                    ShortThe value that is unique
                    Comments

                    If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                    Control0..1
                    Typestring
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    ExampleGeneral: 123456
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    74. Location.identifier:isoCountry.period
                    Definition

                    Time period during which identifier is/was valid for use.

                    ShortTime period when id is/was valid for use
                    Control0..1
                    TypePeriod
                    Is Modifierfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    76. Location.identifier:isoCountry.assigner
                    Definition

                    Organization that issued/manages the identifier.

                    ShortOrganization that issued id (may be just text)
                    Comments

                    The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

                    Control0..1
                    TypeReference(Organization)
                    Is Modifierfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    78. Location.identifier:isoSubdivision
                    Slice NameisoSubdivision
                    Definition

                    Unique code or number identifying the location to its users.

                    ShortISO 3166-2 subdivision code (first-level subdivisions) — FHIR-designated system URI
                    NoteThis is a business identifier, not a resource identifier (see discussion)
                    Control0..1
                    TypeIdentifier
                    Is Modifierfalse
                    Must Supporttrue
                    Summarytrue
                    Requirements

                    Organization label locations in registries, need to keep track of those.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    80. Location.identifier:isoSubdivision.id
                    Definition

                    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                    ShortUnique id for inter-element referencing
                    Control0..1
                    Typestring
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    82. Location.identifier:isoSubdivision.extension
                    Definition

                    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                    ShortAdditional content defined by implementations
                    Comments

                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                    Control0..*
                    TypeExtension
                    Is Modifierfalse
                    Summaryfalse
                    Alternate Namesextensions, user content
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    SlicingThis element introduces a set of slices on Location.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 84. Location.identifier:isoSubdivision.use
                      Definition

                      The purpose of this identifier.

                      Shortusual | official | temp | secondary | old (If known)
                      Comments

                      Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                      Control0..1
                      BindingThe codes SHALL be taken from IdentifierUse
                      (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

                      Identifies the purpose for this identifier, if known .

                      Typecode
                      Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      86. Location.identifier:isoSubdivision.type
                      Definition

                      A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                      ShortDescription of identifier
                      Comments

                      This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                      Control0..1
                      BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
                      (extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.0.1)

                      A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

                      TypeCodeableConcept
                      Is Modifierfalse
                      Summarytrue
                      Requirements

                      Allows users to make use of identifiers when the identifier system is not known.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      88. Location.identifier:isoSubdivision.system
                      Definition

                      Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

                      ShortThe namespace for the identifier value
                      Comments

                      Identifier.system is always case sensitive.

                      Control1..1
                      Typeuri
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                      Pattern Valueurn:iso:std:iso:3166:-2
                      ExampleGeneral: http://www.acme.com/identifiers/patient
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      90. Location.identifier:isoSubdivision.value
                      Definition

                      The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                      ShortThe value that is unique
                      Comments

                      If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                      Control0..1
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      ExampleGeneral: 123456
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      92. Location.identifier:isoSubdivision.period
                      Definition

                      Time period during which identifier is/was valid for use.

                      ShortTime period when id is/was valid for use
                      Control0..1
                      TypePeriod
                      Is Modifierfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      94. Location.identifier:isoSubdivision.assigner
                      Definition

                      Organization that issued/manages the identifier.

                      ShortOrganization that issued id (may be just text)
                      Comments

                      The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

                      Control0..1
                      TypeReference(Organization)
                      Is Modifierfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      96. Location.status
                      Definition

                      The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.

                      Shortactive | suspended | inactive
                      Control0..1
                      BindingThe codes SHALL be taken from LocationStatus
                      (required to http://hl7.org/fhir/ValueSet/location-status|4.0.1)

                      Indicates whether the location is still in use.

                      Typecode
                      Is Modifiertrue because This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supporttrue
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      98. Location.operationalStatus
                      Definition

                      The operational status covers operation values most relevant to beds (but can also apply to rooms/units/chairs/etc. such as an isolation unit/dialysis chair). This typically covers concepts such as contamination, housekeeping, and other activities like maintenance.

                      ShortThe operational status of the location (typically only for a bed/room)
                      Control0..1
                      BindingThe codes SHOULD be taken from hl7VS-bedStatus
                      (preferred to http://terminology.hl7.org/ValueSet/v2-0116)

                      The operational status if the location (where typically a bed/room).

                      TypeCoding
                      Is Modifierfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      100. Location.name
                      Definition

                      Name of the location as used by humans. Does not need to be unique.

                      ShortName of the location as used by humans
                      Comments

                      If the name of a location changes, consider putting the old name in the alias column so that it can still be located through searches.

                      Control0..1
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supporttrue
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      102. Location.alias
                      Definition

                      A list of alternate names that the location is known as, or was known as, in the past.

                      ShortA list of alternate names that the location is known as, or was known as, in the past
                      Comments

                      There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the location.

                      Control0..*
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summaryfalse
                      Requirements

                      Over time locations and organizations go through many changes and can be known by different names.

                      For searching knowing previous names that the location was known by can be very useful.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      104. Location.description
                      Definition

                      Description of the Location, which helps in finding or referencing the place.

                      ShortAdditional details about the location that could be displayed as further information to identify the location beyond its name
                      Control0..1
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      Humans need additional information to verify a correct location has been identified.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      106. Location.mode
                      Definition

                      Indicates whether a resource instance represents a specific location or a class of locations.

                      Shortinstance | kind
                      Comments

                      This is labeled as a modifier because whether or not the location is a class of locations changes how it can be used and understood.

                      Control0..1
                      BindingThe codes SHALL be taken from LocationMode
                      (required to http://hl7.org/fhir/ValueSet/location-mode|4.0.1)

                      Indicates whether a resource instance represents a specific location or a class of locations.

                      Typecode
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      When using a Location resource for scheduling or orders, we need to be able to refer to a class of Locations instead of a specific Location.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      108. Location.type
                      Definition

                      Indicates the type of function performed at the location.

                      Shortadmin-unit / settlement / facility / school / community-distribution-point / temporary-post / household / supervisory-area / operational-area
                      Control0..*
                      BindingUnless not suitable, these codes SHALL be taken from ICR Location Type
                      (extensible to https://icr.healthcampaigns.org/ValueSet/icr-location-type)
                      TypeCodeableConcept
                      Is Modifierfalse
                      Must Supporttrue
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      110. Location.telecom
                      Definition

                      The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.

                      ShortContact details of the location
                      Control0..*
                      TypeContactPoint
                      Is Modifierfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      112. Location.address
                      Definition

                      Physical location.

                      ShortPhysical location
                      Comments

                      Additional addresses should be recorded using another instance of the Location resource, or via the Organization.

                      Control0..1
                      TypeAddress
                      Is Modifierfalse
                      Summaryfalse
                      Requirements

                      If locations can be visited, we need to keep track of their address.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      114. Location.physicalType
                      Definition

                      Physical form of the location, e.g. building, room, vehicle, road.

                      Shortjurisdiction / site / building / household
                      Control0..1
                      BindingFor example codes, see LocationType
                      (example to http://hl7.org/fhir/ValueSet/location-physical-type|4.0.1)

                      Physical form of the location.

                      TypeCodeableConcept
                      Is Modifierfalse
                      Must Supporttrue
                      Summarytrue
                      Requirements

                      For purposes of showing relevant locations in queries, we need to categorize locations.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      116. Location.position
                      Definition

                      The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).

                      ShortGPS point (longitude/latitude/altitude)
                      Control0..1
                      TypeBackboneElement
                      Is Modifierfalse
                      Must Supporttrue
                      Summaryfalse
                      Requirements

                      For mobile applications and automated route-finding knowing the exact location of the Location is required.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      118. Location.position.id
                      Definition

                      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                      ShortUnique id for inter-element referencing
                      Control0..1
                      Typestring
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      120. Location.position.extension
                      Definition

                      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                      ShortAdditional content defined by implementations
                      Comments

                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                      Control0..*
                      TypeExtension
                      Is Modifierfalse
                      Summaryfalse
                      Alternate Namesextensions, user content
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      122. Location.position.modifierExtension
                      Definition

                      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                      ShortExtensions that cannot be ignored even if unrecognized
                      Comments

                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                      Control0..*
                      TypeExtension
                      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                      Summarytrue
                      Requirements

                      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                      Alternate Namesextensions, user content, modifiers
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      124. Location.position.longitude
                      Definition

                      Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below).

                      ShortLongitude with WGS84 datum
                      Control1..1
                      Typedecimal
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      126. Location.position.latitude
                      Definition

                      Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below).

                      ShortLatitude with WGS84 datum
                      Control1..1
                      Typedecimal
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      128. Location.position.altitude
                      Definition

                      Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below).

                      ShortAltitude with WGS84 datum
                      Control0..1
                      Typedecimal
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      130. Location.managingOrganization
                      Definition

                      The organization responsible for the provisioning and upkeep of the location.

                      ShortFor 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.
                      Comments

                      This can also be used as the part of the organization hierarchy where this location provides services. These services can be defined through the HealthcareService resource.

                      Control0..1
                      TypeReference(ICR Facility Organization)
                      Is Modifierfalse
                      Must Supporttrue
                      Summarytrue
                      Requirements

                      Need to know who manages the location.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      132. Location.partOf
                      Definition

                      Another Location of which this Location is physically a part of.

                      ShortSingle containment tree: the one parent that fully contains this Location. Admin units chain upward (country → region → district → ward); settlements, facilities, and operational areas attach at the lowest admin unit that fully contains them — a supervisory area inside one district is partOf that district; one spanning districts attaches at region/state level
                      Control0..1
                      TypeReference(ICR Location)
                      Is Modifierfalse
                      Must Supporttrue
                      Summaryfalse
                      Requirements

                      For purposes of location, display and identification, knowing which locations are located within other locations is important.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      134. Location.hoursOfOperation
                      Definition

                      What days/times during a week is this location usually open.

                      ShortWhat days/times during a week is this location usually open
                      Comments

                      This type of information is commonly found published in directories and on websites informing customers when the facility is available.

                      Specific services within the location may have their own hours which could be shorter (or longer) than the locations hours.

                      Control0..*
                      TypeBackboneElement
                      Is Modifierfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      136. Location.hoursOfOperation.id
                      Definition

                      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                      ShortUnique id for inter-element referencing
                      Control0..1
                      Typestring
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      138. Location.hoursOfOperation.extension
                      Definition

                      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                      ShortAdditional content defined by implementations
                      Comments

                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                      Control0..*
                      TypeExtension
                      Is Modifierfalse
                      Summaryfalse
                      Alternate Namesextensions, user content
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      140. Location.hoursOfOperation.modifierExtension
                      Definition

                      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                      ShortExtensions that cannot be ignored even if unrecognized
                      Comments

                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                      Control0..*
                      TypeExtension
                      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                      Summarytrue
                      Requirements

                      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                      Alternate Namesextensions, user content, modifiers
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      142. Location.hoursOfOperation.daysOfWeek
                      Definition

                      Indicates which days of the week are available between the start and end Times.

                      Shortmon | tue | wed | thu | fri | sat | sun
                      Control0..*
                      BindingThe codes SHALL be taken from DaysOfWeek
                      (required to http://hl7.org/fhir/ValueSet/days-of-week|4.0.1)

                      The days of the week.

                      Typecode
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      144. Location.hoursOfOperation.allDay
                      Definition

                      The Location is open all day.

                      ShortThe Location is open all day
                      Control0..1
                      Typeboolean
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      146. Location.hoursOfOperation.openingTime
                      Definition

                      Time that the Location opens.

                      ShortTime that the Location opens
                      Control0..1
                      Typetime
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      148. Location.hoursOfOperation.closingTime
                      Definition

                      Time that the Location closes.

                      ShortTime that the Location closes
                      Control0..1
                      Typetime
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      150. Location.availabilityExceptions
                      Definition

                      A description of when the locations opening ours are different to normal, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as detailed in the opening hours Times.

                      ShortDescription of availability exceptions
                      Control0..1
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      152. Location.endpoint
                      Definition

                      Technical endpoints providing access to services operated for the location.

                      ShortTechnical endpoints providing access to services operated for the location
                      Control0..*
                      TypeReference(Endpoint)
                      Is Modifierfalse
                      Summaryfalse
                      Requirements

                      Organizations may have different systems at different locations that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))