MyHealth@Eu Hospital Discharge Report
0.0.1 - qa-preview 150

MyHealth@Eu Hospital Discharge Report - Local Development build (v0.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Data Type Profile: TimingHdrMyHealthEu - Detailed Descriptions

Page standards status: Draft Maturity Level: 1

Definitions for the timing-hdr-myhealtheu data type profile.

Guidance on how to interpret the contents of this table can be found here

0. Timing
Definition

Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.

ShortA timing schedule that specifies an event that may occur multiple times
Comments

Describes the occurrence of an event that may occur multiple times. Timing schedules are used for specifying when events are expected or requested to occur, and may also be used to represent the summary of a past or ongoing event. For simplicity, the definitions of Timing components are expressed as 'future' events, but such components can also be used to describe historic or ongoing events.

A Timing schedule can be a list of events and/or criteria for when the event happens, which can be expressed in a structured form and/or as a code. When both event and a repeating specification are provided, the list of events should be understood as an interpretation of the information in the repeat structure.

Control0..*
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. Timing.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
4. Timing.code
Definition

A code for the timing schedule (or just text in code.text). Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code).

ShortBID | TID | QID | AM | PM | QD | QOD | +
Comments

BID etc. are defined as 'at institutionally specified times'. For example, an institution may choose that BID is "always at 7am and 6pm". If it is inappropriate for this choice to be made, the code BID should not be used. Instead, a distinct organization-specific code should be used in place of the HL7-defined BID code and/or a structured representation should be used (in this case, specifying the two event times).

Control0..1
BindingUnless not suitable, these codes SHALL be taken from The codes SHOULD be taken from eHDSI Event Timing Combinationhttp://hl7.org/fhir/ValueSet/timing-abbreviation
(extensible to http://fhir.ehdsi.eu/hdr/ValueSet/eHDSIEventTimingCombination)
TypeCodeableConcept
Is Modifierfalse
Obligations
    ObligationsActor
    SHALL:handleHDR Handler
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

    Guidance on how to interpret the contents of this table can be found here

    0. Timing
    2. Timing.repeat
    4. Timing.repeat.duration
    ShortDuration of the treatment
    Obligations
      ObligationsActor
      SHALL:handleHDR Handler
      6. Timing.repeat.frequency
      ShortFrequency times per period
      Obligations
        ObligationsActor
        SHALL:handleHDR Handler
        8. Timing.repeat.period
        ShortDuration of time over which repetitions are to occur
        Obligations
          ObligationsActor
          SHALL:handleHDR Handler
          10. Timing.repeat.periodUnit
          ShortUnit of the period (e.g. day)
          Obligations
            ObligationsActor
            SHALL:handleHDR Handler
            12. Timing.code
            BindingUnless not suitable, these codes SHALL be taken from eHDSI Event Timing Combination
            (extensible to http://fhir.ehdsi.eu/hdr/ValueSet/eHDSIEventTimingCombination)
            Obligations
              ObligationsActor
              SHALL:handleHDR Handler

              Guidance on how to interpret the contents of this table can be found here

              0. Timing
              Definition

              Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.

              ShortA timing schedule that specifies an event that may occur multiple times
              Comments

              Describes the occurrence of an event that may occur multiple times. Timing schedules are used for specifying when events are expected or requested to occur, and may also be used to represent the summary of a past or ongoing event. For simplicity, the definitions of Timing components are expressed as 'future' events, but such components can also be used to describe historic or ongoing events.

              A Timing schedule can be a list of events and/or criteria for when the event happens, which can be expressed in a structured form and/or as a code. When both event and a repeating specification are provided, the list of events should be understood as an interpretation of the information in the repeat structure.

              Control0..*
              Is Modifierfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              2. Timing.id
              Definition

              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

              ShortUnique id for inter-element referencing
              Control0..1
              Typestring
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              4. Timing.extension
              Definition

              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

              ShortAdditional content defined by implementations
              Comments

              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

              Control0..*
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              Alternate Namesextensions, user content
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              SlicingThis element introduces a set of slices on Timing.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 6. Timing.modifierExtension
                Definition

                May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                ShortExtensions that cannot be ignored even if unrecognized
                Comments

                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                Control0..*
                TypeExtension
                Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                Summarytrue
                Requirements

                Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                Alternate Namesextensions, user content, modifiers
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                8. Timing.event
                Definition

                Identifies specific times when the event occurs.

                ShortWhen the event occurs
                Control0..*
                TypedateTime
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Requirements

                In a Medication Administration Record, for instance, you need to take a general specification, and turn it into a precise specification.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                10. Timing.repeat
                Definition

                A set of rules that describe when the event is scheduled.

                ShortWhen the event is to occur
                Control0..1
                TypeElement
                Is Modifierfalse
                Summarytrue
                Requirements

                Many timing schedules are determined by regular repetitions.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                tim-1: if there's a duration, there needs to be duration units (duration.empty() or durationUnit.exists())
                tim-2: if there's a period, there needs to be period units (period.empty() or periodUnit.exists())
                tim-4: duration SHALL be a non-negative value (duration.exists() implies duration >= 0)
                tim-5: period SHALL be a non-negative value (period.exists() implies period >= 0)
                tim-6: If there's a periodMax, there must be a period (periodMax.empty() or period.exists())
                tim-7: If there's a durationMax, there must be a duration (durationMax.empty() or duration.exists())
                tim-8: If there's a countMax, there must be a count (countMax.empty() or count.exists())
                tim-9: 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: If there's a timeOfDay, there cannot be a when, or vice versa (timeOfDay.empty() or when.empty())
                12. Timing.repeat.id
                Definition

                Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                ShortUnique id for inter-element referencing
                Control0..1
                Typestring
                Is Modifierfalse
                XML FormatIn the XML format, this property is represented as an attribute.
                Summaryfalse
                14. Timing.repeat.extension
                Definition

                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                ShortAdditional content defined by implementations
                Comments

                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                Control0..*
                TypeExtension
                Is Modifierfalse
                Summaryfalse
                Alternate Namesextensions, user content
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                SlicingThis element introduces a set of slices on Timing.repeat.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 16. Timing.repeat.bounds[x]
                  Definition

                  Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.

                  ShortLength/Range of lengths, or (Start and/or end) limits
                  Control0..1
                  TypeChoice of: Duration, Range, Period
                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                  Is Modifierfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  18. Timing.repeat.count
                  Definition

                  A total count of the desired number of repetitions across the duration of the entire timing specification. If countMax is present, this element indicates the lower bound of the allowed range of count values.

                  ShortNumber of times to repeat
                  Comments

                  If you have both bounds and count, then this should be understood as within the bounds period, until count times happens.

                  Control0..1
                  TypepositiveInt
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Requirements

                  Repetitions may be limited by end time or total occurrences.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  20. Timing.repeat.countMax
                  Definition

                  If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times.

                  ShortMaximum number of times to repeat
                  Control0..1
                  TypepositiveInt
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  22. Timing.repeat.duration
                  Definition

                  How long this thing happens for when it happens. If durationMax is present, this element indicates the lower bound of the allowed range of the duration.

                  ShortDuration of the treatment
                  Comments

                  For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).

                  Control0..1
                  Typedecimal
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Obligations
                    ObligationsActor
                    SHALL:handleHDR Handler
                    Summarytrue
                    Requirements

                    Some activities are not instantaneous and need to be maintained for a period of time.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    24. Timing.repeat.durationMax
                    Definition

                    If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length.

                    ShortHow long when it happens (Max)
                    Comments

                    For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).

                    Control0..1
                    Typedecimal
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Requirements

                    Some activities are not instantaneous and need to be maintained for a period of time.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    26. Timing.repeat.durationUnit
                    Definition

                    The units of time for the duration, in UCUM units.

                    Shorts | min | h | d | wk | mo | a - unit of time (UCUM)
                    Control0..1
                    BindingThe codes SHALL be taken from UnitsOfTime
                    (required to http://hl7.org/fhir/ValueSet/units-of-time|4.0.1)

                    A unit of time (units from UCUM).

                    Typecode
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    28. Timing.repeat.frequency
                    Definition

                    The number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequency.

                    ShortFrequency times per period
                    Control0..1
                    TypepositiveInt
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Obligations
                      ObligationsActor
                      SHALL:handleHDR Handler
                      Summarytrue
                      Meaning if MissingIf no frequency is stated, the assumption is that the event occurs once per period, but systems SHOULD always be specific about this
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      30. Timing.repeat.frequencyMax
                      Definition

                      If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range.

                      ShortEvent occurs up to frequencyMax times per period
                      Control0..1
                      TypepositiveInt
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      32. Timing.repeat.period
                      Definition

                      Indicates the duration of time over which repetitions are to occur; e.g. to express "3 times per day", 3 would be the frequency and "1 day" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period length.

                      ShortDuration of time over which repetitions are to occur
                      Control0..1
                      Typedecimal
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Obligations
                        ObligationsActor
                        SHALL:handleHDR Handler
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        34. Timing.repeat.periodMax
                        Definition

                        If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days.

                        ShortUpper limit of period (3-4 hours)
                        Control0..1
                        Typedecimal
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        36. Timing.repeat.periodUnit
                        Definition

                        The units of time for the period in UCUM units.

                        ShortUnit of the period (e.g. day)
                        Control0..1
                        BindingThe codes SHALL be taken from UnitsOfTime
                        (required to http://hl7.org/fhir/ValueSet/units-of-time|4.0.1)

                        A unit of time (units from UCUM).

                        Typecode
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Obligations
                          ObligationsActor
                          SHALL:handleHDR Handler
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          38. Timing.repeat.dayOfWeek
                          Definition

                          If one or more days of week is provided, then the action happens only on the specified day(s).

                          Shortmon | tue | wed | thu | fri | sat | sun
                          Comments

                          If no days are specified, the action is assumed to happen every day as otherwise specified. The elements frequency and period cannot be used as well as dayOfWeek.

                          Control0..*
                          BindingThe codes SHALL be taken from DaysOfWeek
                          (required to http://hl7.org/fhir/ValueSet/days-of-week|4.0.1)
                          Typecode
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          40. Timing.repeat.timeOfDay
                          Definition

                          Specified time of day for action to take place.

                          ShortTime of day for action
                          Comments

                          When time of day is specified, it is inferred that the action happens every day (as filtered by dayofWeek) on the specified times. The elements when, frequency and period cannot be used as well as timeOfDay.

                          Control0..*
                          Typetime
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          42. Timing.repeat.when
                          Definition

                          An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur.

                          ShortCode for time period of occurrence
                          Comments

                          When more than one event is listed, the event is tied to the union of the specified events.

                          Control0..*
                          BindingThe codes SHALL be taken from EventTiming
                          (required to http://hl7.org/fhir/ValueSet/event-timing|4.0.1)

                          Real world event relating to the schedule.

                          Typecode
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Requirements

                          Timings are frequently determined by occurrences such as waking, eating and sleep.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          44. Timing.repeat.offset
                          Definition

                          The number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event.

                          ShortMinutes from event (before or after)
                          Control0..1
                          TypeunsignedInt
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          46. Timing.code
                          Definition

                          A code for the timing schedule (or just text in code.text). Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code).

                          ShortBID | TID | QID | AM | PM | QD | QOD | +
                          Comments

                          BID etc. are defined as 'at institutionally specified times'. For example, an institution may choose that BID is "always at 7am and 6pm". If it is inappropriate for this choice to be made, the code BID should not be used. Instead, a distinct organization-specific code should be used in place of the HL7-defined BID code and/or a structured representation should be used (in this case, specifying the two event times).

                          Control0..1
                          BindingUnless not suitable, these codes SHALL be taken from eHDSI Event Timing Combination
                          (extensible to http://fhir.ehdsi.eu/hdr/ValueSet/eHDSIEventTimingCombination)
                          TypeCodeableConcept
                          Is Modifierfalse
                          Obligations
                            ObligationsActor
                            SHALL:handleHDR Handler
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))