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

DataStandardsWales-MedicationList

The List resource is a curated collection of resources. The Medication List profile is intended to provide a snapshot view of a patient's medications.

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

Formal Views of Profile Content

careSettingTypeI0..1Extension(CodeableConcept)
listWarningCodeI0..*Extension(code)
relatedProblemHeaderI0..1Extension(Complex)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
statusS Σ ?!1..1codeBinding
modeS Σ ?!1..1codeBinding
titleΣ0..1string
codeS Σ1..1CodeableConceptBindingFixed Value
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
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
dateΣ0..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(UK Core Organization)
displayΣ0..1string
orderedBy0..1CodeableConceptBinding
authorStringstring
authorReferenceReference(UK Core Patient | UK Core Organization | UK Core Practitioner | UK Core RelatedPerson)
timeΣ0..1dateTime
textΣ1..1markdown
flag0..1CodeableConcept
deleted?! I0..1boolean
date0..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(UK Core Organization)
displayΣ0..1string
emptyReasonI0..1CodeableConceptBinding
careSettingTypeI0..1Extension(CodeableConcept)
listWarningCodeI0..*Extension(code)
relatedProblemHeaderI0..1Extension(Complex)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
statusS Σ ?!1..1codeBinding
modeS Σ ?!1..1codeBinding
titleΣ0..1string
codeS Σ1..1CodeableConceptBindingFixed Value
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
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
dateΣ0..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(UK Core Organization)
displayΣ0..1string
orderedBy0..1CodeableConceptBinding
authorStringstring
authorReferenceReference(UK Core Patient | UK Core Organization | UK Core Practitioner | UK Core RelatedPerson)
timeΣ0..1dateTime
textΣ1..1markdown
flag0..1CodeableConcept
deleted?! I0..1boolean
date0..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(UK Core Organization)
displayΣ0..1string
emptyReasonI0..1CodeableConceptBinding
careSettingTypeI0..1Extension(CodeableConcept)
listWarningCodeI0..*Extension(code)
relatedProblemHeaderI0..1Extension(Complex)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
statusS Σ ?!1..1codeBinding
modeS Σ ?!1..1codeBinding
titleΣ0..1string
codeS Σ1..1CodeableConceptBindingFixed Value
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
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
dateΣ0..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(UK Core Organization)
displayΣ0..1string
orderedBy0..1CodeableConceptBinding
authorStringstring
authorReferenceReference(UK Core Patient | UK Core Organization | UK Core Practitioner | UK Core RelatedPerson)
timeΣ0..1dateTime
textΣ1..1markdown
flag0..1CodeableConcept
deleted?! I0..1boolean
date0..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(UK Core Organization)
displayΣ0..1string
emptyReasonI0..1CodeableConceptBinding

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 Medication List must have:

  1. A status
  2. A mode
  3. A code value of 'Medications and medical devices' *
  4. A subject (patient)

* the list's code is fixed to 'Medications and medical devices' for the current scope of functionality - in further iterations the code field is likely to be bound to a value set of other medication list types

Each Medication List must support:

  1. An encounter
  2. A source to indicate who defined the list contents

Implementation Guidance

  • The mode is expected to be 'snapshot' to indicate that the list represents a snapshot of a medications potentially derived from another sources

  • The List.code field SHALL be 'medication'

  • The resource SHALL include a reference to the subject (patient)

Example Medication Lists

The following example resource is provided within this guide: GP medications list, Outpatient medications list, medications on admission, inpatient medications list,
medications on discharge. These examples are provided as part of a wider patient journey scenario, which is described here.

Mandatory Search Parameters

For systems that provide a FHIR API for medications, the following search parameters and search parameter combinations SHALL be supported:

  1. SHALL support searching using a combination of the code and patient and search parameters:

    GET [base]/List?code={system|}[code]&patient={system|}[code]
    

    Example:

    1. GET [base]/List?code=http://snomed.info/sct|91930004&patient=32188444

    Implementation Notes: Fetches a bundle of any List resources for the specified code and patient (how to search by token and how to search by reference).

Optional Search Parameters

For systems that provide a FHIR API for medications, the following search parameters and search parameter combinations SHOULD be supported:

  1. SHOULD support searching using a combination of the code and chained patient.identifier and search parameters:

    GET [base]/List?code={system|}[code]&patient.identifier=[id]
    

    Example:

    1. GET [base]/List?code=http://snomed.info/sct|91930004&patient.identifier=https://fhir.nhs.uk/Id/nhs-number|1192335566

    Implementation Notes: Fetches a bundle of any List resources for the specified code and patient identifier (e.g. NHS number) (how to search by token, how to search by reference and http://hl7.org/fhir/R4/search.html#chaining).