description: 'regimen metadata for a medication order: protocol name, cycle plan and active ingredient dose information.'
package_name: il.core.fhir.r4
derivation: constraint
name: MedicationRegimen
type: Extension
elements:
  extension:
    index: 0
    slicing:
      slices:
        text:
          match: {}
          schema:
            index: 1
            extensions: {}
            elements:
              extension: {index: 2}
              url:
                pattern: {type: Uri, value: text}
                index: 3
              value:
                short: text
                choices: [valueString]
                index: 5
              valueString: {type: string, short: text, choiceOf: value, index: 6}
        protocolName:
          match: {}
          schema:
            _required: true
            index: 7
            extensions: {}
            elements:
              extension: {index: 8}
              url:
                pattern: {type: Uri, value: protocolName}
                index: 9
              value:
                short: Protocol name
                choices: [valueString]
                index: 11
              valueString: {type: string, short: Protocol name, choiceOf: value, index: 12}
        totalCycles:
          match: {}
          schema:
            index: 13
            extensions: {}
            elements:
              extension: {index: 14}
              url:
                pattern: {type: Uri, value: totalCycles}
                index: 15
              value:
                short: Total planned number of cycles
                choices: [valuePositiveInt]
                index: 17
              valuePositiveInt: {type: positiveInt, short: Total planned number of cycles, choiceOf: value, index: 18}
        durationBetweenCycles:
          match: {}
          schema:
            index: 19
            extensions: {}
            elements:
              extension: {index: 20}
              url:
                pattern: {type: Uri, value: durationBetweenCycles}
                index: 21
              value:
                short: Fixed interval between cycles
                choices: [valueDuration]
                index: 23
              valueDuration: {type: Duration, short: Fixed interval between cycles, choiceOf: value, index: 24}
        currentCycleNumber:
          match: {}
          schema:
            index: 25
            extensions: {}
            elements:
              extension: {index: 26}
              url:
                pattern: {type: Uri, value: currentCycleNumber}
                index: 27
              value:
                short: Current cycle number of this medication order
                choices: [valuePositiveInt]
                index: 29
              valuePositiveInt: {type: positiveInt, short: Current cycle number of this medication order, choiceOf: value, index: 30}
        activeIngredient:
          match: {}
          schema:
            index: 31
            extensions:
              text:
                url: null
                index: 32
                extensions: {}
                elements:
                  extension: {index: 33}
                  url:
                    pattern: {type: Uri, value: text}
                    index: 34
                  value:
                    short: Text of the activeIngredient
                    choices: [valueString]
                    index: 36
                  valueString: {type: string, short: Text of the activeIngredient, choiceOf: value, index: 37}
              cumulativeActiveIngredient:
                url: null
                index: 38
                extensions: {}
                elements:
                  extension: {index: 39}
                  url:
                    pattern: {type: Uri, value: cumulativeActiveIngredient}
                    index: 40
                  value:
                    short: Cumulative active ingredient dose up to the current cycle
                    choices: [valueQuantity]
                    index: 42
                  valueQuantity: {type: Quantity, short: Cumulative active ingredient dose up to the current cycle, choiceOf: value, index: 43}
              activeIngredientReference:
                url: null
                index: 44
                extensions: {}
                elements:
                  extension: {index: 45}
                  url:
                    pattern: {type: Uri, value: activeIngredientReference}
                    index: 46
                  value:
                    short: Reference to the Medication representing the active ingredient
                    choices: [valueReference]
                    index: 48
                  valueReference:
                    type: Reference
                    short: Reference to the Medication representing the active ingredient
                    choiceOf: value
                    refers: ['http://hl7.org/fhir/StructureDefinition/Medication']
                    index: 49
            elements:
              extension:
                index: 32
                slicing:
                  slices:
                    text:
                      match: {}
                      schema:
                        index: 32
                        extensions: {}
                        elements:
                          extension: {index: 33}
                          url:
                            pattern: {type: Uri, value: text}
                            index: 34
                          value:
                            short: Text of the activeIngredient
                            choices: [valueString]
                            index: 36
                          valueString: {type: string, short: Text of the activeIngredient, choiceOf: value, index: 37}
                    cumulativeActiveIngredient:
                      match: {}
                      schema:
                        index: 38
                        extensions: {}
                        elements:
                          extension: {index: 39}
                          url:
                            pattern: {type: Uri, value: cumulativeActiveIngredient}
                            index: 40
                          value:
                            short: Cumulative active ingredient dose up to the current cycle
                            choices: [valueQuantity]
                            index: 42
                          valueQuantity: {type: Quantity, short: Cumulative active ingredient dose up to the current cycle, choiceOf: value, index: 43}
                    activeIngredientReference:
                      match: {}
                      schema:
                        index: 44
                        extensions: {}
                        elements:
                          extension: {index: 45}
                          url:
                            pattern: {type: Uri, value: activeIngredientReference}
                            index: 46
                          value:
                            short: Reference to the Medication representing the active ingredient
                            choices: [valueReference]
                            index: 48
                          valueReference:
                            type: Reference
                            short: Reference to the Medication representing the active ingredient
                            choiceOf: value
                            refers: ['http://hl7.org/fhir/StructureDefinition/Medication']
                            index: 49
              url:
                pattern: {type: Uri, value: activeIngredient}
                index: 50
              value:
                choices: []
                index: 52
  url:
    pattern: {type: Uri, value: 'http://fhir.health.gov.il/StructureDefinition/ext-medication-regimen'}
    index: 53
  value:
    choices: []
    index: 55
package_version: 0.21.0
extensions:
  text:
    url: null
    index: 1
    extensions: {}
    elements:
      extension: {index: 2}
      url:
        pattern: {type: Uri, value: text}
        index: 3
      value:
        short: text
        choices: [valueString]
        index: 5
      valueString: {type: string, short: text, choiceOf: value, index: 6}
  protocolName:
    url: null
    _required: true
    index: 7
    extensions: {}
    elements:
      extension: {index: 8}
      url:
        pattern: {type: Uri, value: protocolName}
        index: 9
      value:
        short: Protocol name
        choices: [valueString]
        index: 11
      valueString: {type: string, short: Protocol name, choiceOf: value, index: 12}
  totalCycles:
    url: null
    index: 13
    extensions: {}
    elements:
      extension: {index: 14}
      url:
        pattern: {type: Uri, value: totalCycles}
        index: 15
      value:
        short: Total planned number of cycles
        choices: [valuePositiveInt]
        index: 17
      valuePositiveInt: {type: positiveInt, short: Total planned number of cycles, choiceOf: value, index: 18}
  durationBetweenCycles:
    url: null
    index: 19
    extensions: {}
    elements:
      extension: {index: 20}
      url:
        pattern: {type: Uri, value: durationBetweenCycles}
        index: 21
      value:
        short: Fixed interval between cycles
        choices: [valueDuration]
        index: 23
      valueDuration: {type: Duration, short: Fixed interval between cycles, choiceOf: value, index: 24}
  currentCycleNumber:
    url: null
    index: 25
    extensions: {}
    elements:
      extension: {index: 26}
      url:
        pattern: {type: Uri, value: currentCycleNumber}
        index: 27
      value:
        short: Current cycle number of this medication order
        choices: [valuePositiveInt]
        index: 29
      valuePositiveInt: {type: positiveInt, short: Current cycle number of this medication order, choiceOf: value, index: 30}
  activeIngredient:
    url: null
    index: 31
    extensions:
      text:
        url: null
        index: 32
        extensions: {}
        elements:
          extension: {index: 33}
          url:
            pattern: {type: Uri, value: text}
            index: 34
          value:
            short: Text of the activeIngredient
            choices: [valueString]
            index: 36
          valueString: {type: string, short: Text of the activeIngredient, choiceOf: value, index: 37}
      cumulativeActiveIngredient:
        url: null
        index: 38
        extensions: {}
        elements:
          extension: {index: 39}
          url:
            pattern: {type: Uri, value: cumulativeActiveIngredient}
            index: 40
          value:
            short: Cumulative active ingredient dose up to the current cycle
            choices: [valueQuantity]
            index: 42
          valueQuantity: {type: Quantity, short: Cumulative active ingredient dose up to the current cycle, choiceOf: value, index: 43}
      activeIngredientReference:
        url: null
        index: 44
        extensions: {}
        elements:
          extension: {index: 45}
          url:
            pattern: {type: Uri, value: activeIngredientReference}
            index: 46
          value:
            short: Reference to the Medication representing the active ingredient
            choices: [valueReference]
            index: 48
          valueReference:
            type: Reference
            short: Reference to the Medication representing the active ingredient
            choiceOf: value
            refers: ['http://hl7.org/fhir/StructureDefinition/Medication']
            index: 49
    elements:
      extension:
        index: 32
        slicing:
          slices:
            text:
              match: {}
              schema:
                index: 32
                extensions: {}
                elements:
                  extension: {index: 33}
                  url:
                    pattern: {type: Uri, value: text}
                    index: 34
                  value:
                    short: Text of the activeIngredient
                    choices: [valueString]
                    index: 36
                  valueString: {type: string, short: Text of the activeIngredient, choiceOf: value, index: 37}
            cumulativeActiveIngredient:
              match: {}
              schema:
                index: 38
                extensions: {}
                elements:
                  extension: {index: 39}
                  url:
                    pattern: {type: Uri, value: cumulativeActiveIngredient}
                    index: 40
                  value:
                    short: Cumulative active ingredient dose up to the current cycle
                    choices: [valueQuantity]
                    index: 42
                  valueQuantity: {type: Quantity, short: Cumulative active ingredient dose up to the current cycle, choiceOf: value, index: 43}
            activeIngredientReference:
              match: {}
              schema:
                index: 44
                extensions: {}
                elements:
                  extension: {index: 45}
                  url:
                    pattern: {type: Uri, value: activeIngredientReference}
                    index: 46
                  value:
                    short: Reference to the Medication representing the active ingredient
                    choices: [valueReference]
                    index: 48
                  valueReference:
                    type: Reference
                    short: Reference to the Medication representing the active ingredient
                    choiceOf: value
                    refers: ['http://hl7.org/fhir/StructureDefinition/Medication']
                    index: 49
      url:
        pattern: {type: Uri, value: activeIngredient}
        index: 50
      value:
        choices: []
        index: 52
class: extension
kind: complex-type
url: http://fhir.health.gov.il/StructureDefinition/ext-medication-regimen
base: http://hl7.org/fhir/StructureDefinition/Extension
version: 0.21.0
required: [extension]