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

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

Extension: ExtensionMedicationRequest_DosageInstruction - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the ext-R3-MedicationRequest.dosageInstruction extension.

Guidance on how to interpret the contents of this table can be foundhere

0. Extension
Definition

STU3: MedicationRequest.dosageInstruction additional types (Dosage) additional types from child elements (additionalInstruction, asNeeded[x], dose[x], maxDosePerAdministration, maxDosePerLifetime, maxDosePerPeriod, method, patientInstruction, rate[x], route, sequence, site, text, timing)


Optional Extension Element - found in all resources.

ShortSTU3: How the medication should be taken additional typesOptional Extensions Element
Comments

Element MedicationRequest.dosageInstruction is mapped to FHIR R5 element MedicationRequest.dosageInstruction as SourceIsBroaderThanTarget. The mappings for MedicationRequest.dosageInstruction do not cover the following types: Dosage. The mappings for MedicationRequest.dosageInstruction do not cover the following types based on type expansion: additionalInstruction, asNeeded[x], dose[x], maxDosePerAdministration, maxDosePerLifetime, maxDosePerPeriod, method, patientInstruction, rate[x], route, sequence, site, text, timing. There are examples where a medication request may include the option of an oral dose or an Intravenous or Intramuscular dose. For example, "Ondansetron 8mg orally or IV twice a day as needed for nausea" or "Compazine® (prochlorperazine) 5-10mg PO or 25mg PR bid prn nausea or vomiting". In these cases, two medication requests would be created that could be grouped together. The decision on which dose and route of administration to use is based on the patient's condition at the time the dose is needed.

Control0..*
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (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() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2. Extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies 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.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Valuehttp://hl7.org/fhir/3.0/StructureDefinition/extension-MedicationRequest.dosageInstruction
4. Extension.value[x]
Definition

Indicates how the medication is to be used by the patient.


Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortHow the medication should be takenValue of extension
Comments

There are examples where a medication request may include the option of an oral dose or an Intravenous or Intramuscular dose. For example, "Ondansetron 8mg orally or IV twice a day as needed for nausea" or "Compazine® (prochlorperazine) 5-10mg PO or 25mg PR bid prn nausea or vomiting". In these cases, two medication requests would be created that could be grouped together. The decision on which dose and route of administration to use is based on the patient's condition at the time the dose is needed.

Control0..1
This element is affected by the following invariants: ext-1
TypeDosage, date, Meta, Address, Attachment, integer, Count, DataRequirement, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Availability, integer64, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ExtendedContactDetail, CodeableConcept, ParameterDefinition, dateTime, code, string, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be foundhere

0. Extension
Definition

STU3: MedicationRequest.dosageInstruction additional types (Dosage) additional types from child elements (additionalInstruction, asNeeded[x], dose[x], maxDosePerAdministration, maxDosePerLifetime, maxDosePerPeriod, method, patientInstruction, rate[x], route, sequence, site, text, timing)

ShortSTU3: How the medication should be taken additional types
Comments

Element MedicationRequest.dosageInstruction is mapped to FHIR R5 element MedicationRequest.dosageInstruction as SourceIsBroaderThanTarget. The mappings for MedicationRequest.dosageInstruction do not cover the following types: Dosage. The mappings for MedicationRequest.dosageInstruction do not cover the following types based on type expansion: additionalInstruction, asNeeded[x], dose[x], maxDosePerAdministration, maxDosePerLifetime, maxDosePerPeriod, method, patientInstruction, rate[x], route, sequence, site, text, timing. There are examples where a medication request may include the option of an oral dose or an Intravenous or Intramuscular dose. For example, "Ondansetron 8mg orally or IV twice a day as needed for nausea" or "Compazine® (prochlorperazine) 5-10mg PO or 25mg PR bid prn nausea or vomiting". In these cases, two medication requests would be created that could be grouped together. The decision on which dose and route of administration to use is based on the patient's condition at the time the dose is needed.

Control0..*
Is Modifierfalse
2. Extension.url
Control1..1
Fixed Valuehttp://hl7.org/fhir/3.0/StructureDefinition/extension-MedicationRequest.dosageInstruction
4. Extension.value[x]
Definition

Indicates how the medication is to be used by the patient.

ShortHow the medication should be taken
Comments

There are examples where a medication request may include the option of an oral dose or an Intravenous or Intramuscular dose. For example, "Ondansetron 8mg orally or IV twice a day as needed for nausea" or "Compazine® (prochlorperazine) 5-10mg PO or 25mg PR bid prn nausea or vomiting". In these cases, two medication requests would be created that could be grouped together. The decision on which dose and route of administration to use is based on the patient's condition at the time the dose is needed.

Control0..1
TypeDosage, date, Meta, Address, Attachment, integer, Count, DataRequirement, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Availability, integer64, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ExtendedContactDetail, CodeableConcept, ParameterDefinition, dateTime, code, string, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]

Guidance on how to interpret the contents of this table can be foundhere

0. Extension
Definition

STU3: MedicationRequest.dosageInstruction additional types (Dosage) additional types from child elements (additionalInstruction, asNeeded[x], dose[x], maxDosePerAdministration, maxDosePerLifetime, maxDosePerPeriod, method, patientInstruction, rate[x], route, sequence, site, text, timing)

ShortSTU3: How the medication should be taken additional types
Comments

Element MedicationRequest.dosageInstruction is mapped to FHIR R5 element MedicationRequest.dosageInstruction as SourceIsBroaderThanTarget. The mappings for MedicationRequest.dosageInstruction do not cover the following types: Dosage. The mappings for MedicationRequest.dosageInstruction do not cover the following types based on type expansion: additionalInstruction, asNeeded[x], dose[x], maxDosePerAdministration, maxDosePerLifetime, maxDosePerPeriod, method, patientInstruction, rate[x], route, sequence, site, text, timing. There are examples where a medication request may include the option of an oral dose or an Intravenous or Intramuscular dose. For example, "Ondansetron 8mg orally or IV twice a day as needed for nausea" or "Compazine® (prochlorperazine) 5-10mg PO or 25mg PR bid prn nausea or vomiting". In these cases, two medication requests would be created that could be grouped together. The decision on which dose and route of administration to use is based on the patient's condition at the time the dose is needed.

Control0..*
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (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.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typeid
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
4. Extension.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. Extension.url
    Definition

    Source of the definition for the extension code - a logical name or a URL.

    Shortidentifies 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.

    Control1..1
    Typeuri
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    Fixed Valuehttp://hl7.org/fhir/3.0/StructureDefinition/extension-MedicationRequest.dosageInstruction
    8. Extension.value[x]
    Definition

    Indicates how the medication is to be used by the patient.

    ShortHow the medication should be taken
    Comments

    There are examples where a medication request may include the option of an oral dose or an Intravenous or Intramuscular dose. For example, "Ondansetron 8mg orally or IV twice a day as needed for nausea" or "Compazine® (prochlorperazine) 5-10mg PO or 25mg PR bid prn nausea or vomiting". In these cases, two medication requests would be created that could be grouped together. The decision on which dose and route of administration to use is based on the patient's condition at the time the dose is needed.

    Control0..1
    This element is affected by the following invariants: ext-1
    TypeDosage
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))