Extensions for Using Data Elements from FHIR R4B in FHIR STU3
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R4B in FHIR STU3 - Downloaded Version null See the Directory of published versions

Extension: ExtensionAdministrableProductDefinition_RouteOfAdministration

Official URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-AdministrableProductDefinition.routeOfAdministration Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: ExtensionAdministrableProductDefinition_RouteOfAdministration

R4B: AdministrableProductDefinition.routeOfAdministration (new:BackboneElement)

This extension is part of the cross-version definitions generated to enable use of the element AdministrableProductDefinition.routeOfAdministration as defined in FHIR R4B in FHIR STU3.

The source element is defined as: AdministrableProductDefinition.routeOfAdministration 1..* BackboneElement

Across FHIR versions, the element set has been mapped as:

  • R4B AdministrableProductDefinition.routeOfAdministration 1..* BackboneElement

Following are the generation technical comments: Element AdministrableProductDefinition.routeOfAdministration is not mapped to FHIR STU3, since FHIR R4B AdministrableProductDefinition is not mapped. Element AdministrableProductDefinition.routeOfAdministration has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

Context of Use

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

Usage info

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Extension Content

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

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 1..* Extension R4B: The path by which the product is taken into or makes contact with the body (new)
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:code 1..1 Extension R4B: Coded expression for the route (new)
..... url 1..1 uri "code"
..... value[x] 1..1 CodeableConcept Coded expression for the route
.... extension:firstDose 0..1 Extension R4B: The first dose (dose quantity) administered can be specified for the product (new)
..... url 1..1 uri "firstDose"
..... value[x] 0..1 Quantity The first dose (dose quantity) administered can be specified for the product
.... extension:maxSingleDose 0..1 Extension R4B: The maximum single dose that can be administered (new)
..... url 1..1 uri "maxSingleDose"
..... value[x] 0..1 Quantity The maximum single dose that can be administered
.... extension:maxDosePerDay 0..1 Extension R4B: The maximum dose quantity to be administered in any one 24-h period (new)
..... url 1..1 uri "maxDosePerDay"
..... value[x] 0..1 Quantity The maximum dose quantity to be administered in any one 24-h period
.... extension:maxDosePerTreatmentPeriod 0..1 Extension R4B: The maximum dose per treatment period that can be administered (new)
..... url 1..1 uri "maxDosePerTreatmentPeriod"
..... value[x] 0..1 Ratio The maximum dose per treatment period that can be administered
.... extension:maxTreatmentPeriod 0..1 Extension R4B: The maximum treatment period during which the product can be administered (new)
..... url 1..1 uri "maxTreatmentPeriod"
..... value[x] 0..1 Duration The maximum treatment period during which the product can be administered
.... extension:targetSpecies 0..* Extension R4B: A species for which this route applies (new)
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:code 1..1 Extension R4B: Coded expression for the species (new)
....... url 1..1 uri "code"
....... value[x] 1..1 CodeableConcept Coded expression for the species
Binding: R4BTargetSpeciesForR3 (0.1.0) (example): A tissue type of an animal.
...... extension:withdrawalPeriod 0..* Extension R4B: A species specific time during which consumption of animal product is not appropriate (new)
....... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:tissue 1..1 Extension R4B: The type of tissue for which the withdrawal period applies, e.g. meat, milk (new)
......... url 1..1 uri "tissue"
......... value[x] 1..1 CodeableConcept The type of tissue for which the withdrawal period applies, e.g. meat, milk
Binding: R4BAnimalTissueTypeForR3 (0.1.0) (example): A tissue type of an animal.
........ extension:value 1..1 Extension R4B: A value for the time (new)
......... url 1..1 uri "value"
......... value[x] 1..1 Quantity A value for the time
........ extension:supportingInformation 0..1 Extension R4B: Extra information about the withdrawal period (new)
......... url 1..1 uri "supportingInformation"
......... value[x] 0..1 string Extra information about the withdrawal period
....... url 1..1 uri "withdrawalPeriod"
....... value[x] 0..0 Value of extension
..... url 1..1 uri "targetSpecies"
..... value[x] 0..0 Value of extension
... url 1..1 uri "http://hl7.org/fhir/4.3/StructureDefinition/extension-AdministrableProductDefinition.routeOfAdministration"
... value[x] 0..0 Value of extension

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 1..* Extension R4B: The path by which the product is taken into or makes contact with the body (new)
... id 0..1 string xml:id (or equivalent in JSON)
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:code 1..1 Extension R4B: Coded expression for the route (new)
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "code"
..... value[x] 1..1 CodeableConcept Coded expression for the route
.... extension:firstDose 0..1 Extension R4B: The first dose (dose quantity) administered can be specified for the product (new)
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "firstDose"
..... value[x] 0..1 Quantity The first dose (dose quantity) administered can be specified for the product
.... extension:maxSingleDose 0..1 Extension R4B: The maximum single dose that can be administered (new)
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "maxSingleDose"
..... value[x] 0..1 Quantity The maximum single dose that can be administered
.... extension:maxDosePerDay 0..1 Extension R4B: The maximum dose quantity to be administered in any one 24-h period (new)
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "maxDosePerDay"
..... value[x] 0..1 Quantity The maximum dose quantity to be administered in any one 24-h period
.... extension:maxDosePerTreatmentPeriod 0..1 Extension R4B: The maximum dose per treatment period that can be administered (new)
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "maxDosePerTreatmentPeriod"
..... value[x] 0..1 Ratio The maximum dose per treatment period that can be administered
.... extension:maxTreatmentPeriod 0..1 Extension R4B: The maximum treatment period during which the product can be administered (new)
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "maxTreatmentPeriod"
..... value[x] 0..1 Duration The maximum treatment period during which the product can be administered
.... extension:targetSpecies 0..* Extension R4B: A species for which this route applies (new)
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:code 1..1 Extension R4B: Coded expression for the species (new)
....... id 0..1 string xml:id (or equivalent in JSON)
....... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "code"
....... value[x] 1..1 CodeableConcept Coded expression for the species
Binding: R4BTargetSpeciesForR3 (0.1.0) (example): A tissue type of an animal.
...... extension:withdrawalPeriod 0..* Extension R4B: A species specific time during which consumption of animal product is not appropriate (new)
....... id 0..1 string xml:id (or equivalent in JSON)
....... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:tissue 1..1 Extension R4B: The type of tissue for which the withdrawal period applies, e.g. meat, milk (new)
......... id 0..1 string xml:id (or equivalent in JSON)
......... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
......... url 1..1 uri "tissue"
......... value[x] 1..1 CodeableConcept The type of tissue for which the withdrawal period applies, e.g. meat, milk
Binding: R4BAnimalTissueTypeForR3 (0.1.0) (example): A tissue type of an animal.
........ extension:value 1..1 Extension R4B: A value for the time (new)
......... id 0..1 string xml:id (or equivalent in JSON)
......... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
......... url 1..1 uri "value"
......... value[x] 1..1 Quantity A value for the time
........ extension:supportingInformation 0..1 Extension R4B: Extra information about the withdrawal period (new)
......... id 0..1 string xml:id (or equivalent in JSON)
......... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
......... url 1..1 uri "supportingInformation"
......... value[x] 0..1 string Extra information about the withdrawal period
....... url 1..1 uri "withdrawalPeriod"
..... url 1..1 uri "targetSpecies"
... url 1..1 uri "http://hl7.org/fhir/4.3/StructureDefinition/extension-AdministrableProductDefinition.routeOfAdministration"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: R4B: AdministrableProductDefinition.routeOfAdministration (new:BackboneElement)

  • code: CodeableConcept: R4B: AdministrableProductDefinition.routeOfAdministration.code (new:CodeableConcept)
  • firstDose: Quantity: R4B: AdministrableProductDefinition.routeOfAdministration.firstDose (new:Quantity)
  • maxSingleDose: Quantity: R4B: AdministrableProductDefinition.routeOfAdministration.maxSingleDose (new:Quantity)
  • maxDosePerDay: Quantity: R4B: AdministrableProductDefinition.routeOfAdministration.maxDosePerDay (new:Quantity)
  • maxDosePerTreatmentPeriod: Ratio: R4B: AdministrableProductDefinition.routeOfAdministration.maxDosePerTreatmentPeriod (new:Ratio)
  • maxTreatmentPeriod: Duration: R4B: AdministrableProductDefinition.routeOfAdministration.maxTreatmentPeriod (new:Duration)
  • code: CodeableConcept: R4B: AdministrableProductDefinition.routeOfAdministration.targetSpecies.code (new:CodeableConcept)
  • tissue: CodeableConcept: R4B: AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.tissue (new:CodeableConcept)
  • value: Quantity: R4B: AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.value (new:Quantity)
  • supportingInformation: string: R4B: AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.supportingInformation (new:string)

Maturity: 0

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 1..* Extension R4B: The path by which the product is taken into or makes contact with the body (new)
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:code 1..1 Extension R4B: Coded expression for the route (new)
..... url 1..1 uri "code"
..... value[x] 1..1 CodeableConcept Coded expression for the route
.... extension:firstDose 0..1 Extension R4B: The first dose (dose quantity) administered can be specified for the product (new)
..... url 1..1 uri "firstDose"
..... value[x] 0..1 Quantity The first dose (dose quantity) administered can be specified for the product
.... extension:maxSingleDose 0..1 Extension R4B: The maximum single dose that can be administered (new)
..... url 1..1 uri "maxSingleDose"
..... value[x] 0..1 Quantity The maximum single dose that can be administered
.... extension:maxDosePerDay 0..1 Extension R4B: The maximum dose quantity to be administered in any one 24-h period (new)
..... url 1..1 uri "maxDosePerDay"
..... value[x] 0..1 Quantity The maximum dose quantity to be administered in any one 24-h period
.... extension:maxDosePerTreatmentPeriod 0..1 Extension R4B: The maximum dose per treatment period that can be administered (new)
..... url 1..1 uri "maxDosePerTreatmentPeriod"
..... value[x] 0..1 Ratio The maximum dose per treatment period that can be administered
.... extension:maxTreatmentPeriod 0..1 Extension R4B: The maximum treatment period during which the product can be administered (new)
..... url 1..1 uri "maxTreatmentPeriod"
..... value[x] 0..1 Duration The maximum treatment period during which the product can be administered
.... extension:targetSpecies 0..* Extension R4B: A species for which this route applies (new)
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:code 1..1 Extension R4B: Coded expression for the species (new)
....... url 1..1 uri "code"
....... value[x] 1..1 CodeableConcept Coded expression for the species
Binding: R4BTargetSpeciesForR3 (0.1.0) (example): A tissue type of an animal.
...... extension:withdrawalPeriod 0..* Extension R4B: A species specific time during which consumption of animal product is not appropriate (new)
....... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:tissue 1..1 Extension R4B: The type of tissue for which the withdrawal period applies, e.g. meat, milk (new)
......... url 1..1 uri "tissue"
......... value[x] 1..1 CodeableConcept The type of tissue for which the withdrawal period applies, e.g. meat, milk
Binding: R4BAnimalTissueTypeForR3 (0.1.0) (example): A tissue type of an animal.
........ extension:value 1..1 Extension R4B: A value for the time (new)
......... url 1..1 uri "value"
......... value[x] 1..1 Quantity A value for the time
........ extension:supportingInformation 0..1 Extension R4B: Extra information about the withdrawal period (new)
......... url 1..1 uri "supportingInformation"
......... value[x] 0..1 string Extra information about the withdrawal period
....... url 1..1 uri "withdrawalPeriod"
....... value[x] 0..0 Value of extension
..... url 1..1 uri "targetSpecies"
..... value[x] 0..0 Value of extension
... url 1..1 uri "http://hl7.org/fhir/4.3/StructureDefinition/extension-AdministrableProductDefinition.routeOfAdministration"
... value[x] 0..0 Value of extension

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 1..* Extension R4B: The path by which the product is taken into or makes contact with the body (new)
... id 0..1 string xml:id (or equivalent in JSON)
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:code 1..1 Extension R4B: Coded expression for the route (new)
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "code"
..... value[x] 1..1 CodeableConcept Coded expression for the route
.... extension:firstDose 0..1 Extension R4B: The first dose (dose quantity) administered can be specified for the product (new)
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "firstDose"
..... value[x] 0..1 Quantity The first dose (dose quantity) administered can be specified for the product
.... extension:maxSingleDose 0..1 Extension R4B: The maximum single dose that can be administered (new)
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "maxSingleDose"
..... value[x] 0..1 Quantity The maximum single dose that can be administered
.... extension:maxDosePerDay 0..1 Extension R4B: The maximum dose quantity to be administered in any one 24-h period (new)
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "maxDosePerDay"
..... value[x] 0..1 Quantity The maximum dose quantity to be administered in any one 24-h period
.... extension:maxDosePerTreatmentPeriod 0..1 Extension R4B: The maximum dose per treatment period that can be administered (new)
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "maxDosePerTreatmentPeriod"
..... value[x] 0..1 Ratio The maximum dose per treatment period that can be administered
.... extension:maxTreatmentPeriod 0..1 Extension R4B: The maximum treatment period during which the product can be administered (new)
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "maxTreatmentPeriod"
..... value[x] 0..1 Duration The maximum treatment period during which the product can be administered
.... extension:targetSpecies 0..* Extension R4B: A species for which this route applies (new)
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:code 1..1 Extension R4B: Coded expression for the species (new)
....... id 0..1 string xml:id (or equivalent in JSON)
....... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "code"
....... value[x] 1..1 CodeableConcept Coded expression for the species
Binding: R4BTargetSpeciesForR3 (0.1.0) (example): A tissue type of an animal.
...... extension:withdrawalPeriod 0..* Extension R4B: A species specific time during which consumption of animal product is not appropriate (new)
....... id 0..1 string xml:id (or equivalent in JSON)
....... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:tissue 1..1 Extension R4B: The type of tissue for which the withdrawal period applies, e.g. meat, milk (new)
......... id 0..1 string xml:id (or equivalent in JSON)
......... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
......... url 1..1 uri "tissue"
......... value[x] 1..1 CodeableConcept The type of tissue for which the withdrawal period applies, e.g. meat, milk
Binding: R4BAnimalTissueTypeForR3 (0.1.0) (example): A tissue type of an animal.
........ extension:value 1..1 Extension R4B: A value for the time (new)
......... id 0..1 string xml:id (or equivalent in JSON)
......... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
......... url 1..1 uri "value"
......... value[x] 1..1 Quantity A value for the time
........ extension:supportingInformation 0..1 Extension R4B: Extra information about the withdrawal period (new)
......... id 0..1 string xml:id (or equivalent in JSON)
......... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
......... url 1..1 uri "supportingInformation"
......... value[x] 0..1 string Extra information about the withdrawal period
....... url 1..1 uri "withdrawalPeriod"
..... url 1..1 uri "targetSpecies"
... url 1..1 uri "http://hl7.org/fhir/4.3/StructureDefinition/extension-AdministrableProductDefinition.routeOfAdministration"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: R4B: AdministrableProductDefinition.routeOfAdministration (new:BackboneElement)

  • code: CodeableConcept: R4B: AdministrableProductDefinition.routeOfAdministration.code (new:CodeableConcept)
  • firstDose: Quantity: R4B: AdministrableProductDefinition.routeOfAdministration.firstDose (new:Quantity)
  • maxSingleDose: Quantity: R4B: AdministrableProductDefinition.routeOfAdministration.maxSingleDose (new:Quantity)
  • maxDosePerDay: Quantity: R4B: AdministrableProductDefinition.routeOfAdministration.maxDosePerDay (new:Quantity)
  • maxDosePerTreatmentPeriod: Ratio: R4B: AdministrableProductDefinition.routeOfAdministration.maxDosePerTreatmentPeriod (new:Ratio)
  • maxTreatmentPeriod: Duration: R4B: AdministrableProductDefinition.routeOfAdministration.maxTreatmentPeriod (new:Duration)
  • code: CodeableConcept: R4B: AdministrableProductDefinition.routeOfAdministration.targetSpecies.code (new:CodeableConcept)
  • tissue: CodeableConcept: R4B: AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.tissue (new:CodeableConcept)
  • value: Quantity: R4B: AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.value (new:Quantity)
  • supportingInformation: string: R4B: AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.supportingInformation (new:string)

Maturity: 0

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

Path Status Usage ValueSet Version Source
Extension.extension:targetSpecies.​extension:code.value[x] Base example Cross-version ValueSet R4B.TargetSpecies for use in FHIR STU3 📍0.1.0 This IG
Extension.extension:targetSpecies.​extension:withdrawalPeriod.​extension:tissue.value[x] Base example Cross-version ValueSet R4B.AnimalTissueType for use in FHIR STU3 📍0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()