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

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

Resource Profile: ICR Location Status

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

A time-varying, provenance-carrying property assertion about a place — endemicity ('this district is LF-endemic, under MDA') first, with future axes such as access/security status or elimination milestones. The location-scoped analogue of the denominator discipline (working doc §7.6): assertions are revisable, sources can disagree, and every assertion carries who asserted it, when, by what method, and from what evidence. That is why it is an Observation JOINED to the Location rather than a field inside it — per the georegistry rule, Location carries durable identity only; revisable epidemiological state lives beside it. Semantics: an assertion applies to the location's entire partOf subtree unless a lower-level assertion overrides it, and consumers read the newest final/amended assertion per (subject, code). Properties are pre-coordinated codes (ICRLocationStatusVS): a new location property is a new code, not a new profile. Counts and rates are NOT this profile — they stay MeasureReport; durable identity classifications (settlement-type) stay on Location.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* Observation Measurements and simple assertions
Constraints: obs-6, obs-7
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!SΣ 1..1 code final; a newer final or amended assertion supersedes — read the latest per (subject, code)
Binding: ObservationStatus (required): Codes providing the status of an observation.
... subject SΣ 1..1 Reference(ICR Location) The place this assertion is about (subject, not focus — the observation is fundamentally about the place). Typically the district / implementation unit; applies to its subtree unless overridden below
... effective[x] SΣ 0..1 When the classification was assessed / holds from — open-ended: current until superseded
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effectiveTiming Timing
.... effectiveInstant instant
... performer SΣ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who asserted it: the MoH NTD programme, a mapping-survey team, an ESPEN/JRSM extract
... value[x] SΣC 0..1 CodeableConcept The classification — the JRSM ladder for the endemicity codes; future property codes bring their own vocabularies (hence extensible)
Binding: ICR Endemicity Status (extensible)
... method S 0..1 CodeableConcept How it was determined: mapping survey, TAS, sentinel site, administrative report
Binding: ObservationMethods (example): Methods for simple observations.
... derivedFrom SΣ 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) The evidentiary trail — the mapping-survey form response or source document

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.code Base extensible ICR Location Status 📦0.1.0 This IG
Observation.value[x] Base extensible ICR Endemicity Status 📦0.1.0 This IG
Observation.method Base example Observation Methods 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation 0..* Observation Measurements and simple assertions
... status S 1..1 code final; a newer final or amended assertion supersedes — read the latest per (subject, code)
... code S 1..1 CodeableConcept The property asserted — pre-coordinated per disease (lf-endemicity, oncho-endemicity, …); 'which districts are LF-endemic' is a single-code query
Binding: ICR Location Status (extensible)
... subject S 1..1 Reference(ICR Location) The place this assertion is about (subject, not focus — the observation is fundamentally about the place). Typically the district / implementation unit; applies to its subtree unless overridden below
... performer S 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who asserted it: the MoH NTD programme, a mapping-survey team, an ESPEN/JRSM extract
... value[x] S 0..1 CodeableConcept The classification — the JRSM ladder for the endemicity codes; future property codes bring their own vocabularies (hence extensible)
Binding: ICR Endemicity Status (extensible)
... method S 0..1 CodeableConcept How it was determined: mapping survey, TAS, sentinel site, administrative report
... derivedFrom S 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) The evidentiary trail — the mapping-survey form response or source document

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Observation.code Base extensible ICR Location Status 📦0.1.0 This IG
Observation.value[x] Base extensible ICR Endemicity Status 📦0.1.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* Observation Measurements and simple assertions
Constraints: obs-6, obs-7
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business Identifier for observation
... basedOn Σ 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Fulfills plan, proposal or order
... partOf Σ 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Part of referenced event
... status ?!SΣ 1..1 code final; a newer final or amended assertion supersedes — read the latest per (subject, code)
Binding: ObservationStatus (required): Codes providing the status of an observation.
... category 0..* CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
... code SΣ 1..1 CodeableConcept The property asserted — pre-coordinated per disease (lf-endemicity, oncho-endemicity, …); 'which districts are LF-endemic' is a single-code query
Binding: ICR Location Status (extensible)
... subject SΣ 1..1 Reference(ICR Location) The place this assertion is about (subject, not focus — the observation is fundamentally about the place). Typically the district / implementation unit; applies to its subtree unless overridden below
... focus Σ 0..* Reference(Resource) What the observation is about, when it is not about the subject of record
... encounter Σ 0..1 Reference(Encounter) Healthcare event during which this observation is made
... effective[x] SΣ 0..1 When the classification was assessed / holds from — open-ended: current until superseded
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effectiveTiming Timing
.... effectiveInstant instant
... issued Σ 0..1 instant Date/Time this version was made available
... performer SΣ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who asserted it: the MoH NTD programme, a mapping-survey team, an ESPEN/JRSM extract
... value[x] SΣC 0..1 CodeableConcept The classification — the JRSM ladder for the endemicity codes; future property codes bring their own vocabularies (hence extensible)
Binding: ICR Endemicity Status (extensible)
... dataAbsentReason C 0..1 CodeableConcept Why the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
... note 0..* Annotation Comments about the observation
... bodySite 0..1 CodeableConcept Observed body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
... method S 0..1 CodeableConcept How it was determined: mapping survey, TAS, sentinel site, administrative report
Binding: ObservationMethods (example): Methods for simple observations.
... specimen 0..1 Reference(Specimen) Specimen used for this observation
... device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
... referenceRange C 0..* BackboneElement Provides guide for interpretation
Constraints: obs-3
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... low C 0..1 SimpleQuantity(4.0.1) Low Range, if relevant
.... high C 0..1 SimpleQuantity(4.0.1) High Range, if relevant
.... type 0..1 CodeableConcept Reference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
.... appliesTo 0..* CodeableConcept Reference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
.... age 0..1 Range Applicable age range, if relevant
.... text 0..1 string Text based reference range in an observation
... hasMember Σ 0..* Reference(Observation | QuestionnaireResponse | MolecularSequence) Related resource that belongs to the Observation group
... derivedFrom SΣ 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) The evidentiary trail — the mapping-survey form response or source document
... component Σ 0..* BackboneElement Component results
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
.... value[x] Σ 0..1 Actual component result
..... valueQuantity Quantity
..... valueCodeableConcept CodeableConcept
..... valueString string
..... valueBoolean boolean
..... valueInteger integer
..... valueRange Range
..... valueRatio Ratio
..... valueSampledData SampledData
..... valueTime time
..... valueDateTime dateTime
..... valuePeriod Period
.... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
.... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
.... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.category Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
Observation.code Base extensible ICR Location Status 📦0.1.0 This IG
Observation.value[x] Base extensible ICR Endemicity Status 📦0.1.0 This IG
Observation.dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.
Observation.method Base example Observation Methods 📍4.0.1 FHIR Std.
Observation.referenceRange.​type Base preferred Observation Reference Range Meaning Codes 📍4.0.1 FHIR Std.
Observation.referenceRange.​appliesTo Base example Observation Reference Range Applies To Codes 📍4.0.1 FHIR Std.
Observation.component.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from Observation

Summary

Mandatory: 1 element
Must-Support: 8 elements

Structures

This structure refers to these other structures:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* Observation Measurements and simple assertions
Constraints: obs-6, obs-7
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!SΣ 1..1 code final; a newer final or amended assertion supersedes — read the latest per (subject, code)
Binding: ObservationStatus (required): Codes providing the status of an observation.
... subject SΣ 1..1 Reference(ICR Location) The place this assertion is about (subject, not focus — the observation is fundamentally about the place). Typically the district / implementation unit; applies to its subtree unless overridden below
... effective[x] SΣ 0..1 When the classification was assessed / holds from — open-ended: current until superseded
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effectiveTiming Timing
.... effectiveInstant instant
... performer SΣ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who asserted it: the MoH NTD programme, a mapping-survey team, an ESPEN/JRSM extract
... value[x] SΣC 0..1 CodeableConcept The classification — the JRSM ladder for the endemicity codes; future property codes bring their own vocabularies (hence extensible)
Binding: ICR Endemicity Status (extensible)
... method S 0..1 CodeableConcept How it was determined: mapping survey, TAS, sentinel site, administrative report
Binding: ObservationMethods (example): Methods for simple observations.
... derivedFrom SΣ 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) The evidentiary trail — the mapping-survey form response or source document

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.code Base extensible ICR Location Status 📦0.1.0 This IG
Observation.value[x] Base extensible ICR Endemicity Status 📦0.1.0 This IG
Observation.method Base example Observation Methods 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

Differential View

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation 0..* Observation Measurements and simple assertions
... status S 1..1 code final; a newer final or amended assertion supersedes — read the latest per (subject, code)
... code S 1..1 CodeableConcept The property asserted — pre-coordinated per disease (lf-endemicity, oncho-endemicity, …); 'which districts are LF-endemic' is a single-code query
Binding: ICR Location Status (extensible)
... subject S 1..1 Reference(ICR Location) The place this assertion is about (subject, not focus — the observation is fundamentally about the place). Typically the district / implementation unit; applies to its subtree unless overridden below
... performer S 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who asserted it: the MoH NTD programme, a mapping-survey team, an ESPEN/JRSM extract
... value[x] S 0..1 CodeableConcept The classification — the JRSM ladder for the endemicity codes; future property codes bring their own vocabularies (hence extensible)
Binding: ICR Endemicity Status (extensible)
... method S 0..1 CodeableConcept How it was determined: mapping survey, TAS, sentinel site, administrative report
... derivedFrom S 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) The evidentiary trail — the mapping-survey form response or source document

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Observation.code Base extensible ICR Location Status 📦0.1.0 This IG
Observation.value[x] Base extensible ICR Endemicity Status 📦0.1.0 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* Observation Measurements and simple assertions
Constraints: obs-6, obs-7
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business Identifier for observation
... basedOn Σ 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Fulfills plan, proposal or order
... partOf Σ 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Part of referenced event
... status ?!SΣ 1..1 code final; a newer final or amended assertion supersedes — read the latest per (subject, code)
Binding: ObservationStatus (required): Codes providing the status of an observation.
... category 0..* CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
... code SΣ 1..1 CodeableConcept The property asserted — pre-coordinated per disease (lf-endemicity, oncho-endemicity, …); 'which districts are LF-endemic' is a single-code query
Binding: ICR Location Status (extensible)
... subject SΣ 1..1 Reference(ICR Location) The place this assertion is about (subject, not focus — the observation is fundamentally about the place). Typically the district / implementation unit; applies to its subtree unless overridden below
... focus Σ 0..* Reference(Resource) What the observation is about, when it is not about the subject of record
... encounter Σ 0..1 Reference(Encounter) Healthcare event during which this observation is made
... effective[x] SΣ 0..1 When the classification was assessed / holds from — open-ended: current until superseded
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effectiveTiming Timing
.... effectiveInstant instant
... issued Σ 0..1 instant Date/Time this version was made available
... performer SΣ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who asserted it: the MoH NTD programme, a mapping-survey team, an ESPEN/JRSM extract
... value[x] SΣC 0..1 CodeableConcept The classification — the JRSM ladder for the endemicity codes; future property codes bring their own vocabularies (hence extensible)
Binding: ICR Endemicity Status (extensible)
... dataAbsentReason C 0..1 CodeableConcept Why the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
... note 0..* Annotation Comments about the observation
... bodySite 0..1 CodeableConcept Observed body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
... method S 0..1 CodeableConcept How it was determined: mapping survey, TAS, sentinel site, administrative report
Binding: ObservationMethods (example): Methods for simple observations.
... specimen 0..1 Reference(Specimen) Specimen used for this observation
... device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
... referenceRange C 0..* BackboneElement Provides guide for interpretation
Constraints: obs-3
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... low C 0..1 SimpleQuantity(4.0.1) Low Range, if relevant
.... high C 0..1 SimpleQuantity(4.0.1) High Range, if relevant
.... type 0..1 CodeableConcept Reference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
.... appliesTo 0..* CodeableConcept Reference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
.... age 0..1 Range Applicable age range, if relevant
.... text 0..1 string Text based reference range in an observation
... hasMember Σ 0..* Reference(Observation | QuestionnaireResponse | MolecularSequence) Related resource that belongs to the Observation group
... derivedFrom SΣ 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) The evidentiary trail — the mapping-survey form response or source document
... component Σ 0..* BackboneElement Component results
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
.... value[x] Σ 0..1 Actual component result
..... valueQuantity Quantity
..... valueCodeableConcept CodeableConcept
..... valueString string
..... valueBoolean boolean
..... valueInteger integer
..... valueRange Range
..... valueRatio Ratio
..... valueSampledData SampledData
..... valueTime time
..... valueDateTime dateTime
..... valuePeriod Period
.... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
.... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
.... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.category Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
Observation.code Base extensible ICR Location Status 📦0.1.0 This IG
Observation.value[x] Base extensible ICR Endemicity Status 📦0.1.0 This IG
Observation.dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.
Observation.method Base example Observation Methods 📍4.0.1 FHIR Std.
Observation.referenceRange.​type Base preferred Observation Reference Range Meaning Codes 📍4.0.1 FHIR Std.
Observation.referenceRange.​appliesTo Base example Observation Reference Range Applies To Codes 📍4.0.1 FHIR Std.
Observation.component.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from Observation

Summary

Mandatory: 1 element
Must-Support: 8 elements

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron