Extensions for Using Data Elements from FHIR R5 in FHIR STU3
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR STU3
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR STU3 - Downloaded Version null See the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 0 |
Definitions for the ext-R5-APD.rOA extension.
Guidance on how to interpret the contents of this table can be foundhere
| 0. Extension | |
| Definition | R5: Optional Extension Element - found in all resources. |
| Short | R5: The path by which the product is taken into or makes contact with the body (new)Optional Extensions Element |
| Comments | Element |
| Control | 10..* This element is affected by the following invariants: ele-1 |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 2. Extension.extension | |
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | ExtensionAdditional 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. |
| Control | 10..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 4. Extension.extension:code | |
| Slice Name | code |
| Definition | R5: |
| Short | R5: Coded expression for the route (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 10..1* |
| Type | Extension |
| Requirements | Element |
| 6. Extension.extension:code.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | code |
| 8. Extension.extension:code.value[x] | |
| Definition | Coded expression for the route. Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | Coded expression for the routeValue of extension |
| Control | 10..1 |
| Type | CodeableConcept, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 10. Extension.extension:firstDose | |
| Slice Name | firstDose |
| Definition | R5: |
| Short | R5: The first dose (dose quantity) administered can be specified for the product (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 0..1* |
| Type | Extension |
| Requirements | Element |
| 12. Extension.extension:firstDose.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | firstDose |
| 14. Extension.extension:firstDose.value[x] | |
| Definition | The first dose (dose quantity) administered can be specified for the product, using a numerical value and its unit of measurement. Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | The first dose (dose quantity) administered can be specified for the productValue of extension |
| Control | 0..1 |
| Type | Quantity, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 16. Extension.extension:maxSingleDose | |
| Slice Name | maxSingleDose |
| Definition | R5: |
| Short | R5: The maximum single dose that can be administered (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 0..1* |
| Type | Extension |
| Requirements | Element |
| 18. Extension.extension:maxSingleDose.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | maxSingleDose |
| 20. Extension.extension:maxSingleDose.value[x] | |
| Definition | The maximum single dose that can be administered, specified using a numerical value and its unit of measurement. Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | The maximum single dose that can be administeredValue of extension |
| Control | 0..1 |
| Type | Quantity, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 22. Extension.extension:maxDosePerDay | |
| Slice Name | maxDosePerDay |
| Definition | R5: |
| Short | R5: The maximum dose quantity to be administered in any one 24-h period (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 0..1* |
| Type | Extension |
| Requirements | Element |
| 24. Extension.extension:maxDosePerDay.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | maxDosePerDay |
| 26. Extension.extension:maxDosePerDay.value[x] | |
| Definition | The maximum dose per day (maximum dose quantity to be administered in any one 24-h period) that can be administered. Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | The maximum dose quantity to be administered in any one 24-h periodValue of extension |
| Control | 0..1 |
| Type | Quantity, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 28. Extension.extension:maxDosePerTreatmentPeriod | |
| Slice Name | maxDosePerTreatmentPeriod |
| Definition | R5: |
| Short | R5: The maximum dose per treatment period that can be administered (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 0..1* |
| Type | Extension |
| Requirements | Element |
| 30. Extension.extension:maxDosePerTreatmentPeriod.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | maxDosePerTreatmentPeriod |
| 32. Extension.extension:maxDosePerTreatmentPeriod.value[x] | |
| Definition | The maximum dose per treatment period that can be administered. Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | The maximum dose per treatment period that can be administeredValue of extension |
| Control | 0..1 |
| Type | Ratio, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 34. Extension.extension:maxTreatmentPeriod | |
| Slice Name | maxTreatmentPeriod |
| Definition | R5: |
| Short | R5: The maximum treatment period during which the product can be administered (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 0..1* |
| Type | Extension |
| Requirements | Element |
| 36. Extension.extension:maxTreatmentPeriod.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | maxTreatmentPeriod |
| 38. Extension.extension:maxTreatmentPeriod.value[x] | |
| Definition | The maximum treatment period during which the product can be administered. Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | The maximum treatment period during which the product can be administeredValue of extension |
| Control | 0..1 |
| Type | Duration, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 40. Extension.extension:targetSpecies | |
| Slice Name | targetSpecies |
| Definition | R5: |
| Short | R5: A species for which this route applies (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 0..* |
| Type | Extension |
| Requirements | Element |
| 42. Extension.extension:targetSpecies.extension | |
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | ExtensionAdditional 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. |
| Control | 10..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 44. Extension.extension:targetSpecies.extension:code | |
| Slice Name | code |
| Definition | R5: |
| Short | R5: Coded expression for the species (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 10..1* |
| Type | Extension |
| Requirements | Element |
| 46. Extension.extension:targetSpecies.extension:code.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | code |
| 48. Extension.extension:targetSpecies.extension:code.value[x] | |
| Definition | Coded expression for the species. Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | Coded expression for the speciesValue of extension |
| Control | 10..1 |
| Binding | For example codes, see For codes, see R5TargetSpeciesForR3 (0.1.0) (example to http://hl7.org/fhir/uv/xver/ValueSet/R5-target-species-for-R3|0.1.0)A tissue type of an animal. |
| Type | CodeableConcept, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 50. Extension.extension:targetSpecies.extension:withdrawalPeriod | |
| Slice Name | withdrawalPeriod |
| Definition | R5: |
| Short | R5: A species specific time during which consumption of animal product is not appropriate (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 0..* |
| Type | Extension |
| Requirements | Element |
| 52. Extension.extension:targetSpecies.extension:withdrawalPeriod.extension | |
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | ExtensionAdditional 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. |
| Control | 20..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Extension.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 54. Extension.extension:targetSpecies.extension:withdrawalPeriod.extension:tissue | |
| Slice Name | tissue |
| Definition | R5: |
| Short | R5: The type of tissue for which the withdrawal period applies, e.g. meat, milk (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 10..1* |
| Type | Extension |
| Requirements | Element |
| 56. Extension.extension:targetSpecies.extension:withdrawalPeriod.extension:tissue.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | tissue |
| 58. Extension.extension:targetSpecies.extension:withdrawalPeriod.extension:tissue.value[x] | |
| Definition | Coded expression for the type of tissue for which the withdrawal period applies, e.g. meat, milk. Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | The type of tissue for which the withdrawal period applies, e.g. meat, milkValue of extension |
| Control | 10..1 |
| Binding | For example codes, see For codes, see R5AnimalTissueTypeForR3 (0.1.0) (example to http://hl7.org/fhir/uv/xver/ValueSet/R5-animal-tissue-type-for-R3|0.1.0)A tissue type of an animal. |
| Type | CodeableConcept, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 60. Extension.extension:targetSpecies.extension:withdrawalPeriod.extension:value | |
| Slice Name | value |
| Definition | R5: |
| Short | R5: A value for the time (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 10..1* |
| Type | Extension |
| Requirements | Element |
| 62. Extension.extension:targetSpecies.extension:withdrawalPeriod.extension:value.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | value |
| 64. Extension.extension:targetSpecies.extension:withdrawalPeriod.extension:value.value[x] | |
| Definition | A value for the time. Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | A value for the timeValue of extension |
| Control | 10..1 |
| Type | Quantity, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 66. Extension.extension:targetSpecies.extension:withdrawalPeriod.extension:supportingInformation | |
| Slice Name | supportingInformation |
| Definition | R5: |
| Short | R5: Extra information about the withdrawal period (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 0..1* |
| Type | Extension |
| Requirements | Element |
| 68. Extension.extension:targetSpecies.extension:withdrawalPeriod.extension:supportingInformation.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | supportingInformation |
| 70. Extension.extension:targetSpecies.extension:withdrawalPeriod.extension:supportingInformation.value[x] | |
| Definition | Extra information about the withdrawal period. Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | Extra information about the withdrawal periodValue of extension |
| Control | 0..1 |
| Type | string, date, dateTime, Meta, code, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 72. Extension.extension:targetSpecies.extension:withdrawalPeriod.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | withdrawalPeriod |
| 74. Extension.extension:targetSpecies.extension:withdrawalPeriod.value[x] | |
| Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | Value of extension |
| Control | 0..01 |
| Type | Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 76. Extension.extension:targetSpecies.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | targetSpecies |
| 78. Extension.extension:targetSpecies.value[x] | |
| Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | Value of extension |
| Control | 0..01 |
| Type | Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 80. Extension.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | http://hl7.org/fhir/5.0/StructureDefinition/extension-AdministrableProductDefinition.routeOfAdministration |
| 82. Extension.value[x] | |
| Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | Value of extension |
| Control | 0..01 |
| Type | Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Extension | |
| Definition | R5: |
| Short | R5: The path by which the product is taken into or makes contact with the body (new) |
| Comments | Element |
| Control | 1..* |
| Is Modifier | false |
| 2. Extension.extension | |
| Control | 1..* |
| Slicing | This element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 4. Extension.extension:code | |
| Slice Name | code |
| Definition | R5: |
| Short | R5: Coded expression for the route (new) |
| Comments | Element |
| Control | 1..1 |
| Requirements | Element |
| 6. Extension.extension:code.url | |
| Control | 1..1 |
| Fixed Value | code |
| 8. Extension.extension:code.value[x] | |
| Definition | Coded expression for the route. |
| Short | Coded expression for the route |
| Control | 1..1 |
| Type | CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 10. Extension.extension:firstDose | |
| Slice Name | firstDose |
| Definition | R5: |
| Short | R5: The first dose (dose quantity) administered can be specified for the product (new) |
| Comments | Element |
| Control | 0..1 |
| Requirements | Element |
| 12. Extension.extension:firstDose.url | |
| Control | 1..1 |
| Fixed Value | firstDose |
| 14. Extension.extension:firstDose.value[x] | |
| Definition | The first dose (dose quantity) administered can be specified for the product, using a numerical value and its unit of measurement. |
| Short | The first dose (dose quantity) administered can be specified for the product |
| Control | 0..1 |
| Type | Quantity |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 16. Extension.extension:maxSingleDose | |
| Slice Name | maxSingleDose |
| Definition | R5: |
| Short | R5: The maximum single dose that can be administered (new) |
| Comments | Element |
| Control | 0..1 |
| Requirements | Element |
| 18. Extension.extension:maxSingleDose.url | |
| Control | 1..1 |
| Fixed Value | maxSingleDose |
| 20. Extension.extension:maxSingleDose.value[x] | |
| Definition | The maximum single dose that can be administered, specified using a numerical value and its unit of measurement. |
| Short | The maximum single dose that can be administered |
| Control | 0..1 |
| Type | Quantity |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 22. Extension.extension:maxDosePerDay | |
| Slice Name | maxDosePerDay |
| Definition | R5: |
| Short | R5: The maximum dose quantity to be administered in any one 24-h period (new) |
| Comments | Element |
| Control | 0..1 |
| Requirements | Element |
| 24. Extension.extension:maxDosePerDay.url | |
| Control | 1..1 |
| Fixed Value | maxDosePerDay |
| 26. Extension.extension:maxDosePerDay.value[x] | |
| Definition | The maximum dose per day (maximum dose quantity to be administered in any one 24-h period) that can be administered. |
| Short | The maximum dose quantity to be administered in any one 24-h period |
| Control | 0..1 |
| Type | Quantity |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 28. Extension.extension:maxDosePerTreatmentPeriod | |
| Slice Name | maxDosePerTreatmentPeriod |
| Definition | R5: |
| Short | R5: The maximum dose per treatment period that can be administered (new) |
| Comments | Element |
| Control | 0..1 |
| Requirements | Element |
| 30. Extension.extension:maxDosePerTreatmentPeriod.url | |
| Control | 1..1 |
| Fixed Value | maxDosePerTreatmentPeriod |
| 32. Extension.extension:maxDosePerTreatmentPeriod.value[x] | |
| Definition | The maximum dose per treatment period that can be administered. |
| Short | The maximum dose per treatment period that can be administered |
| Control | 0..1 |
| Type | Ratio |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 34. Extension.extension:maxTreatmentPeriod | |
| Slice Name | maxTreatmentPeriod |
| Definition | R5: |
| Short | R5: The maximum treatment period during which the product can be administered (new) |
| Comments | Element |
| Control | 0..1 |
| Requirements | Element |
| 36. Extension.extension:maxTreatmentPeriod.url | |
| Control | 1..1 |
| Fixed Value | maxTreatmentPeriod |
| 38. Extension.extension:maxTreatmentPeriod.value[x] | |
| Definition | The maximum treatment period during which the product can be administered. |
| Short | The maximum treatment period during which the product can be administered |
| Control | 0..1 |
| Type | Duration |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 40. Extension.extension:targetSpecies | |
| Slice Name | targetSpecies |
| Definition | R5: |
| Short | R5: A species for which this route applies (new) |
| Comments | Element |
| Control | 0..* |
| Requirements | Element |
| 42. Extension.extension:targetSpecies.extension | |
| Control | 1..* |
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 44. Extension.extension:targetSpecies.extension:code | |
| Slice Name | code |
| Definition | R5: |
| Short | R5: Coded expression for the species (new) |
| Comments | Element |
| Control | 1..1 |
| Requirements | Element |
| 46. Extension.extension:targetSpecies.extension:code.url | |
| Control | 1..1 |
| Fixed Value | code |
| 48. Extension.extension:targetSpecies.extension:code.value[x] | |
| Definition | Coded expression for the species. |
| Short | Coded expression for the species |
| Control | 1..1 |
| Binding | For example codes, see R5TargetSpeciesForR3 (0.1.0) (example to http://hl7.org/fhir/uv/xver/ValueSet/R5-target-species-for-R3|0.1.0)A tissue type of an animal. |
| Type | CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 50. Extension.extension:targetSpecies.extension:withdrawalPeriod | |
| Slice Name | withdrawalPeriod |
| Definition | R5: |
| Short | R5: A species specific time during which consumption of animal product is not appropriate (new) |
| Comments | Element |
| Control | 0..* |
| Requirements | Element |
| 52. Extension.extension:targetSpecies.extension:withdrawalPeriod.extension | |
| Control | 2..* |
| Slicing | This element introduces a set of slices on Extension.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 54. Extension.extension:targetSpecies.extension:withdrawalPeriod.extension:tissue | |
| Slice Name | tissue |
| Definition | R5: |
| Short | R5: The type of tissue for which the withdrawal period applies, e.g. meat, milk (new) |
| Comments | Element |
| Control | 1..1 |
| Requirements | Element |
| 56. Extension.extension:targetSpecies.extension:withdrawalPeriod.extension:tissue.url | |
| Control | 1..1 |
| Fixed Value | tissue |
| 58. Extension.extension:targetSpecies.extension:withdrawalPeriod.extension:tissue.value[x] | |
| Definition | Coded expression for the type of tissue for which the withdrawal period applies, e.g. meat, milk. |
| Short | The type of tissue for which the withdrawal period applies, e.g. meat, milk |
| Control | 1..1 |
| Binding | For example codes, see R5AnimalTissueTypeForR3 (0.1.0) (example to http://hl7.org/fhir/uv/xver/ValueSet/R5-animal-tissue-type-for-R3|0.1.0)A tissue type of an animal. |
| Type | CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 60. Extension.extension:targetSpecies.extension:withdrawalPeriod.extension:value | |
| Slice Name | value |
| Definition | R5: |
| Short | R5: A value for the time (new) |
| Comments | Element |
| Control | 1..1 |
| Requirements | Element |
| 62. Extension.extension:targetSpecies.extension:withdrawalPeriod.extension:value.url | |
| Control | 1..1 |
| Fixed Value | value |
| 64. Extension.extension:targetSpecies.extension:withdrawalPeriod.extension:value.value[x] | |
| Definition | A value for the time. |
| Short | A value for the time |
| Control | 1..1 |
| Type | Quantity |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 66. Extension.extension:targetSpecies.extension:withdrawalPeriod.extension:supportingInformation | |
| Slice Name | supportingInformation |
| Definition | R5: |
| Short | R5: Extra information about the withdrawal period (new) |
| Comments | Element |
| Control | 0..1 |
| Requirements | Element |
| 68. Extension.extension:targetSpecies.extension:withdrawalPeriod.extension:supportingInformation.url | |
| Control | 1..1 |
| Fixed Value | supportingInformation |
| 70. Extension.extension:targetSpecies.extension:withdrawalPeriod.extension:supportingInformation.value[x] | |
| Definition | Extra information about the withdrawal period. |
| Short | Extra information about the withdrawal period |
| Control | 0..1 |
| Type | string |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 72. Extension.extension:targetSpecies.extension:withdrawalPeriod.url | |
| Control | 1..1 |
| Fixed Value | withdrawalPeriod |
| 74. Extension.extension:targetSpecies.extension:withdrawalPeriod.value[x] | |
| Control | 0..0 |
| 76. Extension.extension:targetSpecies.url | |
| Control | 1..1 |
| Fixed Value | targetSpecies |
| 78. Extension.extension:targetSpecies.value[x] | |
| Control | 0..0 |
| 80. Extension.url | |
| Control | 1..1 |
| Fixed Value | http://hl7.org/fhir/5.0/StructureDefinition/extension-AdministrableProductDefinition.routeOfAdministration |
| 82. Extension.value[x] | |
| Control | 0..0 |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Extension | |
| Definition | R5: |
| Short | R5: The path by which the product is taken into or makes contact with the body (new) |
| Comments | Element |
| Control | 1..* This element is affected by the following invariants: ele-1 |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 2. Extension.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 4. Extension.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 1..* |
| Type | Extension |
| Slicing | This element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 6. Extension.extension:code | |
| Slice Name | code |
| Definition | R5: |
| Short | R5: Coded expression for the route (new) |
| Comments | Element |
| Control | 1..1 |
| Type | Extension |
| Requirements | Element |
| 8. Extension.extension:code.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 10. Extension.extension:code.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 12. Extension.extension:code.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | code |
| 14. Extension.extension:code.value[x] | |
| Definition | Coded expression for the route. |
| Short | Coded expression for the route |
| Control | 1..1 |
| Type | CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 16. Extension.extension:firstDose | |
| Slice Name | firstDose |
| Definition | R5: |
| Short | R5: The first dose (dose quantity) administered can be specified for the product (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension |
| Requirements | Element |
| 18. Extension.extension:firstDose.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 20. Extension.extension:firstDose.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 22. Extension.extension:firstDose.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | firstDose |
| 24. Extension.extension:firstDose.value[x] | |
| Definition | The first dose (dose quantity) administered can be specified for the product, using a numerical value and its unit of measurement. |
| Short | The first dose (dose quantity) administered can be specified for the product |
| Control | 0..1 |
| Type | Quantity |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 26. Extension.extension:maxSingleDose | |
| Slice Name | maxSingleDose |
| Definition | R5: |
| Short | R5: The maximum single dose that can be administered (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension |
| Requirements | Element |
| 28. Extension.extension:maxSingleDose.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 30. Extension.extension:maxSingleDose.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 32. Extension.extension:maxSingleDose.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | maxSingleDose |
| 34. Extension.extension:maxSingleDose.value[x] | |
| Definition | The maximum single dose that can be administered, specified using a numerical value and its unit of measurement. |
| Short | The maximum single dose that can be administered |
| Control | 0..1 |
| Type | Quantity |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 36. Extension.extension:maxDosePerDay | |
| Slice Name | maxDosePerDay |
| Definition | R5: |
| Short | R5: The maximum dose quantity to be administered in any one 24-h period (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension |
| Requirements | Element |
| 38. Extension.extension:maxDosePerDay.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 40. Extension.extension:maxDosePerDay.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 42. Extension.extension:maxDosePerDay.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | maxDosePerDay |
| 44. Extension.extension:maxDosePerDay.value[x] | |
| Definition | The maximum dose per day (maximum dose quantity to be administered in any one 24-h period) that can be administered. |
| Short | The maximum dose quantity to be administered in any one 24-h period |
| Control | 0..1 |
| Type | Quantity |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 46. Extension.extension:maxDosePerTreatmentPeriod | |
| Slice Name | maxDosePerTreatmentPeriod |
| Definition | R5: |
| Short | R5: The maximum dose per treatment period that can be administered (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension |
| Requirements | Element |
| 48. Extension.extension:maxDosePerTreatmentPeriod.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 50. Extension.extension:maxDosePerTreatmentPeriod.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 52. Extension.extension:maxDosePerTreatmentPeriod.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | maxDosePerTreatmentPeriod |
| 54. Extension.extension:maxDosePerTreatmentPeriod.value[x] | |
| Definition | The maximum dose per treatment period that can be administered. |
| Short | The maximum dose per treatment period that can be administered |
| Control | 0..1 |
| Type | Ratio |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 56. Extension.extension:maxTreatmentPeriod | |
| Slice Name | maxTreatmentPeriod |
| Definition | R5: |
| Short | R5: The maximum treatment period during which the product can be administered (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension |
| Requirements | Element |
| 58. Extension.extension:maxTreatmentPeriod.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 60. Extension.extension:maxTreatmentPeriod.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 62. Extension.extension:maxTreatmentPeriod.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | maxTreatmentPeriod |
| 64. Extension.extension:maxTreatmentPeriod.value[x] | |
| Definition | The maximum treatment period during which the product can be administered. |
| Short | The maximum treatment period during which the product can be administered |
| Control | 0..1 |
| Type | Duration |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 66. Extension.extension:targetSpecies | |
| Slice Name | targetSpecies |
| Definition | R5: |
| Short | R5: A species for which this route applies (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension |
| Requirements | Element |
| 68. Extension.extension:targetSpecies.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 70. Extension.extension:targetSpecies.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 1..* |
| Type | Extension |
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 72. Extension.extension:targetSpecies.extension:code | |
| Slice Name | code |
| Definition | R5: |
| Short | R5: Coded expression for the species (new) |
| Comments | Element |
| Control | 1..1 |
| Type | Extension |
| Requirements | Element |
| 74. Extension.extension:targetSpecies.extension:code.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 76. Extension.extension:targetSpecies.extension:code.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Extension.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 78. Extension.extension:targetSpecies.extension:code.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | code |
| 80. Extension.extension:targetSpecies.extension:code.value[x] | |
| Definition | Coded expression for the species. |
| Short | Coded expression for the species |
| Control | 1..1 |
| Binding | For example codes, see R5TargetSpeciesForR3 (0.1.0) (example to http://hl7.org/fhir/uv/xver/ValueSet/R5-target-species-for-R3|0.1.0)A tissue type of an animal. |
| Type | CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 82. Extension.extension:targetSpecies.extension:withdrawalPeriod | |
| Slice Name | withdrawalPeriod |
| Definition | R5: |
| Short | R5: A species specific time during which consumption of animal product is not appropriate (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension |
| Requirements | Element |
| 84. Extension.extension:targetSpecies.extension:withdrawalPeriod.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 86. Extension.extension:targetSpecies.extension:withdrawalPeriod.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 2..* |
| Type | Extension |
| Slicing | This element introduces a set of slices on Extension.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 88. Extension.extension:targetSpecies.extension:withdrawalPeriod.extension:tissue | |
| Slice Name | tissue |
| Definition | R5: |
| Short | R5: The type of tissue for which the withdrawal period applies, e.g. meat, milk (new) |
| Comments | Element |
| Control | 1..1 |
| Type | Extension |
| Requirements | Element |
| 90. Extension.extension:targetSpecies.extension:withdrawalPeriod.extension:tissue.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 92. Extension.extension:targetSpecies.extension:withdrawalPeriod.extension:tissue.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Extension.extension.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 94. Extension.extension:targetSpecies.extension:withdrawalPeriod.extension:tissue.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | tissue |
| 96. Extension.extension:targetSpecies.extension:withdrawalPeriod.extension:tissue.value[x] | |
| Definition | Coded expression for the type of tissue for which the withdrawal period applies, e.g. meat, milk. |
| Short | The type of tissue for which the withdrawal period applies, e.g. meat, milk |
| Control | 1..1 |
| Binding | For example codes, see R5AnimalTissueTypeForR3 (0.1.0) (example to http://hl7.org/fhir/uv/xver/ValueSet/R5-animal-tissue-type-for-R3|0.1.0)A tissue type of an animal. |
| Type | CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 98. Extension.extension:targetSpecies.extension:withdrawalPeriod.extension:value | |
| Slice Name | value |
| Definition | R5: |
| Short | R5: A value for the time (new) |
| Comments | Element |
| Control | 1..1 |
| Type | Extension |
| Requirements | Element |
| 100. Extension.extension:targetSpecies.extension:withdrawalPeriod.extension:value.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 102. Extension.extension:targetSpecies.extension:withdrawalPeriod.extension:value.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Extension.extension.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 104. Extension.extension:targetSpecies.extension:withdrawalPeriod.extension:value.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | value |
| 106. Extension.extension:targetSpecies.extension:withdrawalPeriod.extension:value.value[x] | |
| Definition | A value for the time. |
| Short | A value for the time |
| Control | 1..1 |
| Type | Quantity |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 108. Extension.extension:targetSpecies.extension:withdrawalPeriod.extension:supportingInformation | |
| Slice Name | supportingInformation |
| Definition | R5: |
| Short | R5: Extra information about the withdrawal period (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension |
| Requirements | Element |
| 110. Extension.extension:targetSpecies.extension:withdrawalPeriod.extension:supportingInformation.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 112. Extension.extension:targetSpecies.extension:withdrawalPeriod.extension:supportingInformation.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Extension.extension.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 114. Extension.extension:targetSpecies.extension:withdrawalPeriod.extension:supportingInformation.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | supportingInformation |
| 116. Extension.extension:targetSpecies.extension:withdrawalPeriod.extension:supportingInformation.value[x] | |
| Definition | Extra information about the withdrawal period. |
| Short | Extra information about the withdrawal period |
| Control | 0..1 |
| Type | string |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 118. Extension.extension:targetSpecies.extension:withdrawalPeriod.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | withdrawalPeriod |
| 120. Extension.extension:targetSpecies.extension:withdrawalPeriod.value[x] | |
| Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | Value of extension |
| Control | 0..0 |
| Type | Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 122. Extension.extension:targetSpecies.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | targetSpecies |
| 124. Extension.extension:targetSpecies.value[x] | |
| Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | Value of extension |
| Control | 0..0 |
| Type | Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 126. Extension.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | http://hl7.org/fhir/5.0/StructureDefinition/extension-AdministrableProductDefinition.routeOfAdministration |
| 128. Extension.value[x] | |
| Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | Value of extension |
| Control | 0..0 |
| Type | Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
IG © 2025+ FHIR Infrastructure. Package hl7.fhir.uv.xver-r5.r3#0.1.0 based on FHIR 3.0.2. Generated 2026-03-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change