Important: All content in this FHIR Implementation Guide is under development

DataStandardsWales-MedicationDispense

The MedicationDispense resource is a record of a medication that is dispensed to a patient.

The DataStandardsWales-MedicationDispense profile is derived from the UK Core MedicationDispense Profile. It defines additional rules for use within health and care organisations in Wales.

Formal Views of Profile Content

useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Data Standards Wales Organization Profile)
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
statusS Σ ?!1..1codeBinding
systemΣ1..1uri
versionΣ0..1string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
systemΣ1..1uri
versionΣ0..1string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
medicationCodeableConceptCodeableConcept
medicationReferenceReference(Data Standards Wales Medication Profile)
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Data Standards Wales Organization Profile)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Data Standards Wales Organization Profile)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Data Standards Wales Organization Profile)
displayΣ0..1string
function0..1CodeableConcept
referenceΣ I1..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Data Standards Wales Organization Profile)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Data Standards Wales Organization Profile)
displayΣ1..1string
referenceΣ I1..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Data Standards Wales Organization Profile)
displayΣ0..1string
systemΣ1..1uri
versionΣ0..1string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
valueΣ1..1decimal
comparatorΣ ?!0..0codeBinding
unitΣ1..1string
systemΣ I1..1uri
codeΣ1..1code
daysSupplyS I0..1SimpleQuantity
whenPreparedS Σ0..1dateTime
whenHandedOverS0..1dateTime
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Data Standards Wales Organization Profile)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Data Standards Wales Organization Profile)
displayΣ0..1string
authorStringstring
authorReferenceReference(UK Core Organization | UK Core Practitioner | UK Core Patient | UK Core RelatedPerson)
timeΣ0..1dateTime
textΣ1..1markdown
sequenceΣ0..1integer
textΣ0..1string
additionalInstructionΣ0..*CodeableConcept
patientInstructionΣ0..1string
timingΣ0..1Timing
asNeededBooleanboolean
asNeededCodeableConceptCodeableConcept
siteΣ0..1CodeableConceptBinding
routeΣ0..1CodeableConceptBinding
methodΣ0..1CodeableConceptBinding
typeΣ0..1CodeableConcept
doseRangeRange
doseQuantitySimpleQuantity
rateRatioRatio
rateRangeRange
rateQuantitySimpleQuantity
maxDosePerPeriodΣ I0..1Ratio
maxDosePerAdministrationΣ I0..1SimpleQuantity
maxDosePerLifetimeΣ I0..1SimpleQuantity
wasSubstituted1..1boolean
type0..1CodeableConcept
reason0..*CodeableConcept
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Data Standards Wales Organization Profile)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Data Standards Wales Organization Profile)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Data Standards Wales Organization Profile)
displayΣ0..1string
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Data Standards Wales Organization Profile)
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
statusS Σ ?!1..1codeBinding
systemΣ1..1uri
versionΣ0..1string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
systemΣ1..1uri
versionΣ0..1string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
medicationCodeableConceptCodeableConcept
medicationReferenceReference(Data Standards Wales Medication Profile)
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Data Standards Wales Organization Profile)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Data Standards Wales Organization Profile)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Data Standards Wales Organization Profile)
displayΣ0..1string
function0..1CodeableConcept
referenceΣ I1..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Data Standards Wales Organization Profile)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Data Standards Wales Organization Profile)
displayΣ1..1string
referenceΣ I1..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Data Standards Wales Organization Profile)
displayΣ0..1string
systemΣ1..1uri
versionΣ0..1string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
valueΣ1..1decimal
comparatorΣ ?!0..0codeBinding
unitΣ1..1string
systemΣ I1..1uri
codeΣ1..1code
daysSupplyS I0..1SimpleQuantity
whenPreparedS Σ0..1dateTime
whenHandedOverS0..1dateTime
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Data Standards Wales Organization Profile)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Data Standards Wales Organization Profile)
displayΣ0..1string
authorStringstring
authorReferenceReference(UK Core Organization | UK Core Practitioner | UK Core Patient | UK Core RelatedPerson)
timeΣ0..1dateTime
textΣ1..1markdown
sequenceΣ0..1integer
textΣ0..1string
additionalInstructionΣ0..*CodeableConcept
patientInstructionΣ0..1string
timingΣ0..1Timing
asNeededBooleanboolean
asNeededCodeableConceptCodeableConcept
siteΣ0..1CodeableConceptBinding
routeΣ0..1CodeableConceptBinding
methodΣ0..1CodeableConceptBinding
typeΣ0..1CodeableConcept
doseRangeRange
doseQuantitySimpleQuantity
rateRatioRatio
rateRangeRange
rateQuantitySimpleQuantity
maxDosePerPeriodΣ I0..1Ratio
maxDosePerAdministrationΣ I0..1SimpleQuantity
maxDosePerLifetimeΣ I0..1SimpleQuantity
wasSubstituted1..1boolean
type0..1CodeableConcept
reason0..*CodeableConcept
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Data Standards Wales Organization Profile)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Data Standards Wales Organization Profile)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Data Standards Wales Organization Profile)
displayΣ0..1string
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Data Standards Wales Organization Profile)
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
statusS Σ ?!1..1codeBinding
systemΣ1..1uri
versionΣ0..1string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
systemΣ1..1uri
versionΣ0..1string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
medicationCodeableConceptCodeableConcept
medicationReferenceReference(Data Standards Wales Medication Profile)
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Data Standards Wales Organization Profile)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Data Standards Wales Organization Profile)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Data Standards Wales Organization Profile)
displayΣ0..1string
function0..1CodeableConcept
referenceΣ I1..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Data Standards Wales Organization Profile)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Data Standards Wales Organization Profile)
displayΣ1..1string
referenceΣ I1..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Data Standards Wales Organization Profile)
displayΣ0..1string
systemΣ1..1uri
versionΣ0..1string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
valueΣ1..1decimal
comparatorΣ ?!0..0codeBinding
unitΣ1..1string
systemΣ I1..1uri
codeΣ1..1code
daysSupplyS I0..1SimpleQuantity
whenPreparedS Σ0..1dateTime
whenHandedOverS0..1dateTime
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Data Standards Wales Organization Profile)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Data Standards Wales Organization Profile)
displayΣ0..1string
authorStringstring
authorReferenceReference(UK Core Organization | UK Core Practitioner | UK Core Patient | UK Core RelatedPerson)
timeΣ0..1dateTime
textΣ1..1markdown
sequenceΣ0..1integer
textΣ0..1string
additionalInstructionΣ0..*CodeableConcept
patientInstructionΣ0..1string
timingΣ0..1Timing
asNeededBooleanboolean
asNeededCodeableConceptCodeableConcept
siteΣ0..1CodeableConceptBinding
routeΣ0..1CodeableConceptBinding
methodΣ0..1CodeableConceptBinding
typeΣ0..1CodeableConcept
doseRangeRange
doseQuantitySimpleQuantity
rateRatioRatio
rateRangeRange
rateQuantitySimpleQuantity
maxDosePerPeriodΣ I0..1Ratio
maxDosePerAdministrationΣ I0..1SimpleQuantity
maxDosePerLifetimeΣ I0..1SimpleQuantity
wasSubstituted1..1boolean
type0..1CodeableConcept
reason0..*CodeableConcept
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Data Standards Wales Organization Profile)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Data Standards Wales Organization Profile)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Data Standards Wales Organization Profile)
displayΣ0..1string
  • Currently under development
  • Mandatory and Must Support Data Elements

    When an element is mandatory (min=1), the data is expected to always be present. Elements marked with an S must be supported by both producing and receiving systems and SHOULD be populated if the data exists.

    Each MedicationDispense must have:

    1. status
    2. medication

    Each MedicationDispense must support:

    1. identifier
    2. statusReason
    3. subject
    4. performer
    5. authorizingPrescription
    6. type
    7. quantity
    8. daysSupply
    9. whenPrepared
    10. whenHandedOver
    11. dosageInstructions

    Implementation Guidance

    • The extensions listed below allow a number of the data elements listed above to be supported where not currently supported by the FHIR standard:
      • Data Standards Wales extensions:
        • Currently under development

    • The MedicationDispense.status field SHALL be populated with one of the following values defined by the FHIR standard:
      • active
      • completed
      • entered-in-error
      • intended
      • stopped
      • on-hold
      • unknown
      • not-taken

    • The MedicationDispense.medication field SHALL be populated. This will be populated with either a dm+d code to indicate the medication, or reference to a medication resource. If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended.

    • The MedicationDispense.subject field SHALL be populated.

    Example MedicationDispenses

    The following medication statement resources are provided within this guide:

    • Currently under development

    Mandatory Search Parameters

    The following search parameters and search parameter combinations SHALL be supported:

    1. SHALL support searching for all MedicationDispenses using the subject search parameter:
      GET [base]/MedicationDispense?subject={Type/}[id]
      
      Example:
      1. GET [base]/MedicationDispense?subject=Patient/23
      2. GET [base]/MedicationDispense?subject:Patient.identifier=https://fhir.nhs.uk/Id/nhs-number|9912003444
        Implementation Notes: Fetches a bundle of all MedicationDispense resources for the specified patient (how to search by reference)

    Optional Search Parameters

    1. SHOULD support searching using the combination of the subject and status search parameters:

      GET [base]/MedicationDispense?subject={Type/}[id]&status={system|}[code]
      GET [base]/MedicationDispense?subject:Patient.identifier={system|}[code]&status={system|}[code]
      

      Example:

      1. GET \[base\]/MedicationDispense?subject=Patient/23&status=http://hl7.org/fhir/CodeSystem/medication-dispense-status|active
      2. GET \[base\]/MedicationDispense?subject:Patient.identifier=https://fhir.nhs.uk/Id/nhs-number|9912003444&status=http://hl7.org/fhir/CodeSystem/medication-dispense-status|active

        Implementation Notes: Fetches a bundle of all MedicationDispense resources for the specified subject and status code. (how to search by reference and how to search by token)