Nepal HMIS FHIR Implementation Guide – 🚨 DRAFT VERSION
0.0.1-ballot - ci-build
Nepal HMIS FHIR Implementation Guide – 🚨 DRAFT VERSION
0.0.1-ballot - ci-build
Nepal HMIS FHIR Implementation Guide – 🚨 DRAFT VERSION - Local Development build (v0.0.1-ballot) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://fhir.hmis.gov.np/StructureDefinition/np-core-immunization | Version: 0.0.1-ballot | |||
| Active as of 2025-09-08 | Computable Name: NPCoreImmunizationProfile | |||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License |
||||
The NP Core Immunization Profile inherits from the FHIR Immunization resource; refer to it for scope and usage definitions. This profile sets minimum expectations for the Immunization resource to record, search, and fetch basic immunization information for an individual patient within the Nepal health system. It specifies which core elements, extensions, vocabularies, and value sets SHALL be present and constrains how the elements are used. By providing a standardized foundation for capturing immunization events in Nepal
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Immunization |
0..* | Immunization | Immunization event information | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained |
0..* | Resource | Contained, inline Resources | |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required) Required Pattern: completed |
 vaccineCode |
Σ | 1..1 | CodeableConcept | Vaccine administered Binding: Vaccines (SNOMED CT) (required) |
 patient |
Σ | 1..1 | Reference(NP Core Patient Profile) | Who was immunized |
  Slices for occurrence[x] |
Σ | 1..1 | dateTime | Vaccine administration date Slice: Unordered, Closed by type:$this |
   occurrence[x]:occurrenceDateTime |
Σ | 1..1 | dateTime | Vaccine administration date |
 isSubpotent |
?!Σ | 0..1 | boolean | Dose potency |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Immunization.status | required | Pattern Value: completedhttp://hl7.org/fhir/ValueSet/immunization-status|5.0.0From the FHIR Standard | |
| Immunization.vaccineCode | required | VaccineVShttps://fhir.hmis.gov.np/ValueSet/vaccineFrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Immunization | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Immunization | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Immunization
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Immunization |
0..* | Immunization | Immunization event information | |
 status |
1..1 | code | completed | entered-in-error | not-done Required Pattern: completed | |
| vaccineCode |
1..1 | CodeableConcept | Vaccine administered Binding: Vaccines (SNOMED CT) (required) | |
| patient |
1..1 | Reference(NP Core Patient Profile) | Who was immunized | |
 Slices for occurrence[x] |
1..1 | dateTime | Vaccine administration date Slice: Unordered, Open by type:$this | |
 occurrence[x]:occurrenceDateTime |
1..1 | dateTime | Vaccine administration date | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Immunization.vaccineCode | required | VaccineVShttps://fhir.hmis.gov.np/ValueSet/vaccineFrom this IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Immunization |
0..* | Immunization | Immunization event information | |||||
| 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: AllLanguages (required): IETF language tag for a human language
| |||||
| 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 | |||||
| basedOn |
Σ | 0..* | Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) | Authority that the immunization event is based on | ||||
| status |
?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required) Required Pattern: completed | ||||
| statusReason |
0..1 | CodeableConcept | Reason for current status Binding: ImmunizationStatusReasonCodes (example) | |||||
| vaccineCode |
Σ | 1..1 | CodeableConcept | Vaccine administered Binding: Vaccines (SNOMED CT) (required) | ||||
| administeredProduct |
0..1 | CodeableReference(Medication) | Product that was administered | |||||
| manufacturer |
0..1 | CodeableReference(Organization) | Vaccine manufacturer | |||||
| lotNumber |
0..1 | string | Vaccine lot number | |||||
| expirationDate |
0..1 | date | Vaccine expiration date | |||||
| patient |
Σ | 1..1 | Reference(NP Core Patient Profile) | Who was immunized | ||||
| encounter |
0..1 | Reference(Encounter) | Encounter immunization was part of | |||||
| supportingInformation |
0..* | Reference(Resource) | Additional information in support of the immunization | |||||
| Slices for occurrence[x] |
Σ | 1..1 | dateTime | Vaccine administration date Slice: Unordered, Closed by type:$this | ||||
| occurrence[x]:occurrenceDateTime |
Σ | 1..1 | dateTime | Vaccine administration date | ||||
| primarySource |
Σ | 0..1 | boolean | Indicates context the data was captured in | ||||
| informationSource |
0..1 | CodeableReference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | Indicates the source of a reported record Binding: ImmunizationOriginCodes (example) | |||||
| location |
0..1 | Reference(Location) | Where immunization occurred | |||||
| site |
0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example) | |||||
| route |
0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (example) | |||||
| doseQuantity |
0..1 | SimpleQuantity | Amount of vaccine administered | |||||
| performer |
Σ | 0..* | BackboneElement | Who performed event | ||||
| 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 | ||||
| function |
Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible) | ||||
| actor |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson) | Individual or organization who was performing | ||||
| note |
Σ | 0..* | Annotation | Additional immunization notes | ||||
| reason |
0..* | CodeableReference(Condition | Observation | DiagnosticReport) | Why immunization occurred Binding: ImmunizationReasonCodes (example) | |||||
| isSubpotent |
?!Σ | 0..1 | boolean | Dose potency | ||||
| subpotentReason |
0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. | |||||
| programEligibility |
0..* | BackboneElement | Patient eligibility for a specific vaccination program | |||||
| 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 | ||||
| program |
1..1 | CodeableConcept | The program that eligibility is declared for Binding: CodesForVaccineFundingPrograms (example) | |||||
| programStatus |
1..1 | CodeableConcept | The patient's eligibility status for the program Binding: ImmunizationProgramEligibility (example) | |||||
| fundingSource |
0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example) | |||||
| reaction |
0..* | BackboneElement | Details of a reaction that follows immunization | |||||
| 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 | ||||
| date |
0..1 | dateTime | When reaction started | |||||
| manifestation |
0..1 | CodeableReference(Observation) | Additional information on reaction | |||||
| reported |
0..1 | boolean | Indicates self-reported reaction | |||||
| protocolApplied |
0..* | BackboneElement | Protocol followed by the provider | |||||
| 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 | ||||
| series |
0..1 | string | Name of vaccine series | |||||
| authority |
0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |||||
| targetDisease |
0..* | CodeableConcept | Vaccine preventatable disease being targeted Binding: ImmunizationTargetDiseaseCodes (example) | |||||
| doseNumber |
1..1 | string | Dose number within series | |||||
| seriesDoses |
0..1 | string | Recommended number of doses for immunity | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI |
| Immunization.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0From the FHIR Standard | |
| Immunization.status | required | Pattern Value: completedhttp://hl7.org/fhir/ValueSet/immunization-status|5.0.0From the FHIR Standard | |
| Immunization.statusReason | example | ImmunizationStatusReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-status-reasonFrom the FHIR Standard | |
| Immunization.vaccineCode | required | VaccineVShttps://fhir.hmis.gov.np/ValueSet/vaccineFrom this IG | |
| Immunization.informationSource | example | ImmunizationOriginCodeshttp://hl7.org/fhir/ValueSet/immunization-originFrom the FHIR Standard | |
| Immunization.site | example | CodesForImmunizationSiteOfAdministrationhttp://hl7.org/fhir/ValueSet/immunization-siteFrom the FHIR Standard | |
| Immunization.route | example | ImmunizationRouteCodeshttp://hl7.org/fhir/ValueSet/immunization-routeFrom the FHIR Standard | |
| Immunization.performer.function | extensible | ImmunizationFunctionCodeshttp://hl7.org/fhir/ValueSet/immunization-functionFrom the FHIR Standard | |
| Immunization.reason | example | ImmunizationReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-reasonFrom the FHIR Standard | |
| Immunization.subpotentReason | example | ImmunizationSubpotentReasonhttp://hl7.org/fhir/ValueSet/immunization-subpotent-reasonFrom the FHIR Standard | |
| Immunization.programEligibility.program | example | CodesForVaccineFundingProgramshttp://hl7.org/fhir/ValueSet/immunization-vaccine-funding-programFrom the FHIR Standard | |
| Immunization.programEligibility.programStatus | example | ImmunizationProgramEligibilityhttp://hl7.org/fhir/ValueSet/immunization-program-eligibilityFrom the FHIR Standard | |
| Immunization.fundingSource | example | ImmunizationFundingSourcehttp://hl7.org/fhir/ValueSet/immunization-funding-sourceFrom the FHIR Standard | |
| Immunization.protocolApplied.targetDisease | example | ImmunizationTargetDiseaseCodeshttp://hl7.org/fhir/ValueSet/immunization-target-diseaseFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Immunization | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Immunization | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Immunization
Summary
Mandatory: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Immunization |
0..* | Immunization | Immunization event information | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained |
0..* | Resource | Contained, inline Resources | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required) Required Pattern: completed |
| vaccineCode |
Σ | 1..1 | CodeableConcept | Vaccine administered Binding: Vaccines (SNOMED CT) (required) |
| patient |
Σ | 1..1 | Reference(NP Core Patient Profile) | Who was immunized |
| Slices for occurrence[x] |
Σ | 1..1 | dateTime | Vaccine administration date Slice: Unordered, Closed by type:$this |
| occurrence[x]:occurrenceDateTime |
Σ | 1..1 | dateTime | Vaccine administration date |
| isSubpotent |
?!Σ | 0..1 | boolean | Dose potency |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Immunization.status | required | Pattern Value: completedhttp://hl7.org/fhir/ValueSet/immunization-status|5.0.0From the FHIR Standard | |
| Immunization.vaccineCode | required | VaccineVShttps://fhir.hmis.gov.np/ValueSet/vaccineFrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Immunization | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Immunization | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Differential View
This structure is derived from Immunization
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Immunization |
0..* | Immunization | Immunization event information | |
| status |
1..1 | code | completed | entered-in-error | not-done Required Pattern: completed | |
| vaccineCode |
1..1 | CodeableConcept | Vaccine administered Binding: Vaccines (SNOMED CT) (required) | |
| patient |
1..1 | Reference(NP Core Patient Profile) | Who was immunized | |
| Slices for occurrence[x] |
1..1 | dateTime | Vaccine administration date Slice: Unordered, Open by type:$this | |
| occurrence[x]:occurrenceDateTime |
1..1 | dateTime | Vaccine administration date | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Immunization.vaccineCode | required | VaccineVShttps://fhir.hmis.gov.np/ValueSet/vaccineFrom this IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Immunization |
0..* | Immunization | Immunization event information | |||||
| 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: AllLanguages (required): IETF language tag for a human language
| |||||
| 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 | |||||
| basedOn |
Σ | 0..* | Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) | Authority that the immunization event is based on | ||||
| status |
?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required) Required Pattern: completed | ||||
| statusReason |
0..1 | CodeableConcept | Reason for current status Binding: ImmunizationStatusReasonCodes (example) | |||||
| vaccineCode |
Σ | 1..1 | CodeableConcept | Vaccine administered Binding: Vaccines (SNOMED CT) (required) | ||||
| administeredProduct |
0..1 | CodeableReference(Medication) | Product that was administered | |||||
| manufacturer |
0..1 | CodeableReference(Organization) | Vaccine manufacturer | |||||
| lotNumber |
0..1 | string | Vaccine lot number | |||||
| expirationDate |
0..1 | date | Vaccine expiration date | |||||
| patient |
Σ | 1..1 | Reference(NP Core Patient Profile) | Who was immunized | ||||
| encounter |
0..1 | Reference(Encounter) | Encounter immunization was part of | |||||
| supportingInformation |
0..* | Reference(Resource) | Additional information in support of the immunization | |||||
| Slices for occurrence[x] |
Σ | 1..1 | dateTime | Vaccine administration date Slice: Unordered, Closed by type:$this | ||||
| occurrence[x]:occurrenceDateTime |
Σ | 1..1 | dateTime | Vaccine administration date | ||||
| primarySource |
Σ | 0..1 | boolean | Indicates context the data was captured in | ||||
| informationSource |
0..1 | CodeableReference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | Indicates the source of a reported record Binding: ImmunizationOriginCodes (example) | |||||
| location |
0..1 | Reference(Location) | Where immunization occurred | |||||
| site |
0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example) | |||||
| route |
0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (example) | |||||
| doseQuantity |
0..1 | SimpleQuantity | Amount of vaccine administered | |||||
| performer |
Σ | 0..* | BackboneElement | Who performed event | ||||
| 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 | ||||
| function |
Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible) | ||||
| actor |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson) | Individual or organization who was performing | ||||
| note |
Σ | 0..* | Annotation | Additional immunization notes | ||||
| reason |
0..* | CodeableReference(Condition | Observation | DiagnosticReport) | Why immunization occurred Binding: ImmunizationReasonCodes (example) | |||||
| isSubpotent |
?!Σ | 0..1 | boolean | Dose potency | ||||
| subpotentReason |
0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. | |||||
| programEligibility |
0..* | BackboneElement | Patient eligibility for a specific vaccination program | |||||
| 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 | ||||
| program |
1..1 | CodeableConcept | The program that eligibility is declared for Binding: CodesForVaccineFundingPrograms (example) | |||||
| programStatus |
1..1 | CodeableConcept | The patient's eligibility status for the program Binding: ImmunizationProgramEligibility (example) | |||||
| fundingSource |
0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example) | |||||
| reaction |
0..* | BackboneElement | Details of a reaction that follows immunization | |||||
| 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 | ||||
| date |
0..1 | dateTime | When reaction started | |||||
| manifestation |
0..1 | CodeableReference(Observation) | Additional information on reaction | |||||
| reported |
0..1 | boolean | Indicates self-reported reaction | |||||
| protocolApplied |
0..* | BackboneElement | Protocol followed by the provider | |||||
| 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 | ||||
| series |
0..1 | string | Name of vaccine series | |||||
| authority |
0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |||||
| targetDisease |
0..* | CodeableConcept | Vaccine preventatable disease being targeted Binding: ImmunizationTargetDiseaseCodes (example) | |||||
| doseNumber |
1..1 | string | Dose number within series | |||||
| seriesDoses |
0..1 | string | Recommended number of doses for immunity | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI |
| Immunization.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0From the FHIR Standard | |
| Immunization.status | required | Pattern Value: completedhttp://hl7.org/fhir/ValueSet/immunization-status|5.0.0From the FHIR Standard | |
| Immunization.statusReason | example | ImmunizationStatusReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-status-reasonFrom the FHIR Standard | |
| Immunization.vaccineCode | required | VaccineVShttps://fhir.hmis.gov.np/ValueSet/vaccineFrom this IG | |
| Immunization.informationSource | example | ImmunizationOriginCodeshttp://hl7.org/fhir/ValueSet/immunization-originFrom the FHIR Standard | |
| Immunization.site | example | CodesForImmunizationSiteOfAdministrationhttp://hl7.org/fhir/ValueSet/immunization-siteFrom the FHIR Standard | |
| Immunization.route | example | ImmunizationRouteCodeshttp://hl7.org/fhir/ValueSet/immunization-routeFrom the FHIR Standard | |
| Immunization.performer.function | extensible | ImmunizationFunctionCodeshttp://hl7.org/fhir/ValueSet/immunization-functionFrom the FHIR Standard | |
| Immunization.reason | example | ImmunizationReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-reasonFrom the FHIR Standard | |
| Immunization.subpotentReason | example | ImmunizationSubpotentReasonhttp://hl7.org/fhir/ValueSet/immunization-subpotent-reasonFrom the FHIR Standard | |
| Immunization.programEligibility.program | example | CodesForVaccineFundingProgramshttp://hl7.org/fhir/ValueSet/immunization-vaccine-funding-programFrom the FHIR Standard | |
| Immunization.programEligibility.programStatus | example | ImmunizationProgramEligibilityhttp://hl7.org/fhir/ValueSet/immunization-program-eligibilityFrom the FHIR Standard | |
| Immunization.fundingSource | example | ImmunizationFundingSourcehttp://hl7.org/fhir/ValueSet/immunization-funding-sourceFrom the FHIR Standard | |
| Immunization.protocolApplied.targetDisease | example | ImmunizationTargetDiseaseCodeshttp://hl7.org/fhir/ValueSet/immunization-target-diseaseFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Immunization | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Immunization | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Immunization
Summary
Mandatory: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron