HL7 FHIR Implementation Guide: minimal Common Oncology Data Elements (mCODE), v0.9.0

- Local Development build (v0.9.0). See the Directory of published versions

Timing

 

The official URL for this profile is:

http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Timing

A timing schedule that specifies an event that may occur multiple times. Timing offers a choice of multiple OccurrenceTime (used is used to specify specific times), or recurrence patterns.

This profile builds on Timing.

This profile was published on Wed Apr 17 00:00:00 EDT 2019 as a draft by The MITRE Corporation.

Summary

Prohibited: 1 element

Extensions

This structure refers to these extensions:

Mapping Source

This structure represents the following mapping definition:

shr.core.Timing maps to Timing:
  OccurrenceTime maps to event
  TimingCode maps to code
  EventDuration.DurationRange.LowerBound.SimpleQuantity.Number maps to repeat.duration
  EventDuration.DurationRange.UpperBound.SimpleQuantity.Number maps to repeat.durationMax
  EventDuration.DurationRange.LowerBound.SimpleQuantity.Units.Coding.CodeValue maps to repeat.durationUnits // dstu 2 change (attribute name)
  RecurrencePattern.RecurrenceInterval.Duration.Number maps to repeat.period
  RecurrencePattern.RecurrenceInterval.Duration.Units.Coding.CodeValue maps to repeat.periodUnits
  constrain repeat.periodMax to 0..0
  RecurrencePattern.DailyLifeEvent maps to repeat.when
  RecurrencePattern.CountPerInterval.MinCount maps to repeat.frequency
  RecurrencePattern.CountPerInterval.MaxCount maps to repeat.frequencyMax

NameFlagsCard.TypeDescription & Constraintsdoco
.. Timing Σshr-core-Timing
... extension Slice: Unordered, Open by value:url
... shr-core-RecurrenceRange-extension 0..1(Complex)RecurrenceRange
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-RecurrenceRange-extension
... repeat
.... periodMax 0..0
... code Binding: TimingAbbreviation (extensible)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Timing Σ0..*shr-core-Timing
... id 0..1idxml:id (or equivalent in JSON)
... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
... shr-core-RecurrenceRange-extension 0..1(Complex)RecurrenceRange
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-RecurrenceRange-extension
... event Σ0..*dateTimeWhen the event occurs
... repeat ΣI0..1ElementWhen the event is to occur
tim-3: Either frequency or when can exist, not both
tim-1: if there's a duration, there needs to be duration units
tim-2: if there's a period, there needs to be period units
tim-6: If there's a periodMax, there must be a period
tim-7: If there's a durationMax, there must be a duration
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... bounds[x] Σ0..1Duration, Range, PeriodLength/Range of lengths, or (Start and/or end) limits
.... count Σ0..1integerNumber of times to repeat
.... duration ΣI0..1decimalHow long when it happens
tim-4: duration SHALL be a non-negative value
.... durationMax Σ0..1decimalHow long when it happens (Max)
.... durationUnits Σ0..1codes | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required)
.... frequency Σ0..1integerEvent occurs frequency times per period
.... frequencyMax Σ0..1integerEvent occurs up to frequencyMax times per period
.... period ΣI0..1decimalEvent occurs frequency times per period
tim-5: period SHALL be a non-negative value
.... periodUnits Σ0..1codes | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required)
.... when Σ0..1codeRegular life events the event is tied to
Binding: EventTiming (required)
... code Σ0..1CodeableConceptQD | QOD | Q4H | Q6H | BID | TID | QID | AM | PM +
Binding: TimingAbbreviation (extensible)

doco Documentation for this format

Summary

Prohibited: 1 element

Extensions

This structure refers to these extensions:

Mapping Source

This structure represents the following mapping definition:

shr.core.Timing maps to Timing:
  OccurrenceTime maps to event
  TimingCode maps to code
  EventDuration.DurationRange.LowerBound.SimpleQuantity.Number maps to repeat.duration
  EventDuration.DurationRange.UpperBound.SimpleQuantity.Number maps to repeat.durationMax
  EventDuration.DurationRange.LowerBound.SimpleQuantity.Units.Coding.CodeValue maps to repeat.durationUnits // dstu 2 change (attribute name)
  RecurrencePattern.RecurrenceInterval.Duration.Number maps to repeat.period
  RecurrencePattern.RecurrenceInterval.Duration.Units.Coding.CodeValue maps to repeat.periodUnits
  constrain repeat.periodMax to 0..0
  RecurrencePattern.DailyLifeEvent maps to repeat.when
  RecurrencePattern.CountPerInterval.MinCount maps to repeat.frequency
  RecurrencePattern.CountPerInterval.MaxCount maps to repeat.frequencyMax

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Timing Σshr-core-Timing
... extension Slice: Unordered, Open by value:url
... shr-core-RecurrenceRange-extension 0..1(Complex)RecurrenceRange
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-RecurrenceRange-extension
... repeat
.... periodMax 0..0
... code Binding: TimingAbbreviation (extensible)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Timing Σ0..*shr-core-Timing
... id 0..1idxml:id (or equivalent in JSON)
... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
... shr-core-RecurrenceRange-extension 0..1(Complex)RecurrenceRange
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-RecurrenceRange-extension
... event Σ0..*dateTimeWhen the event occurs
... repeat ΣI0..1ElementWhen the event is to occur
tim-3: Either frequency or when can exist, not both
tim-1: if there's a duration, there needs to be duration units
tim-2: if there's a period, there needs to be period units
tim-6: If there's a periodMax, there must be a period
tim-7: If there's a durationMax, there must be a duration
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... bounds[x] Σ0..1Duration, Range, PeriodLength/Range of lengths, or (Start and/or end) limits
.... count Σ0..1integerNumber of times to repeat
.... duration ΣI0..1decimalHow long when it happens
tim-4: duration SHALL be a non-negative value
.... durationMax Σ0..1decimalHow long when it happens (Max)
.... durationUnits Σ0..1codes | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required)
.... frequency Σ0..1integerEvent occurs frequency times per period
.... frequencyMax Σ0..1integerEvent occurs up to frequencyMax times per period
.... period ΣI0..1decimalEvent occurs frequency times per period
tim-5: period SHALL be a non-negative value
.... periodUnits Σ0..1codes | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required)
.... when Σ0..1codeRegular life events the event is tied to
Binding: EventTiming (required)
... code Σ0..1CodeableConceptQD | QOD | Q4H | Q6H | BID | TID | QID | AM | PM +
Binding: TimingAbbreviation (extensible)

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron

 

 

Constraints

IdPathDetailsRequirements
tim-3Timing.repeatEither frequency or when can exist, not both
:
tim-1Timing.repeatif there's a duration, there needs to be duration units
:
tim-2Timing.repeatif there's a period, there needs to be period units
:
tim-6Timing.repeatIf there's a periodMax, there must be a period
:
tim-7Timing.repeatIf there's a durationMax, there must be a duration
:
tim-4Timing.repeat.durationduration SHALL be a non-negative value
:
tim-5Timing.repeat.periodperiod SHALL be a non-negative value
: