StructureDefinition Extension-UKCore-MedicationRepeatInformation

Context of Use MedicationRequest

Canonical_URLStatusCurrent_VersionLast_UpdatedDescriptionProfile_Purpose
https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationRepeatInformationactive2.3.02023-12-07

The specific repeat information of a medication item.

This extension extends the MedicationRequest resource to support the exchange of repeat medication data items.


Tree View

id0..1string
id0..1string
extensionI0..*Extension
url1..1uriFixed Value
valueUnsignedIntunsignedInt
id0..1string
extensionI0..*Extension
url1..1uriFixed Value
valueDateTimedateTime
url1..1uriFixed Value

Detailed Descriptions

Extension
DefinitionMedication repeat information.
Cardinality0...1
Invariants
  • 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()
Mappings
  • rim: n/a
  • rim: N/A
Extension.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Extension.extension
DefinitionMay 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 manageable, 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.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

SlicingUnordered, Open, by url(Value)
Invariants
  • 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()
Mappings
  • rim: n/a
  • rim: N/A
Extension.extension:numberOfPrescriptionsIssued
DefinitionAn integer recording the number of times a repeat prescription has been issued. This integer does not include the original order dispense.
Cardinality0...1
TypeExtension
Aliasextensions, user content
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.

Invariants
  • 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()
Mappings
  • rim: n/a
  • rim: N/A
Extension.extension:numberOfPrescriptionsIssued.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Extension.extension:numberOfPrescriptionsIssued.extension
DefinitionMay 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 manageable, 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.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

SlicingUnordered, Open, by url(Value)
Invariants
  • 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()
Mappings
  • rim: n/a
  • rim: N/A
Extension.extension:numberOfPrescriptionsIssued.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
Typeuri
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.

Fixed Value

numberOfPrescriptionsIssued

Mappings
  • rim: N/A
Extension.extension:numberOfPrescriptionsIssued.value[x]
DefinitionAn integer recording the number of times a repeat prescription has been issued. This integer does not include the original order dispense.
Cardinality1...1
TypeunsignedInt
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
Extension.extension:authorisationExpiryDate
DefinitionThe date a prescriber must review a repeat prescription with the patient. This is distinct from dispenseRequest.validityPeriod.end, which marks when a dispensing cycle ends e.g. in Electronic Repeat Dispensing
Cardinality0...1
TypeExtension
Aliasextensions, user content
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.

Invariants
  • 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()
Mappings
  • rim: n/a
  • rim: N/A
Extension.extension:authorisationExpiryDate.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Extension.extension:authorisationExpiryDate.extension
DefinitionMay 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 manageable, 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.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

SlicingUnordered, Open, by url(Value)
Invariants
  • 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()
Mappings
  • rim: n/a
  • rim: N/A
Extension.extension:authorisationExpiryDate.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
Typeuri
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.

Fixed Value

authorisationExpiryDate

Mappings
  • rim: N/A
Extension.extension:authorisationExpiryDate.value[x]
DefinitionRepeat prescription review date.
Cardinality1...1
TypedateTime
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
Extension.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
Typeuri
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.

Fixed Value

https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationRepeatInformation

Mappings
  • rim: N/A
Extension.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality0...0
Typebase64Binary
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A

Table View

Extension..1
Extension.extension..1
Extension.extension.url..
Extension.extension.value[x]unsignedInt1..
Extension.extension..1
Extension.extension.url..
Extension.extension.value[x]dateTime1..
Extension.url..
Extension.value[x]..0

XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="Extension-UKCore-MedicationRepeatInformation" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationRepeatInformation" />
    <version value="2.3.0" />
    <name value="ExtensionUKCoreMedicationRepeatInformation" />
    <title value="Extension UK Core Medication Repeat Information" />
    <status value="active" />
    <date value="2023-12-07" />
    <publisher value="HL7 UK" />
    <contact>
        <name value="HL7 UK" />
        <telecom>
            <system value="email" />
            <value value="ukcore@hl7.org.uk" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <description value="The specific repeat information of a medication item." />
    <purpose value="This extension extends the MedicationRequest resource to support the exchange of repeat medication data items." />
    <copyright value="Copyright &#169; 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the &quot;License&quot;); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7&#174; FHIR&#174; standard Copyright &#169; 2011+ HL7 The HL7&#174; FHIR&#174; standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html." />
    <fhirVersion value="4.0.1" />
    <mapping>
        <identity value="rim" />
        <uri value="http://hl7.org/v3" />
        <name value="RIM Mapping" />
    </mapping>
    <kind value="complex-type" />
    <abstract value="false" />
    <context>
        <type value="element" />
        <expression value="MedicationRequest" />
    </context>
    <type value="Extension" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
    <derivation value="constraint" />
    <differential>
        <element id="Extension">
            <path value="Extension" />
            <short value="Medication repeat information" />
            <definition value="Medication repeat information." />
            <max value="1" />
        </element>
        <element id="Extension.extension:numberOfPrescriptionsIssued">
            <path value="Extension.extension" />
            <sliceName value="numberOfPrescriptionsIssued" />
            <short value="The specific number of times a repeat prescription has been issued" />
            <definition value="An integer recording the number of times a repeat prescription has been issued. This integer does not include the original order dispense." />
            <max value="1" />
        </element>
        <element id="Extension.extension:numberOfPrescriptionsIssued.url">
            <path value="Extension.extension.url" />
            <fixedUri value="numberOfPrescriptionsIssued" />
        </element>
        <element id="Extension.extension:numberOfPrescriptionsIssued.value[x]">
            <path value="Extension.extension.value[x]" />
            <short value="The specific number of times a repeat prescription has been issued" />
            <definition value="An integer recording the number of times a repeat prescription has been issued. This integer does not include the original order dispense." />
            <min value="1" />
            <type>
                <code value="unsignedInt" />
            </type>
        </element>
        <element id="Extension.extension:authorisationExpiryDate">
            <path value="Extension.extension" />
            <sliceName value="authorisationExpiryDate" />
            <short value="Repeat prescription review date" />
            <definition value="The date a prescriber must review a repeat prescription with the patient. This is distinct from dispenseRequest.validityPeriod.end, which marks when a dispensing cycle ends e.g. in Electronic Repeat Dispensing" />
            <max value="1" />
        </element>
        <element id="Extension.extension:authorisationExpiryDate.url">
            <path value="Extension.extension.url" />
            <fixedUri value="authorisationExpiryDate" />
        </element>
        <element id="Extension.extension:authorisationExpiryDate.value[x]">
            <path value="Extension.extension.value[x]" />
            <short value="Repeat prescription review date" />
            <definition value="Repeat prescription review date." />
            <min value="1" />
            <type>
                <code value="dateTime" />
            </type>
        </element>
        <element id="Extension.url">
            <path value="Extension.url" />
            <fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationRepeatInformation" />
        </element>
        <element id="Extension.value[x]">
            <path value="Extension.value[x]" />
            <max value="0" />
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "Extension-UKCore-MedicationRepeatInformation",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationRepeatInformation",
    "version": "2.3.0",
    "name": "ExtensionUKCoreMedicationRepeatInformation",
    "title": "Extension UK Core Medication Repeat Information",
    "status": "active",
    "date": "2023-12-07",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "ukcore@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "The specific repeat information of a medication item.",
    "purpose": "This extension extends the MedicationRequest resource to support the exchange of repeat medication data items.",
    "copyright": "Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html.",
    "fhirVersion": "4.0.1",
    "mapping":  [
        {
            "identity": "rim",
            "uri": "http://hl7.org/v3",
            "name": "RIM Mapping"
        }
    ],
    "kind": "complex-type",
    "abstract": false,
    "context":  [
        {
            "type": "element",
            "expression": "MedicationRequest"
        }
    ],
    "type": "Extension",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Extension",
                "path": "Extension",
                "short": "Medication repeat information",
                "definition": "Medication repeat information.",
                "max": "1"
            },
            {
                "id": "Extension.extension:numberOfPrescriptionsIssued",
                "path": "Extension.extension",
                "sliceName": "numberOfPrescriptionsIssued",
                "short": "The specific number of times a repeat prescription has been issued",
                "definition": "An integer recording the number of times a repeat prescription has been issued. This integer does not include the original order dispense.",
                "max": "1"
            },
            {
                "id": "Extension.extension:numberOfPrescriptionsIssued.url",
                "path": "Extension.extension.url",
                "fixedUri": "numberOfPrescriptionsIssued"
            },
            {
                "id": "Extension.extension:numberOfPrescriptionsIssued.value[x]",
                "path": "Extension.extension.value[x]",
                "short": "The specific number of times a repeat prescription has been issued",
                "definition": "An integer recording the number of times a repeat prescription has been issued. This integer does not include the original order dispense.",
                "min": 1,
                "type":  [
                    {
                        "code": "unsignedInt"
                    }
                ]
            },
            {
                "id": "Extension.extension:authorisationExpiryDate",
                "path": "Extension.extension",
                "sliceName": "authorisationExpiryDate",
                "short": "Repeat prescription review date",
                "definition": "The date a prescriber must review a repeat prescription with the patient. This is distinct from dispenseRequest.validityPeriod.end, which marks when a dispensing cycle ends e.g. in Electronic Repeat Dispensing",
                "max": "1"
            },
            {
                "id": "Extension.extension:authorisationExpiryDate.url",
                "path": "Extension.extension.url",
                "fixedUri": "authorisationExpiryDate"
            },
            {
                "id": "Extension.extension:authorisationExpiryDate.value[x]",
                "path": "Extension.extension.value[x]",
                "short": "Repeat prescription review date",
                "definition": "Repeat prescription review date.",
                "min": 1,
                "type":  [
                    {
                        "code": "dateTime"
                    }
                ]
            },
            {
                "id": "Extension.url",
                "path": "Extension.url",
                "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicationRepeatInformation"
            },
            {
                "id": "Extension.value[x]",
                "path": "Extension.value[x]",
                "max": "0"
            }
        ]
    }
}

Examples

Repeat Information- An example to illustrate the specific repeat information of a medication item.
Example UKCore-Extension-RepeatInformation