openIMIS FHIR R4 Implementation Guide
1.0.0 - ci-build
openIMIS FHIR R4 Implementation Guide
1.0.0 - ci-build
openIMIS FHIR R4 Implementation Guide - Local Development build (v1.0.0). See the Directory of published versions
| Official URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/medication-frequency | Version: 1.0.0 | |||
| Active as of 2022-05-31 | Responsible: openIMIS Initiative | Computable Name: MedicationFrequencyExtension | ||
The frequency a Medication can be prescribed.
Context of Use
This extension may be used on the following element(s):
Usage info
Usage:
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Extension | 0..* | Extension | Frequency (Medication) | |
  extension | 0..0 | |||
| url | 1..1 | uri | "https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/medication-frequency" | |
 value[x] | 0..1 | Timing | Value of extension Slice: Unordered, Open by type:$this | |
 valueTiming | 0..1 | Timing | Value of extension | |
 repeat | ||||
| frequency | 1..1 | positiveInt | Event occurs frequency times per period Required Pattern: 1 | |
| period | 1..1 | decimal | Frequency (days) | |
 periodUnit | 1..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Required Pattern: d | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension | 0..* | Extension | Frequency (Medication) | |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/medication-frequency" | |
| Slices for value[x] | 0..1 | Timing | Value of extension Slice: Unordered, Closed by type:$this | |
  value[x]:valueTiming | 0..1 | Timing | Value of extension | |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| event | Σ | 0..* | dateTime | When the event occurs |
 repeat | ΣI | 0..1 | Element | When the event is to occur |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
  bounds[x] | Σ | 0..1 | Length/Range of lengths, or (Start and/or end) limits | |
  boundsDuration | Duration | |||
| boundsRange | Range | |||
| boundsPeriod | Period | |||
| count | Σ | 0..1 | positiveInt | Number of times to repeat |
| countMax | Σ | 0..1 | positiveInt | Maximum number of times to repeat |
| duration | Σ | 0..1 | decimal | How long when it happens |
| durationMax | Σ | 0..1 | decimal | How long when it happens (Max) |
| durationUnit | Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). |
| frequency | Σ | 1..1 | positiveInt | Event occurs frequency times per period Required Pattern: 1 |
| frequencyMax | Σ | 0..1 | positiveInt | Event occurs up to frequencyMax times per period |
| period | Σ | 1..1 | decimal | Frequency (days) |
| periodMax | Σ | 0..1 | decimal | Upper limit of period (3-4 hours) |
| periodUnit | Σ | 1..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). Required Pattern: d |
| dayOfWeek | Σ | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) |
| timeOfDay | Σ | 0..* | time | Time of day for action |
| when | Σ | 0..* | code | Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule. |
| offset | Σ | 0..1 | unsignedInt | Minutes from event (before or after) |
 code | Σ | 0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | + Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern. |
| Documentation for this format | ||||
This structure is derived from Extension
Summary
Mandatory: 0 element (3 nested mandatory elements)
Fixed Value: 1 element
Prohibited: 1 element
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension | 0..* | Extension | Frequency (Medication) | |
| extension | 0..0 | |||
| url | 1..1 | uri | "https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/medication-frequency" | |
| value[x] | 0..1 | Timing | Value of extension Slice: Unordered, Open by type:$this | |
| valueTiming | 0..1 | Timing | Value of extension | |
| repeat | ||||
| frequency | 1..1 | positiveInt | Event occurs frequency times per period Required Pattern: 1 | |
| period | 1..1 | decimal | Frequency (days) | |
| periodUnit | 1..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Required Pattern: d | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension | 0..* | Extension | Frequency (Medication) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/medication-frequency" | |
| Slices for value[x] | 0..1 | Timing | Value of extension Slice: Unordered, Closed by type:$this | |
| value[x]:valueTiming | 0..1 | Timing | Value of extension | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| event | Σ | 0..* | dateTime | When the event occurs |
| repeat | ΣI | 0..1 | Element | When the event is to occur |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| bounds[x] | Σ | 0..1 | Length/Range of lengths, or (Start and/or end) limits | |
| boundsDuration | Duration | |||
| boundsRange | Range | |||
| boundsPeriod | Period | |||
| count | Σ | 0..1 | positiveInt | Number of times to repeat |
| countMax | Σ | 0..1 | positiveInt | Maximum number of times to repeat |
| duration | Σ | 0..1 | decimal | How long when it happens |
| durationMax | Σ | 0..1 | decimal | How long when it happens (Max) |
| durationUnit | Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). |
| frequency | Σ | 1..1 | positiveInt | Event occurs frequency times per period Required Pattern: 1 |
| frequencyMax | Σ | 0..1 | positiveInt | Event occurs up to frequencyMax times per period |
| period | Σ | 1..1 | decimal | Frequency (days) |
| periodMax | Σ | 0..1 | decimal | Upper limit of period (3-4 hours) |
| periodUnit | Σ | 1..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). Required Pattern: d |
| dayOfWeek | Σ | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) |
| timeOfDay | Σ | 0..* | time | Time of day for action |
| when | Σ | 0..* | code | Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule. |
| offset | Σ | 0..1 | unsignedInt | Minutes from event (before or after) |
| code | Σ | 0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | + Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern. |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet / Code |
| Extension.value[x]:valueTiming.repeat.durationUnit | required | UnitsOfTime |
| Extension.value[x]:valueTiming.repeat.periodUnit | required | Pattern: d |
| Extension.value[x]:valueTiming.repeat.dayOfWeek | required | DaysOfWeek |
| Extension.value[x]:valueTiming.repeat.when | required | EventTiming |
| Extension.value[x]:valueTiming.code | preferred | TimingAbbreviation |
| Id | Grade | Path | Details | Requirements |
| ele-1 | error | Extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Extension.value[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Extension.value[x]:valueTiming | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Extension.value[x]:valueTiming.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Extension.value[x]:valueTiming.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Extension.value[x]:valueTiming.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Extension.value[x]:valueTiming.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Extension.value[x]:valueTiming.event | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Extension.value[x]:valueTiming.repeat | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| tim-1 | error | Extension.value[x]:valueTiming.repeat | if there's a duration, there needs to be duration units : duration.empty() or durationUnit.exists() | |
| tim-2 | error | Extension.value[x]:valueTiming.repeat | if there's a period, there needs to be period units : period.empty() or periodUnit.exists() | |
| tim-4 | error | Extension.value[x]:valueTiming.repeat | duration SHALL be a non-negative value : duration.exists() implies duration >= 0 | |
| tim-5 | error | Extension.value[x]:valueTiming.repeat | period SHALL be a non-negative value : period.exists() implies period >= 0 | |
| tim-6 | error | Extension.value[x]:valueTiming.repeat | If there's a periodMax, there must be a period : periodMax.empty() or period.exists() | |
| tim-7 | error | Extension.value[x]:valueTiming.repeat | If there's a durationMax, there must be a duration : durationMax.empty() or duration.exists() | |
| tim-8 | error | Extension.value[x]:valueTiming.repeat | If there's a countMax, there must be a count : countMax.empty() or count.exists() | |
| tim-9 | error | Extension.value[x]:valueTiming.repeat | If there's an offset, there must be a when (and not C, CM, CD, CV) : offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not())) | |
| tim-10 | error | Extension.value[x]:valueTiming.repeat | If there's a timeOfDay, there cannot be a when, or vice versa : timeOfDay.empty() or when.empty() | |
| ele-1 | error | Extension.value[x]:valueTiming.repeat.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Extension.value[x]:valueTiming.repeat.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Extension.value[x]:valueTiming.repeat.bounds[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Extension.value[x]:valueTiming.repeat.count | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Extension.value[x]:valueTiming.repeat.countMax | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Extension.value[x]:valueTiming.repeat.duration | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Extension.value[x]:valueTiming.repeat.durationMax | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Extension.value[x]:valueTiming.repeat.durationUnit | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Extension.value[x]:valueTiming.repeat.frequency | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Extension.value[x]:valueTiming.repeat.frequencyMax | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Extension.value[x]:valueTiming.repeat.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Extension.value[x]:valueTiming.repeat.periodMax | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Extension.value[x]:valueTiming.repeat.periodUnit | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Extension.value[x]:valueTiming.repeat.dayOfWeek | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Extension.value[x]:valueTiming.repeat.timeOfDay | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Extension.value[x]:valueTiming.repeat.when | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Extension.value[x]:valueTiming.repeat.offset | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Extension.value[x]:valueTiming.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |