FHIR Extensions Pack
5.2.0-ballot - 5.2.0 Ballot - September 2024) International flag

FHIR Extensions Pack, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 5.2.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-extensions/ and changes regularly. See the Directory of published versions

Extension: Dosage - Minimum Gap Between Doses (Experimental)

Official URL: http://hl7.org/fhir/StructureDefinition/dosage-minimumGapBetweenDose Version: 5.2.0-ballot
Standards status: Draft Maturity Level: 1 Computable Name: DosageMinimumGapBetweenDose
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1594

The minimum amount of time that must pass between administering the specified dose amount.

This is an experimental extension definition; the committee is seeking implementation feedback, and the definition or contents of the extension may change in future versions.

Context of Use

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

  • Element ID Dosage

Usage info

Usage:

  • This Extension is not used by any profiles in this Implementation Guide

Changes since version 1.0.0:

  • No changes

    • Formal Views of Extension Content

    Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

    This structure is derived from Extension

    Summary

    Complex Extension: The minimum amount of time that must pass between administering the specified dose amount.

    • offset: Duration: Specifies the offset before or after the goal is met to follow the instructions.
    • goal: string, Reference: The specific goal to meet to follow the dosage instructions.
    • offset: Duration: Specifies the offset before or after the trigger happens to follow the instructions.
    • trigger: string, Reference: The event that causes the dosage instruction to be followed.
    • doesNotOccur: boolean: If set to 'true', indicates that the condition must not be present for the dosage instructions to be followed.
    • condition: Reference: The event that causes the dosage instruction to be followed.

    Maturity: 1

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension Time that must pass between doses
    ... Slices for extension Content/Rules for all slices
    .... extension:meetGoal 0..* Extension Extension
    ..... extension 1..* Extension Extension
    ..... Slices for extension Content/Rules for all slices
    ...... extension:offset 0..1 Extension Extension
    ....... extension 0..0
    ....... url 1..1 uri "offset"
    ....... value[x] 1..1 Duration Value of extension
    ...... extension:goal 1..1 Extension Extension
    ....... extension 0..0
    ....... url 1..1 uri "goal"
    ....... value[x] 1..1 Value of extension
    ........ valueString string
    ........ valueReference Reference(Goal)
    ..... url 1..1 uri "meetGoal"
    ..... value[x] 0..0
    .... extension:whenTrigger 0..* Extension Extension
    ..... extension 1..* Extension Extension
    ..... Slices for extension Content/Rules for all slices
    ...... extension:offset 0..1 Extension Extension
    ....... extension 0..0
    ....... url 1..1 uri "offset"
    ....... value[x] 1..1 Duration Value of extension
    ...... extension:trigger 1..1 Extension Extension
    ....... extension 0..0
    ....... url 1..1 uri "trigger"
    ....... value[x] 1..1 Value of extension
    ........ valueString string
    ........ valueReference Reference(Procedure | ActivityDefinition | ObservationDefinition)
    ..... url 1..1 uri "whenTrigger"
    ..... value[x] 0..0
    .... extension:precondition 0..* Extension Extension
    ..... extension 1..* Extension Extension
    ..... Slices for extension Content/Rules for all slices
    ...... extension:doesNotOccur 0..1 Extension Extension
    ....... extension 0..0
    ....... url 1..1 uri "doesNotOccur"
    ....... value[x] 1..1 boolean Value of extension
    ...... extension:condition 1..1 Extension Extension
    ....... extension 0..0
    ....... url 1..1 uri "condition"
    ....... value[x] 1..1 Reference(ActivityDefinition | ObservationDefinition) Value of extension
    ..... url 1..1 uri "precondition"
    ..... value[x] 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/dosage-minimumGapBetweenDose"
    ... value[x] 0..0

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension Time that must pass between doses
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... extension:meetGoal 0..* Extension Extension
    ..... id 0..1 id Unique id for inter-element referencing
    ..... Slices for extension 1..* Extension Extension
    Slice: Unordered, Open by value:url
    ...... extension:offset 0..1 Extension Extension
    ....... id 0..1 id Unique id for inter-element referencing
    ....... extension 0..0
    ....... url 1..1 uri "offset"
    ....... value[x] 1..1 Duration Value of extension
    ...... extension:goal 1..1 Extension Extension
    ....... id 0..1 id Unique id for inter-element referencing
    ....... extension 0..0
    ....... url 1..1 uri "goal"
    ....... value[x] 1..1 Value of extension
    ........ valueString string
    ........ valueReference Reference(Goal)
    ..... url 1..1 uri "meetGoal"
    .... extension:whenTrigger 0..* Extension Extension
    ..... id 0..1 id Unique id for inter-element referencing
    ..... Slices for extension 1..* Extension Extension
    Slice: Unordered, Open by value:url
    ...... extension:offset 0..1 Extension Extension
    ....... id 0..1 id Unique id for inter-element referencing
    ....... extension 0..0
    ....... url 1..1 uri "offset"
    ....... value[x] 1..1 Duration Value of extension
    ...... extension:trigger 1..1 Extension Extension
    ....... id 0..1 id Unique id for inter-element referencing
    ....... extension 0..0
    ....... url 1..1 uri "trigger"
    ....... value[x] 1..1 Value of extension
    ........ valueString string
    ........ valueReference Reference(Procedure | ActivityDefinition | ObservationDefinition)
    ..... url 1..1 uri "whenTrigger"
    .... extension:precondition 0..* Extension Extension
    ..... id 0..1 id Unique id for inter-element referencing
    ..... Slices for extension 1..* Extension Extension
    Slice: Unordered, Open by value:url
    ...... extension:doesNotOccur 0..1 Extension Extension
    ....... id 0..1 id Unique id for inter-element referencing
    ....... extension 0..0
    ....... url 1..1 uri "doesNotOccur"
    ....... value[x] 1..1 boolean Value of extension
    ...... extension:condition 1..1 Extension Extension
    ....... id 0..1 id Unique id for inter-element referencing
    ....... extension 0..0
    ....... url 1..1 uri "condition"
    ....... value[x] 1..1 Reference(ActivityDefinition | ObservationDefinition) Value of extension
    ..... url 1..1 uri "precondition"
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/dosage-minimumGapBetweenDose"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Complex Extension: The minimum amount of time that must pass between administering the specified dose amount.

    • offset: Duration: Specifies the offset before or after the goal is met to follow the instructions.
    • goal: string, Reference: The specific goal to meet to follow the dosage instructions.
    • offset: Duration: Specifies the offset before or after the trigger happens to follow the instructions.
    • trigger: string, Reference: The event that causes the dosage instruction to be followed.
    • doesNotOccur: boolean: If set to 'true', indicates that the condition must not be present for the dosage instructions to be followed.
    • condition: Reference: The event that causes the dosage instruction to be followed.

    Maturity: 1

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension Time that must pass between doses
    ... Slices for extension Content/Rules for all slices
    .... extension:meetGoal 0..* Extension Extension
    ..... extension 1..* Extension Extension
    ..... Slices for extension Content/Rules for all slices
    ...... extension:offset 0..1 Extension Extension
    ....... extension 0..0
    ....... url 1..1 uri "offset"
    ....... value[x] 1..1 Duration Value of extension
    ...... extension:goal 1..1 Extension Extension
    ....... extension 0..0
    ....... url 1..1 uri "goal"
    ....... value[x] 1..1 Value of extension
    ........ valueString string
    ........ valueReference Reference(Goal)
    ..... url 1..1 uri "meetGoal"
    ..... value[x] 0..0
    .... extension:whenTrigger 0..* Extension Extension
    ..... extension 1..* Extension Extension
    ..... Slices for extension Content/Rules for all slices
    ...... extension:offset 0..1 Extension Extension
    ....... extension 0..0
    ....... url 1..1 uri "offset"
    ....... value[x] 1..1 Duration Value of extension
    ...... extension:trigger 1..1 Extension Extension
    ....... extension 0..0
    ....... url 1..1 uri "trigger"
    ....... value[x] 1..1 Value of extension
    ........ valueString string
    ........ valueReference Reference(Procedure | ActivityDefinition | ObservationDefinition)
    ..... url 1..1 uri "whenTrigger"
    ..... value[x] 0..0
    .... extension:precondition 0..* Extension Extension
    ..... extension 1..* Extension Extension
    ..... Slices for extension Content/Rules for all slices
    ...... extension:doesNotOccur 0..1 Extension Extension
    ....... extension 0..0
    ....... url 1..1 uri "doesNotOccur"
    ....... value[x] 1..1 boolean Value of extension
    ...... extension:condition 1..1 Extension Extension
    ....... extension 0..0
    ....... url 1..1 uri "condition"
    ....... value[x] 1..1 Reference(ActivityDefinition | ObservationDefinition) Value of extension
    ..... url 1..1 uri "precondition"
    ..... value[x] 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/dosage-minimumGapBetweenDose"
    ... value[x] 0..0

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension Time that must pass between doses
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... extension:meetGoal 0..* Extension Extension
    ..... id 0..1 id Unique id for inter-element referencing
    ..... Slices for extension 1..* Extension Extension
    Slice: Unordered, Open by value:url
    ...... extension:offset 0..1 Extension Extension
    ....... id 0..1 id Unique id for inter-element referencing
    ....... extension 0..0
    ....... url 1..1 uri "offset"
    ....... value[x] 1..1 Duration Value of extension
    ...... extension:goal 1..1 Extension Extension
    ....... id 0..1 id Unique id for inter-element referencing
    ....... extension 0..0
    ....... url 1..1 uri "goal"
    ....... value[x] 1..1 Value of extension
    ........ valueString string
    ........ valueReference Reference(Goal)
    ..... url 1..1 uri "meetGoal"
    .... extension:whenTrigger 0..* Extension Extension
    ..... id 0..1 id Unique id for inter-element referencing
    ..... Slices for extension 1..* Extension Extension
    Slice: Unordered, Open by value:url
    ...... extension:offset 0..1 Extension Extension
    ....... id 0..1 id Unique id for inter-element referencing
    ....... extension 0..0
    ....... url 1..1 uri "offset"
    ....... value[x] 1..1 Duration Value of extension
    ...... extension:trigger 1..1 Extension Extension
    ....... id 0..1 id Unique id for inter-element referencing
    ....... extension 0..0
    ....... url 1..1 uri "trigger"
    ....... value[x] 1..1 Value of extension
    ........ valueString string
    ........ valueReference Reference(Procedure | ActivityDefinition | ObservationDefinition)
    ..... url 1..1 uri "whenTrigger"
    .... extension:precondition 0..* Extension Extension
    ..... id 0..1 id Unique id for inter-element referencing
    ..... Slices for extension 1..* Extension Extension
    Slice: Unordered, Open by value:url
    ...... extension:doesNotOccur 0..1 Extension Extension
    ....... id 0..1 id Unique id for inter-element referencing
    ....... extension 0..0
    ....... url 1..1 uri "doesNotOccur"
    ....... value[x] 1..1 boolean Value of extension
    ...... extension:condition 1..1 Extension Extension
    ....... id 0..1 id Unique id for inter-element referencing
    ....... extension 0..0
    ....... url 1..1 uri "condition"
    ....... value[x] 1..1 Reference(ActivityDefinition | ObservationDefinition) Value of extension
    ..... url 1..1 uri "precondition"
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/dosage-minimumGapBetweenDose"

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Constraints

    IdGradePath(s)DetailsRequirements
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()

    Search Parameters for this Extension

    (none found)