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 Resource Estimate

Official URL: https://icr.healthcampaigns.org/StructureDefinition/ICRResourceEstimate Version: 0.1.0
Draft as of 2026-10-29 Computable Name: ICRResourceEstimate

A microplan's estimate of one resource for one area of a campaign — the number of nets, teams, team-days, supervisors, vehicles or cold-chain items — with the target populations it was computed from and its numeric assumptions (persons per net, buffer). Draft plans are preliminary, approved plans final.

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, icr-estimate-commodity-item
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:suppliedItem S 0..1 CodeableConcept The product, for commodity estimates; required when code = commodity (icr-estimate-commodity-item)
URL: https://icr.healthcampaigns.org/StructureDefinition/supplied-item
Binding: ICR Supplied Item (extensible)
.... extension:basis S 0..* Reference(ICR Target Population) The ICRTargetPopulation(s) the estimate was computed from. R4 derivedFrom cannot reference a Group
URL: https://icr.healthcampaigns.org/StructureDefinition/estimate-basis
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... basedOn SΣ 1..1 Reference(ICR Campaign) The campaign (microplan or round) the estimate belongs to
... status ?!SΣ 1..1 code preliminary while the plan is in draft; final once approved
Binding: ObservationStatus (required): Codes providing the status of an observation.
... code SΣ 1..1 CodeableConcept commodity | teams | team-days | supervisors | vehicles | cold-chain-equipment
Binding: ICR Resource Type (required)
... subject SΣ 1..1 Reference(ICR Location) The area the estimate is for — any level
... effective[x] SΣ 0..1 When the estimate was made
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effectiveTiming Timing
.... effectiveInstant instant
... performer SΣ 0..* Reference(Organization | ICR Care Team | Practitioner | PractitionerRole) The accountable team or organization. A planning tool is not a legal performer: it goes in device
... value[x] SΣC 1..1 Quantity The estimate, with a coded unit (system + code)
.... value SΣ 1..1 decimal Numerical value (with implicit precision)
.... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
.... system SΣC 1..1 uri System that defines coded unit form
.... code SΣ 1..1 code Coded form of the unit
... method S 0..1 CodeableConcept How the estimate was made (microplanning tool, manual)
Binding: ObservationMethods (example): Methods for simple observations.
... device S 0..1 Reference(Device) The planning tool, as a Device, where recorded
... derivedFrom SΣ 0..* Reference(DocumentReference) The source microplan file or configuration, where it is kept
... component SΣ 0..* BackboneElement One per numeric assumption, for example persons per net 1.8, buffer 10 %
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 CodeableConcept The assumption; text where the source has only a key
Binding: LOINCCodes (example): Codes identifying names of simple observations.
.... value[x] Σ 1..1 Quantity The assumed value, with a unit
..... value SΣ 1..1 decimal Numerical value (with implicit precision)
..... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
..... unit SΣ 1..1 string Unit representation

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 required ICR Resource Type 📦0.1.0 This IG
Observation.value[x].​comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
Observation.method Base example Observation Methods 📍4.0.1 FHIR Std.
Observation.component.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component.​value[x].comparator Base required QuantityComparator 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
icr-estimate-commodity-item error Observation A commodity estimate names its product in the supplied-item extension. code.coding.where(system = 'https://icr.healthcampaigns.org/CodeSystem/icr-resource-type-cs' and code = 'commodity').exists() implies extension('https://icr.healthcampaigns.org/StructureDefinition/supplied-item').exists()

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* Observation Measurements and simple assertions
Constraints: icr-estimate-commodity-item
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:suppliedItem S 0..1 CodeableConcept The product, for commodity estimates; required when code = commodity (icr-estimate-commodity-item)
URL: https://icr.healthcampaigns.org/StructureDefinition/supplied-item
Binding: ICR Supplied Item (extensible)
.... extension:basis S 0..* Reference(ICR Target Population) The ICRTargetPopulation(s) the estimate was computed from. R4 derivedFrom cannot reference a Group
URL: https://icr.healthcampaigns.org/StructureDefinition/estimate-basis
... identifier S 0..* Identifier The source plan and plan-row ids
... basedOn S 1..1 Reference(ICR Campaign) The campaign (microplan or round) the estimate belongs to
... code S 1..1 CodeableConcept commodity | teams | team-days | supervisors | vehicles | cold-chain-equipment
Binding: ICR Resource Type (required)
... subject S 1..1 Reference(ICR Location) The area the estimate is for — any level
... effective[x] S 0..1 dateTime, Period, Timing, instant When the estimate was made
... performer S 0..* Reference(Organization | ICR Care Team | Practitioner | PractitionerRole) The accountable team or organization. A planning tool is not a legal performer: it goes in device
... value[x] S 1..1 Quantity The estimate, with a coded unit (system + code)
.... value S 1..1 decimal Numerical value (with implicit precision)
.... system S 1..1 uri System that defines coded unit form
.... code S 1..1 code Coded form of the unit
... method S 0..1 CodeableConcept How the estimate was made (microplanning tool, manual)
... device S 0..1 Reference(Device) The planning tool, as a Device, where recorded
... derivedFrom S 0..* Reference(DocumentReference) The source microplan file or configuration, where it is kept
... component S 0..* BackboneElement One per numeric assumption, for example persons per net 1.8, buffer 10 %
.... code 1..1 CodeableConcept The assumption; text where the source has only a key
.... value[x] 1..1 Quantity The assumed value, with a unit
..... value S 1..1 decimal Numerical value (with implicit precision)
..... unit S 1..1 string Unit representation

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Observation.code Base required ICR Resource Type 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
icr-estimate-commodity-item error Observation A commodity estimate names its product in the supplied-item extension. code.coding.where(system = 'https://icr.healthcampaigns.org/CodeSystem/icr-resource-type-cs' and code = 'commodity').exists() implies extension('https://icr.healthcampaigns.org/StructureDefinition/supplied-item').exists()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* Observation Measurements and simple assertions
Constraints: obs-6, obs-7, icr-estimate-commodity-item
... 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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:suppliedItem S 0..1 CodeableConcept The product, for commodity estimates; required when code = commodity (icr-estimate-commodity-item)
URL: https://icr.healthcampaigns.org/StructureDefinition/supplied-item
Binding: ICR Supplied Item (extensible)
.... extension:basis S 0..* Reference(ICR Target Population) The ICRTargetPopulation(s) the estimate was computed from. R4 derivedFrom cannot reference a Group
URL: https://icr.healthcampaigns.org/StructureDefinition/estimate-basis
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier The source plan and plan-row ids
... basedOn SΣ 1..1 Reference(ICR Campaign) The campaign (microplan or round) the estimate belongs to
... partOf Σ 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Part of referenced event
... status ?!SΣ 1..1 code preliminary while the plan is in draft; final once approved
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 commodity | teams | team-days | supervisors | vehicles | cold-chain-equipment
Binding: ICR Resource Type (required)
... subject SΣ 1..1 Reference(ICR Location) The area the estimate is for — any level
... 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 estimate was made
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effectiveTiming Timing
.... effectiveInstant instant
... issued Σ 0..1 instant Date/Time this version was made available
... performer SΣ 0..* Reference(Organization | ICR Care Team | Practitioner | PractitionerRole) The accountable team or organization. A planning tool is not a legal performer: it goes in device
... value[x] SΣC 1..1 Quantity The estimate, with a coded unit (system + code)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value SΣ 1..1 decimal Numerical value (with implicit precision)
.... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
.... unit Σ 0..1 string Unit representation
.... system SΣC 1..1 uri System that defines coded unit form
.... code SΣ 1..1 code Coded form of the unit
... 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 the estimate was made (microplanning tool, manual)
Binding: ObservationMethods (example): Methods for simple observations.
... specimen 0..1 Reference(Specimen) Specimen used for this observation
... device S 0..1 Reference(Device) The planning tool, as a Device, where recorded
... 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) The source microplan file or configuration, where it is kept
... component SΣ 0..* BackboneElement One per numeric assumption, for example persons per net 1.8, buffer 10 %
.... 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 The assumption; text where the source has only a key
Binding: LOINCCodes (example): Codes identifying names of simple observations.
.... value[x] Σ 1..1 Quantity The assumed value, with a unit
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... value SΣ 1..1 decimal Numerical value (with implicit precision)
..... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
..... unit SΣ 1..1 string Unit representation
..... system ΣC 0..1 uri System that defines coded unit form
..... code Σ 0..1 code Coded form of the unit
.... 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 required ICR Resource Type 📦0.1.0 This IG
Observation.value[x].​comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
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.​value[x].comparator Base required QuantityComparator 📍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
icr-estimate-commodity-item error Observation A commodity estimate names its product in the supplied-item extension. code.coding.where(system = 'https://icr.healthcampaigns.org/CodeSystem/icr-resource-type-cs' and code = 'commodity').exists() implies extension('https://icr.healthcampaigns.org/StructureDefinition/supplied-item').exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* Observation Measurements and simple assertions
Constraints: obs-6, obs-7, icr-estimate-commodity-item
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:suppliedItem S 0..1 CodeableConcept The product, for commodity estimates; required when code = commodity (icr-estimate-commodity-item)
URL: https://icr.healthcampaigns.org/StructureDefinition/supplied-item
Binding: ICR Supplied Item (extensible)
.... extension:basis S 0..* Reference(ICR Target Population) The ICRTargetPopulation(s) the estimate was computed from. R4 derivedFrom cannot reference a Group
URL: https://icr.healthcampaigns.org/StructureDefinition/estimate-basis
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... basedOn SΣ 1..1 Reference(ICR Campaign) The campaign (microplan or round) the estimate belongs to
... status ?!SΣ 1..1 code preliminary while the plan is in draft; final once approved
Binding: ObservationStatus (required): Codes providing the status of an observation.
... code SΣ 1..1 CodeableConcept commodity | teams | team-days | supervisors | vehicles | cold-chain-equipment
Binding: ICR Resource Type (required)
... subject SΣ 1..1 Reference(ICR Location) The area the estimate is for — any level
... effective[x] SΣ 0..1 When the estimate was made
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effectiveTiming Timing
.... effectiveInstant instant
... performer SΣ 0..* Reference(Organization | ICR Care Team | Practitioner | PractitionerRole) The accountable team or organization. A planning tool is not a legal performer: it goes in device
... value[x] SΣC 1..1 Quantity The estimate, with a coded unit (system + code)
.... value SΣ 1..1 decimal Numerical value (with implicit precision)
.... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
.... system SΣC 1..1 uri System that defines coded unit form
.... code SΣ 1..1 code Coded form of the unit
... method S 0..1 CodeableConcept How the estimate was made (microplanning tool, manual)
Binding: ObservationMethods (example): Methods for simple observations.
... device S 0..1 Reference(Device) The planning tool, as a Device, where recorded
... derivedFrom SΣ 0..* Reference(DocumentReference) The source microplan file or configuration, where it is kept
... component SΣ 0..* BackboneElement One per numeric assumption, for example persons per net 1.8, buffer 10 %
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 CodeableConcept The assumption; text where the source has only a key
Binding: LOINCCodes (example): Codes identifying names of simple observations.
.... value[x] Σ 1..1 Quantity The assumed value, with a unit
..... value SΣ 1..1 decimal Numerical value (with implicit precision)
..... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
..... unit SΣ 1..1 string Unit representation

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 required ICR Resource Type 📦0.1.0 This IG
Observation.value[x].​comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
Observation.method Base example Observation Methods 📍4.0.1 FHIR Std.
Observation.component.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component.​value[x].comparator Base required QuantityComparator 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
icr-estimate-commodity-item error Observation A commodity estimate names its product in the supplied-item extension. code.coding.where(system = 'https://icr.healthcampaigns.org/CodeSystem/icr-resource-type-cs' and code = 'commodity').exists() implies extension('https://icr.healthcampaigns.org/StructureDefinition/supplied-item').exists()

Differential View

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* Observation Measurements and simple assertions
Constraints: icr-estimate-commodity-item
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:suppliedItem S 0..1 CodeableConcept The product, for commodity estimates; required when code = commodity (icr-estimate-commodity-item)
URL: https://icr.healthcampaigns.org/StructureDefinition/supplied-item
Binding: ICR Supplied Item (extensible)
.... extension:basis S 0..* Reference(ICR Target Population) The ICRTargetPopulation(s) the estimate was computed from. R4 derivedFrom cannot reference a Group
URL: https://icr.healthcampaigns.org/StructureDefinition/estimate-basis
... identifier S 0..* Identifier The source plan and plan-row ids
... basedOn S 1..1 Reference(ICR Campaign) The campaign (microplan or round) the estimate belongs to
... code S 1..1 CodeableConcept commodity | teams | team-days | supervisors | vehicles | cold-chain-equipment
Binding: ICR Resource Type (required)
... subject S 1..1 Reference(ICR Location) The area the estimate is for — any level
... effective[x] S 0..1 dateTime, Period, Timing, instant When the estimate was made
... performer S 0..* Reference(Organization | ICR Care Team | Practitioner | PractitionerRole) The accountable team or organization. A planning tool is not a legal performer: it goes in device
... value[x] S 1..1 Quantity The estimate, with a coded unit (system + code)
.... value S 1..1 decimal Numerical value (with implicit precision)
.... system S 1..1 uri System that defines coded unit form
.... code S 1..1 code Coded form of the unit
... method S 0..1 CodeableConcept How the estimate was made (microplanning tool, manual)
... device S 0..1 Reference(Device) The planning tool, as a Device, where recorded
... derivedFrom S 0..* Reference(DocumentReference) The source microplan file or configuration, where it is kept
... component S 0..* BackboneElement One per numeric assumption, for example persons per net 1.8, buffer 10 %
.... code 1..1 CodeableConcept The assumption; text where the source has only a key
.... value[x] 1..1 Quantity The assumed value, with a unit
..... value S 1..1 decimal Numerical value (with implicit precision)
..... unit S 1..1 string Unit representation

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Observation.code Base required ICR Resource Type 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
icr-estimate-commodity-item error Observation A commodity estimate names its product in the supplied-item extension. code.coding.where(system = 'https://icr.healthcampaigns.org/CodeSystem/icr-resource-type-cs' and code = 'commodity').exists() implies extension('https://icr.healthcampaigns.org/StructureDefinition/supplied-item').exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* Observation Measurements and simple assertions
Constraints: obs-6, obs-7, icr-estimate-commodity-item
... 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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:suppliedItem S 0..1 CodeableConcept The product, for commodity estimates; required when code = commodity (icr-estimate-commodity-item)
URL: https://icr.healthcampaigns.org/StructureDefinition/supplied-item
Binding: ICR Supplied Item (extensible)
.... extension:basis S 0..* Reference(ICR Target Population) The ICRTargetPopulation(s) the estimate was computed from. R4 derivedFrom cannot reference a Group
URL: https://icr.healthcampaigns.org/StructureDefinition/estimate-basis
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier The source plan and plan-row ids
... basedOn SΣ 1..1 Reference(ICR Campaign) The campaign (microplan or round) the estimate belongs to
... partOf Σ 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Part of referenced event
... status ?!SΣ 1..1 code preliminary while the plan is in draft; final once approved
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 commodity | teams | team-days | supervisors | vehicles | cold-chain-equipment
Binding: ICR Resource Type (required)
... subject SΣ 1..1 Reference(ICR Location) The area the estimate is for — any level
... 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 estimate was made
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effectiveTiming Timing
.... effectiveInstant instant
... issued Σ 0..1 instant Date/Time this version was made available
... performer SΣ 0..* Reference(Organization | ICR Care Team | Practitioner | PractitionerRole) The accountable team or organization. A planning tool is not a legal performer: it goes in device
... value[x] SΣC 1..1 Quantity The estimate, with a coded unit (system + code)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value SΣ 1..1 decimal Numerical value (with implicit precision)
.... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
.... unit Σ 0..1 string Unit representation
.... system SΣC 1..1 uri System that defines coded unit form
.... code SΣ 1..1 code Coded form of the unit
... 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 the estimate was made (microplanning tool, manual)
Binding: ObservationMethods (example): Methods for simple observations.
... specimen 0..1 Reference(Specimen) Specimen used for this observation
... device S 0..1 Reference(Device) The planning tool, as a Device, where recorded
... 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) The source microplan file or configuration, where it is kept
... component SΣ 0..* BackboneElement One per numeric assumption, for example persons per net 1.8, buffer 10 %
.... 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 The assumption; text where the source has only a key
Binding: LOINCCodes (example): Codes identifying names of simple observations.
.... value[x] Σ 1..1 Quantity The assumed value, with a unit
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... value SΣ 1..1 decimal Numerical value (with implicit precision)
..... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
..... unit SΣ 1..1 string Unit representation
..... system ΣC 0..1 uri System that defines coded unit form
..... code Σ 0..1 code Coded form of the unit
.... 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 required ICR Resource Type 📦0.1.0 This IG
Observation.value[x].​comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
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.​value[x].comparator Base required QuantityComparator 📍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
icr-estimate-commodity-item error Observation A commodity estimate names its product in the supplied-item extension. code.coding.where(system = 'https://icr.healthcampaigns.org/CodeSystem/icr-resource-type-cs' and code = 'commodity').exists() implies extension('https://icr.healthcampaigns.org/StructureDefinition/supplied-item').exists()

 

Other representations of profile: CSV, Excel, Schematron