Nigeria Immunization FHIR IG
0.1.0 - ci-build Nigeria flag

Nigeria Immunization FHIR IG, published by intellisoftkenya.com. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IntelliSOFT-Consulting/Nigeria-Immunization-FHIR-IG/ and changes regularly. See the Directory of published versions

Resource Profile: DetectedIssue Profile - NEIR

Official URL: http://nhin.example.ng/StructureDefinition/NEIRDetectedIssue Version: 0.1.0
Draft as of 2025-08-11 Computable Name: NEIRDetectedIssue

This profile constrains the DetectedIssue resource to represent immunization-related issues within the National Electronic Immunization Registry (NEIR), such as contraindications, missed doses, duplicate records, or adverse events, supporting safe and effective vaccination delivery.

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
.. DetectedIssue 0..* DetectedIssue Clinical issue with action
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..1 Identifier Unique id for the detected issue
... code SΣ 1..1 CodeableConcept Issue Category, e.g. drug-drug, duplicate therapy, etc.
Binding: IMMZ.D.DE11 ValueSet for Contraindications (required)
... patient SΣ 1..1 Reference(Patient Profile - NEIR) Associated patient

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
DetectedIssue.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status|4.0.1
From the FHIR Standard
DetectedIssue.coderequiredIMMZDContraindications
http://nhin.example.ng/ValueSet/IMMZDContraindications
From this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDetectedIssueIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDetectedIssueIf 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-4errorDetectedIssueIf 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-5errorDetectedIssueIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDetectedIssueA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from DetectedIssue

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DetectedIssue DetectedIssue
... identifier S 0..1 Identifier Unique id for the detected issue
... status S 1..1 code registered | preliminary | final | amended +
... code S 1..1 CodeableConcept Issue Category, e.g. drug-drug, duplicate therapy, etc.
Binding: IMMZ.D.DE11 ValueSet for Contraindications (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
DetectedIssue.coderequiredIMMZDContraindications
http://nhin.example.ng/ValueSet/IMMZDContraindications
From this IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DetectedIssue 0..* DetectedIssue Clinical issue with action
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..1 Identifier Unique id for the detected issue
... status ?!SΣ 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required): Indicates the status of the identified issue.
... code SΣ 1..1 CodeableConcept Issue Category, e.g. drug-drug, duplicate therapy, etc.
Binding: IMMZ.D.DE11 ValueSet for Contraindications (required)
... severity Σ 0..1 code high | moderate | low
Binding: DetectedIssueSeverity (required): Indicates the potential degree of impact of the identified issue on the patient.
... patient SΣ 1..1 Reference(Patient Profile - NEIR) Associated patient
... identified[x] Σ 0..1 When identified
.... identifiedDateTime dateTime
.... identifiedPeriod Period
... author Σ 0..1 Reference(Practitioner | PractitionerRole | Device) The provider or device that identified the issue
... implicated Σ 0..* Reference(Resource) Problem resource
... evidence 0..* BackboneElement Supporting evidence
.... 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 0..* CodeableConcept Manifestation
Binding: ManifestationAndSymptomCodes (example): Codes that describes the types of evidence for a detected issue.
.... detail 0..* Reference(Resource) Supporting information
... detail 0..1 string Description and context
... reference 0..1 uri Authority for issue
... mitigation 0..* BackboneElement Step taken to address
.... 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
.... action 1..1 CodeableConcept What mitigation?
Binding: DetectedIssueMitigationAction (preferred): Codes describing steps taken to resolve the issue or other circumstances that mitigate the risk associated with the issue; e.g. 'added concurrent therapy', 'prior therapy documented', etc.
.... date 0..1 dateTime Date committed
.... author 0..1 Reference(Practitioner | PractitionerRole) Who is committing?

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
DetectedIssue.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
DetectedIssue.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status|4.0.1
From the FHIR Standard
DetectedIssue.coderequiredIMMZDContraindications
http://nhin.example.ng/ValueSet/IMMZDContraindications
From this IG
DetectedIssue.severityrequiredDetectedIssueSeverity
http://hl7.org/fhir/ValueSet/detectedissue-severity|4.0.1
From the FHIR Standard
DetectedIssue.evidence.codeexampleManifestationAndSymptomCodes
http://hl7.org/fhir/ValueSet/manifestation-or-symptom
From the FHIR Standard
DetectedIssue.mitigation.actionpreferredDetectedIssueMitigationAction
http://hl7.org/fhir/ValueSet/detectedissue-mitigation-action
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDetectedIssueIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDetectedIssueIf 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-4errorDetectedIssueIf 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-5errorDetectedIssueIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDetectedIssueA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from DetectedIssue

Summary

Mandatory: 2 elements
Must-Support: 4 elements

Structures

This structure refers to these other structures:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DetectedIssue 0..* DetectedIssue Clinical issue with action
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..1 Identifier Unique id for the detected issue
... code SΣ 1..1 CodeableConcept Issue Category, e.g. drug-drug, duplicate therapy, etc.
Binding: IMMZ.D.DE11 ValueSet for Contraindications (required)
... patient SΣ 1..1 Reference(Patient Profile - NEIR) Associated patient

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
DetectedIssue.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status|4.0.1
From the FHIR Standard
DetectedIssue.coderequiredIMMZDContraindications
http://nhin.example.ng/ValueSet/IMMZDContraindications
From this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDetectedIssueIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDetectedIssueIf 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-4errorDetectedIssueIf 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-5errorDetectedIssueIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDetectedIssueA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from DetectedIssue

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DetectedIssue DetectedIssue
... identifier S 0..1 Identifier Unique id for the detected issue
... status S 1..1 code registered | preliminary | final | amended +
... code S 1..1 CodeableConcept Issue Category, e.g. drug-drug, duplicate therapy, etc.
Binding: IMMZ.D.DE11 ValueSet for Contraindications (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
DetectedIssue.coderequiredIMMZDContraindications
http://nhin.example.ng/ValueSet/IMMZDContraindications
From this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DetectedIssue 0..* DetectedIssue Clinical issue with action
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..1 Identifier Unique id for the detected issue
... status ?!SΣ 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required): Indicates the status of the identified issue.
... code SΣ 1..1 CodeableConcept Issue Category, e.g. drug-drug, duplicate therapy, etc.
Binding: IMMZ.D.DE11 ValueSet for Contraindications (required)
... severity Σ 0..1 code high | moderate | low
Binding: DetectedIssueSeverity (required): Indicates the potential degree of impact of the identified issue on the patient.
... patient SΣ 1..1 Reference(Patient Profile - NEIR) Associated patient
... identified[x] Σ 0..1 When identified
.... identifiedDateTime dateTime
.... identifiedPeriod Period
... author Σ 0..1 Reference(Practitioner | PractitionerRole | Device) The provider or device that identified the issue
... implicated Σ 0..* Reference(Resource) Problem resource
... evidence 0..* BackboneElement Supporting evidence
.... 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 0..* CodeableConcept Manifestation
Binding: ManifestationAndSymptomCodes (example): Codes that describes the types of evidence for a detected issue.
.... detail 0..* Reference(Resource) Supporting information
... detail 0..1 string Description and context
... reference 0..1 uri Authority for issue
... mitigation 0..* BackboneElement Step taken to address
.... 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
.... action 1..1 CodeableConcept What mitigation?
Binding: DetectedIssueMitigationAction (preferred): Codes describing steps taken to resolve the issue or other circumstances that mitigate the risk associated with the issue; e.g. 'added concurrent therapy', 'prior therapy documented', etc.
.... date 0..1 dateTime Date committed
.... author 0..1 Reference(Practitioner | PractitionerRole) Who is committing?

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
DetectedIssue.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
DetectedIssue.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status|4.0.1
From the FHIR Standard
DetectedIssue.coderequiredIMMZDContraindications
http://nhin.example.ng/ValueSet/IMMZDContraindications
From this IG
DetectedIssue.severityrequiredDetectedIssueSeverity
http://hl7.org/fhir/ValueSet/detectedissue-severity|4.0.1
From the FHIR Standard
DetectedIssue.evidence.codeexampleManifestationAndSymptomCodes
http://hl7.org/fhir/ValueSet/manifestation-or-symptom
From the FHIR Standard
DetectedIssue.mitigation.actionpreferredDetectedIssueMitigationAction
http://hl7.org/fhir/ValueSet/detectedissue-mitigation-action
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDetectedIssueIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDetectedIssueIf 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-4errorDetectedIssueIf 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-5errorDetectedIssueIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDetectedIssueA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from DetectedIssue

Summary

Mandatory: 2 elements
Must-Support: 4 elements

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron