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-MedicationKnowledge.regulatory 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: Regulatory information about a medication (new)Optional Extensions Element |
| Comments | Element |
| Control | 0..* 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:regulatoryAuthority | |
| Slice Name | regulatoryAuthority |
| Definition | R5: |
| Short | R5: Specifies the authority of the regulation (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 10..1* |
| Type | Extension |
| Requirements | Element |
| 6. Extension.extension:regulatoryAuthority.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 | regulatoryAuthority |
| 8. Extension.extension:regulatoryAuthority.value[x] | |
| Definition | The authority that is specifying the regulations. 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 | Specifies the authority of the regulationValue of extension |
| Control | 10..1 |
| Type | Reference(Cross-version Profile for R5.Organization for use in FHIR STU3, Organization), date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, 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] |
| 10. Extension.extension:substitution | |
| Slice Name | substitution |
| Definition | R5: |
| Short | R5: Specifies if changes are allowed when dispensing a medication from a regulatory perspective (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 0..* |
| Type | Extension |
| Requirements | Element |
| 12. Extension.extension:substitution.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. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 14. Extension.extension:substitution.extension:type | |
| Slice Name | type |
| Definition | R5: |
| Short | R5: Specifies the type of substitution allowed (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 10..1* |
| Type | Extension |
| Requirements | Element |
| 16. Extension.extension:substitution.extension:type.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 | type |
| 18. Extension.extension:substitution.extension:type.value[x] | |
| Definition | Specifies the type of substitution allowed. 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 | Specifies the type of substitution allowedValue 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] |
| 20. Extension.extension:substitution.extension:allowed | |
| Slice Name | allowed |
| Definition | R5: |
| Short | R5: Specifies if regulation allows for changes in the medication when dispensing (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 10..1* |
| Type | Extension |
| Requirements | Element |
| 22. Extension.extension:substitution.extension:allowed.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 | allowed |
| 24. Extension.extension:substitution.extension:allowed.value[x] | |
| Definition | Specifies if regulation allows for changes in the medication when dispensing. 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 | Specifies if regulation allows for changes in the medication when dispensingValue of extension |
| Control | 10..1 |
| Type | boolean, 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, 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 |
| 26. Extension.extension:substitution.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 | substitution |
| 28. Extension.extension:substitution.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 |
| 30. Extension.extension:schedule | |
| Slice Name | schedule |
| Definition | R5: |
| Short | R5: Specifies the schedule of a medication in jurisdiction (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 0..* |
| Type | Extension |
| Requirements | Element |
| 32. Extension.extension:schedule.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 | schedule |
| 34. Extension.extension:schedule.value[x] | |
| Definition | Specifies the schedule of a medication in jurisdiction. 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 | Specifies the schedule of a medication in jurisdictionValue of extension |
| Control | 0..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] |
| 36. Extension.extension:maxDispense | |
| Slice Name | maxDispense |
| Definition | R5: |
| Short | R5: The maximum number of units of the medication that can be dispensed in a period (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 0..1* |
| Type | Extension |
| Requirements | Element |
| 38. Extension.extension:maxDispense.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: |
| 40. Extension.extension:maxDispense.extension:quantity | |
| Slice Name | quantity |
| Definition | R5: |
| Short | R5: The maximum number of units of the medication that can be dispensed (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 10..1* |
| Type | Extension |
| Requirements | Element |
| 42. Extension.extension:maxDispense.extension:quantity.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 | quantity |
| 44. Extension.extension:maxDispense.extension:quantity.value[x] | |
| Definition | The maximum number of units of the medication that can be dispensed. 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 number of units of the medication that can be dispensedValue of extension |
| Control | 10..1 |
| Type | Quantity(SimpleQuantity), 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] |
| 46. Extension.extension:maxDispense.extension:period | |
| Slice Name | period |
| Definition | R5: |
| Short | R5: The period that applies to the maximum number of units (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 0..1* |
| Type | Extension |
| Requirements | Element |
| 48. Extension.extension:maxDispense.extension:period.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 | period |
| 50. Extension.extension:maxDispense.extension:period.value[x] | |
| Definition | The period that applies to the maximum number of units. 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 period that applies to the maximum number of unitsValue 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] |
| 52. Extension.extension:maxDispense.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 | maxDispense |
| 54. Extension.extension:maxDispense.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 |
| 56. 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-MedicationKnowledge.regulatory |
| 58. 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: Regulatory information about a medication (new) |
| Comments | Element |
| Control | 0..* |
| 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:regulatoryAuthority | |
| Slice Name | regulatoryAuthority |
| Definition | R5: |
| Short | R5: Specifies the authority of the regulation (new) |
| Comments | Element |
| Control | 1..1 |
| Requirements | Element |
| 6. Extension.extension:regulatoryAuthority.url | |
| Control | 1..1 |
| Fixed Value | regulatoryAuthority |
| 8. Extension.extension:regulatoryAuthority.value[x] | |
| Definition | The authority that is specifying the regulations. |
| Short | Specifies the authority of the regulation |
| Control | 1..1 |
| Type | Reference(Cross-version Profile for R5.Organization for use in FHIR STU3, Organization) |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 10. Extension.extension:substitution | |
| Slice Name | substitution |
| Definition | R5: |
| Short | R5: Specifies if changes are allowed when dispensing a medication from a regulatory perspective (new) |
| Comments | Element |
| Control | 0..* |
| Requirements | Element |
| 12. Extension.extension:substitution.extension | |
| Control | 2..* |
| 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: |
| 14. Extension.extension:substitution.extension:type | |
| Slice Name | type |
| Definition | R5: |
| Short | R5: Specifies the type of substitution allowed (new) |
| Comments | Element |
| Control | 1..1 |
| Requirements | Element |
| 16. Extension.extension:substitution.extension:type.url | |
| Control | 1..1 |
| Fixed Value | type |
| 18. Extension.extension:substitution.extension:type.value[x] | |
| Definition | Specifies the type of substitution allowed. |
| Short | Specifies the type of substitution allowed |
| Control | 1..1 |
| Type | CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 20. Extension.extension:substitution.extension:allowed | |
| Slice Name | allowed |
| Definition | R5: |
| Short | R5: Specifies if regulation allows for changes in the medication when dispensing (new) |
| Comments | Element |
| Control | 1..1 |
| Requirements | Element |
| 22. Extension.extension:substitution.extension:allowed.url | |
| Control | 1..1 |
| Fixed Value | allowed |
| 24. Extension.extension:substitution.extension:allowed.value[x] | |
| Definition | Specifies if regulation allows for changes in the medication when dispensing. |
| Short | Specifies if regulation allows for changes in the medication when dispensing |
| Control | 1..1 |
| Type | boolean |
| [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 |
| 26. Extension.extension:substitution.url | |
| Control | 1..1 |
| Fixed Value | substitution |
| 28. Extension.extension:substitution.value[x] | |
| Control | 0..0 |
| 30. Extension.extension:schedule | |
| Slice Name | schedule |
| Definition | R5: |
| Short | R5: Specifies the schedule of a medication in jurisdiction (new) |
| Comments | Element |
| Control | 0..* |
| Requirements | Element |
| 32. Extension.extension:schedule.url | |
| Control | 1..1 |
| Fixed Value | schedule |
| 34. Extension.extension:schedule.value[x] | |
| Definition | Specifies the schedule of a medication in jurisdiction. |
| Short | Specifies the schedule of a medication in jurisdiction |
| Control | 0..1 |
| Type | CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 36. Extension.extension:maxDispense | |
| Slice Name | maxDispense |
| Definition | R5: |
| Short | R5: The maximum number of units of the medication that can be dispensed in a period (new) |
| Comments | Element |
| Control | 0..1 |
| Requirements | Element |
| 38. Extension.extension:maxDispense.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: |
| 40. Extension.extension:maxDispense.extension:quantity | |
| Slice Name | quantity |
| Definition | R5: |
| Short | R5: The maximum number of units of the medication that can be dispensed (new) |
| Comments | Element |
| Control | 1..1 |
| Requirements | Element |
| 42. Extension.extension:maxDispense.extension:quantity.url | |
| Control | 1..1 |
| Fixed Value | quantity |
| 44. Extension.extension:maxDispense.extension:quantity.value[x] | |
| Definition | The maximum number of units of the medication that can be dispensed. |
| Short | The maximum number of units of the medication that can be dispensed |
| Control | 1..1 |
| Type | Quantity(SimpleQuantity) |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 46. Extension.extension:maxDispense.extension:period | |
| Slice Name | period |
| Definition | R5: |
| Short | R5: The period that applies to the maximum number of units (new) |
| Comments | Element |
| Control | 0..1 |
| Requirements | Element |
| 48. Extension.extension:maxDispense.extension:period.url | |
| Control | 1..1 |
| Fixed Value | period |
| 50. Extension.extension:maxDispense.extension:period.value[x] | |
| Definition | The period that applies to the maximum number of units. |
| Short | The period that applies to the maximum number of units |
| Control | 0..1 |
| Type | Duration |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 52. Extension.extension:maxDispense.url | |
| Control | 1..1 |
| Fixed Value | maxDispense |
| 54. Extension.extension:maxDispense.value[x] | |
| Control | 0..0 |
| 56. Extension.url | |
| Control | 1..1 |
| Fixed Value | http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationKnowledge.regulatory |
| 58. 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: Regulatory information about a medication (new) |
| Comments | Element |
| Control | 0..* 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:regulatoryAuthority | |
| Slice Name | regulatoryAuthority |
| Definition | R5: |
| Short | R5: Specifies the authority of the regulation (new) |
| Comments | Element |
| Control | 1..1 |
| Type | Extension |
| Requirements | Element |
| 8. Extension.extension:regulatoryAuthority.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:regulatoryAuthority.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:regulatoryAuthority.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 | regulatoryAuthority |
| 14. Extension.extension:regulatoryAuthority.value[x] | |
| Definition | The authority that is specifying the regulations. |
| Short | Specifies the authority of the regulation |
| Control | 1..1 |
| Type | Reference(Cross-version Profile for R5.Organization for use in FHIR STU3, Organization) |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 16. Extension.extension:substitution | |
| Slice Name | substitution |
| Definition | R5: |
| Short | R5: Specifies if changes are allowed when dispensing a medication from a regulatory perspective (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension |
| Requirements | Element |
| 18. Extension.extension:substitution.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:substitution.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 2..* |
| 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: |
| 22. Extension.extension:substitution.extension:type | |
| Slice Name | type |
| Definition | R5: |
| Short | R5: Specifies the type of substitution allowed (new) |
| Comments | Element |
| Control | 1..1 |
| Type | Extension |
| Requirements | Element |
| 24. Extension.extension:substitution.extension:type.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. |
| 26. Extension.extension:substitution.extension:type.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: |
| 28. Extension.extension:substitution.extension:type.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 | type |
| 30. Extension.extension:substitution.extension:type.value[x] | |
| Definition | Specifies the type of substitution allowed. |
| Short | Specifies the type of substitution allowed |
| Control | 1..1 |
| Type | CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 32. Extension.extension:substitution.extension:allowed | |
| Slice Name | allowed |
| Definition | R5: |
| Short | R5: Specifies if regulation allows for changes in the medication when dispensing (new) |
| Comments | Element |
| Control | 1..1 |
| Type | Extension |
| Requirements | Element |
| 34. Extension.extension:substitution.extension:allowed.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. |
| 36. Extension.extension:substitution.extension:allowed.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: |
| 38. Extension.extension:substitution.extension:allowed.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 | allowed |
| 40. Extension.extension:substitution.extension:allowed.value[x] | |
| Definition | Specifies if regulation allows for changes in the medication when dispensing. |
| Short | Specifies if regulation allows for changes in the medication when dispensing |
| Control | 1..1 |
| Type | boolean |
| [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 |
| 42. Extension.extension:substitution.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 | substitution |
| 44. Extension.extension:substitution.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 |
| 46. Extension.extension:schedule | |
| Slice Name | schedule |
| Definition | R5: |
| Short | R5: Specifies the schedule of a medication in jurisdiction (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension |
| Requirements | Element |
| 48. Extension.extension:schedule.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:schedule.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:schedule.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 | schedule |
| 54. Extension.extension:schedule.value[x] | |
| Definition | Specifies the schedule of a medication in jurisdiction. |
| Short | Specifies the schedule of a medication in jurisdiction |
| Control | 0..1 |
| Type | CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 56. Extension.extension:maxDispense | |
| Slice Name | maxDispense |
| Definition | R5: |
| Short | R5: The maximum number of units of the medication that can be dispensed in a period (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension |
| Requirements | Element |
| 58. Extension.extension:maxDispense.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:maxDispense.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: |
| 62. Extension.extension:maxDispense.extension:quantity | |
| Slice Name | quantity |
| Definition | R5: |
| Short | R5: The maximum number of units of the medication that can be dispensed (new) |
| Comments | Element |
| Control | 1..1 |
| Type | Extension |
| Requirements | Element |
| 64. Extension.extension:maxDispense.extension:quantity.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. |
| 66. Extension.extension:maxDispense.extension:quantity.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: |
| 68. Extension.extension:maxDispense.extension:quantity.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 | quantity |
| 70. Extension.extension:maxDispense.extension:quantity.value[x] | |
| Definition | The maximum number of units of the medication that can be dispensed. |
| Short | The maximum number of units of the medication that can be dispensed |
| Control | 1..1 |
| Type | Quantity(SimpleQuantity) |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 72. Extension.extension:maxDispense.extension:period | |
| Slice Name | period |
| Definition | R5: |
| Short | R5: The period that applies to the maximum number of units (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension |
| Requirements | Element |
| 74. Extension.extension:maxDispense.extension:period.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:maxDispense.extension:period.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:maxDispense.extension:period.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 | period |
| 80. Extension.extension:maxDispense.extension:period.value[x] | |
| Definition | The period that applies to the maximum number of units. |
| Short | The period that applies to the maximum number of units |
| Control | 0..1 |
| Type | Duration |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 82. Extension.extension:maxDispense.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 | maxDispense |
| 84. Extension.extension:maxDispense.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 |
| 86. 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-MedicationKnowledge.regulatory |
| 88. 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