Data Model Libraries
    Preparing search index...

    Class AdministrableProductDefinitionRouteOfAdministrationComponent

    AdministrableProductDefinitionRouteOfAdministrationComponent Class

    FHIR Specification

    • Short: The path by which the product is taken into or makes contact with the body
    • Definition: The path by which the product is taken into or makes contact with the body. In some regions this is referred to as the licenced or approved route. RouteOfAdministration cannot be used when the 'formOf' product already uses MedicinalProductDefinition.route (and vice versa).

    Hierarchy (View Summary)

    • BackboneElement
      • AdministrableProductDefinitionRouteOfAdministrationComponent

    Implements

    Index

    Constructors

    Properties

    code: null | CodeableConcept

    AdministrableProductDefinition.routeOfAdministration.code Element

    FHIR Specification

    • Short: Coded expression for the route
    • Definition: Coded expression for the route.
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    firstDose?: Quantity

    AdministrableProductDefinition.routeOfAdministration.firstDose Element

    FHIR Specification

    • Short: The first dose (dose quantity) administered can be specified for the product
    • Definition: The first dose (dose quantity) administered can be specified for the product, using a numerical value and its unit of measurement.
    • FHIR Type: Quantity
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    maxSingleDose?: Quantity

    AdministrableProductDefinition.routeOfAdministration.maxSingleDose Element

    FHIR Specification

    • Short: The maximum single dose that can be administered
    • Definition: The maximum single dose that can be administered, specified using a numerical value and its unit of measurement.
    • FHIR Type: Quantity
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    maxDosePerDay?: Quantity

    AdministrableProductDefinition.routeOfAdministration.maxDosePerDay Element

    FHIR Specification

    • Short: The maximum dose quantity to be administered in any one 24-h period
    • Definition: The maximum dose per day (maximum dose quantity to be administered in any one 24-h period) that can be administered.
    • FHIR Type: Quantity
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    maxDosePerTreatmentPeriod?: Ratio

    AdministrableProductDefinition.routeOfAdministration.maxDosePerTreatmentPeriod Element

    FHIR Specification

    • Short: The maximum dose per treatment period that can be administered
    • Definition: The maximum dose per treatment period that can be administered.
    • FHIR Type: Ratio
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    maxTreatmentPeriod?: Duration

    AdministrableProductDefinition.routeOfAdministration.maxTreatmentPeriod Element

    FHIR Specification

    • Short: The maximum treatment period during which the product can be administered
    • Definition: The maximum treatment period during which the product can be administered.
    • FHIR Type: Duration
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    AdministrableProductDefinition.routeOfAdministration.targetSpecies Element

    FHIR Specification

    • Short: A species for which this route applies
    • Definition: A species for which this route applies.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    Methods

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Returns undefined | string

      the id property value

    • Assigns the provided value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid value

    • Returns boolean

      true if id exists and has a value; false otherwise

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Determines if the extension property exists.

      Parameters

      • url: string

        the url that identifies a specific Extension

      Returns undefined | IExtension

      an Extension having the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise