NP Core Implementation Guide
1.0.0 - Release Nepal flag

NP Core Implementation Guide - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Extension: Bikram Sambat Date

Official URL: http://fhir.digitalhealth.gov.np/core/StructureDefinition/np-core-bikram-sambat-date Version: 1.0.0
Active as of 2026-10-14 Computable Name: NPCoreBikramSambatDate

Carries the original Bikram Sambat (BS) date captured by the source system, as a numeric string in YYYY, YYYY-MM or YYYY-MM-DD form. It may be used on any date or dateTime element; it is deliberately not available on instant, which records a machine timestamp rather than a calendar date a person entered. The Gregorian (AD) element this extension is attached to remains the value of record; this extension only preserves the original BS capture for display and audit. FHIR cannot validate agreement between the two calendars, so keeping the BS value consistent with the Gregorian value is the responsibility of the capturing system. Populate this extension only where a faithful Bikram Sambat capture exists; never derive it and never use it in place of the Gregorian value. The precision of the BS value SHOULD match the precision of the Gregorian element, since a year-only birth year is a common and legitimate capture for elderly patients. There is deliberately no separate Bikram Sambat dateTime form: Bikram Sambat is a calendar with no time component, so on elements that carry a dateTime this extension records only the BS calendar date and the time of day lives solely in the Gregorian value. Where the Gregorian value carries a time, the BS date SHALL correspond to the Asia/Kathmandu local date of that instant rather than its UTC date, because the two can fall on different days across midnight.

Context of Use

    This extension may be used on the following element(s)

Usage info

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Extension Content

Description Differentials, Snapshots, and other representations.

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Extension 0..* Extension Bikram Sambat Date
Extension.extension 0..0 Extension
Extension.url 1..1 uri "http://fhir.digitalhealth.gov.np/core/StructureDefinition/np-core-bikram-sambat-date"
Extension.value[x] C 1..1 string Original Bikram Sambat date as YYYY, YYYY-MM or YYYY-MM-DD
Constraints: np-bs-1

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
np-bs-1 error Extension.value[x] A Bikram Sambat date SHALL be a numeric string in YYYY, YYYY-MM or YYYY-MM-DD form. Days run to 32 because Bikram Sambat months vary between 29 and 32 days. $this.matches('^[12][0-9]{3}(-(0[1-9]|1[0-2])(-(0[1-9]|[12][0-9]|3[0-2]))?)?$')
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Extension 0..* Extension Bikram Sambat Date
Extension.id 0..1 string Unique id for inter-element referencing
Extension.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.url 1..1 uri "http://fhir.digitalhealth.gov.np/core/StructureDefinition/np-core-bikram-sambat-date"
Extension.value[x] C 1..1 string Original Bikram Sambat date as YYYY, YYYY-MM or YYYY-MM-DD
Constraints: np-bs-1

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
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()
np-bs-1 error Extension.value[x] A Bikram Sambat date SHALL be a numeric string in YYYY, YYYY-MM or YYYY-MM-DD form. Days run to 32 because Bikram Sambat months vary between 29 and 32 days. $this.matches('^[12][0-9]{3}(-(0[1-9]|1[0-2])(-(0[1-9]|[12][0-9]|3[0-2]))?)?$')

This structure is derived from Extension

Summary

Simple Extension with the type string: Carries the original Bikram Sambat (BS) date captured by the source system, as a numeric string in YYYY, YYYY-MM or YYYY-MM-DD form. It may be used on any date or dateTime element; it is deliberately not available on instant, which records a machine timestamp rather than a calendar date a person entered. The Gregorian (AD) element this extension is attached to remains the value of record; this extension only preserves the original BS capture for display and audit. FHIR cannot validate agreement between the two calendars, so keeping the BS value consistent with the Gregorian value is the responsibility of the capturing system. Populate this extension only where a faithful Bikram Sambat capture exists; never derive it and never use it in place of the Gregorian value. The precision of the BS value SHOULD match the precision of the Gregorian element, since a year-only birth year is a common and legitimate capture for elderly patients. There is deliberately no separate Bikram Sambat dateTime form: Bikram Sambat is a calendar with no time component, so on elements that carry a dateTime this extension records only the BS calendar date and the time of day lives solely in the Gregorian value. Where the Gregorian value carries a time, the BS date SHALL correspond to the Asia/Kathmandu local date of that instant rather than its UTC date, because the two can fall on different days across midnight.

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Extension 0..* Extension Bikram Sambat Date
Extension.extension 0..0 Extension
Extension.url 1..1 uri "http://fhir.digitalhealth.gov.np/core/StructureDefinition/np-core-bikram-sambat-date"
Extension.value[x] C 1..1 string Original Bikram Sambat date as YYYY, YYYY-MM or YYYY-MM-DD
Constraints: np-bs-1

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
np-bs-1 error Extension.value[x] A Bikram Sambat date SHALL be a numeric string in YYYY, YYYY-MM or YYYY-MM-DD form. Days run to 32 because Bikram Sambat months vary between 29 and 32 days. $this.matches('^[12][0-9]{3}(-(0[1-9]|1[0-2])(-(0[1-9]|[12][0-9]|3[0-2]))?)?$')

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Extension 0..* Extension Bikram Sambat Date
Extension.id 0..1 string Unique id for inter-element referencing
Extension.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.url 1..1 uri "http://fhir.digitalhealth.gov.np/core/StructureDefinition/np-core-bikram-sambat-date"
Extension.value[x] C 1..1 string Original Bikram Sambat date as YYYY, YYYY-MM or YYYY-MM-DD
Constraints: np-bs-1

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
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()
np-bs-1 error Extension.value[x] A Bikram Sambat date SHALL be a numeric string in YYYY, YYYY-MM or YYYY-MM-DD form. Days run to 32 because Bikram Sambat months vary between 29 and 32 days. $this.matches('^[12][0-9]{3}(-(0[1-9]|1[0-2])(-(0[1-9]|[12][0-9]|3[0-2]))?)?$')

This structure is derived from Extension

Summary

Simple Extension with the type string: Carries the original Bikram Sambat (BS) date captured by the source system, as a numeric string in YYYY, YYYY-MM or YYYY-MM-DD form. It may be used on any date or dateTime element; it is deliberately not available on instant, which records a machine timestamp rather than a calendar date a person entered. The Gregorian (AD) element this extension is attached to remains the value of record; this extension only preserves the original BS capture for display and audit. FHIR cannot validate agreement between the two calendars, so keeping the BS value consistent with the Gregorian value is the responsibility of the capturing system. Populate this extension only where a faithful Bikram Sambat capture exists; never derive it and never use it in place of the Gregorian value. The precision of the BS value SHOULD match the precision of the Gregorian element, since a year-only birth year is a common and legitimate capture for elderly patients. There is deliberately no separate Bikram Sambat dateTime form: Bikram Sambat is a calendar with no time component, so on elements that carry a dateTime this extension records only the BS calendar date and the time of day lives solely in the Gregorian value. Where the Gregorian value carries a time, the BS date SHALL correspond to the Asia/Kathmandu local date of that instant rather than its UTC date, because the two can fall on different days across midnight.

 

Other representations of profile: CSV, Excel, Schematron