Saying ‘No’ with FHIR: The List resource

Was cruising the Stack Overflow site looking at FHIR questions (as you do) and I came across this question about how to indicate that a person has no known allergies. It was answered by Lloyd who stated that you should use the List resource to do so.

This is such a common requirement in healthcare that I thought it was worth a short post on.

And, to be explicit I’m referring to requirements like being able to state:

  • No known allergies
  • No usual medications
  • No problems known

And not the issue of ‘incomplete’ data that the ‘nullFlavor’ attribute of v3 was supposed to address. This is a complex – and controversial – topic that Grahame has addressed in this post. FHIR has taken the perspective that the complexities of  nullFlavor outweights its value ‘for the 80%’. When it is important, then a resource can either define a specific property (e.g. ‘Date of Birth not known’) or an extension could be used.

Now we’ve already talked about the use of a List when representing a list of Medications where we discussed the advantages that a List gives over a simple query of resources, but we didn’t talk specifically about its value when wanting to explicitly state that the person was not on any regular medications.

The List property that you use is called ‘emptyReason’, and it’s a CodeableConcept which has the following possible values:

  • nilknown
  • notasked
  • withheld
  • notstarted
  • closed

(refer to the spec for a description of what these mean, though it’s pretty obvious… Incidentally, the type of this property is incomplete – which means that there is a set of values that most people agree is correct, but it is permissible to use other codes if needed).

You can only use the emptyReason if the list itself is empty (which makes sense).

The List has particular value in a Document as many of the sections will actually be lists of things (like lab tests, family medications, interventions etc), so it’s very helpful to be able to indicate ‘no known <resource>’. For other resources that don’t use Lists – like the Family History or relevant past history – then you’d need to use an extension. For example, you might want to add an extension to a document section that points to the same binding as the emptyReason so you could state, for example, no known family history.

Representing a Patients list of Medications in FHIR

An interesting use case for FHIR is maintaining a list of a patients medications – i.e. the medications that they should be taking on a regular basis. Most EMR (Electronic Medical Record) systems will maintain such a list.

Each medication will have it’s own properties (such as drug name, dosage, how often to take, period of use and so forth), but for the purposes of this post we’ll focus on how to maintain the list on a day to day basis – including changes to the list – and consider the details of representing a single medication in a later post.

Knowing this list when treating a patient is, of course, of critical importance in healthcare as ‘medication related incidents’ – ranging from minor drug reactions through hospital admission and even death is a common cause of injury to the patient, as well as massive costs to the health system.

It is also important to know the history of changes to the list – i.e. when medications have been changed/stopped and new ones added, who made the change and the reasons why these changes have occurred. In some jurisdictions, this is called ‘reconciling’ the list from different sources of medication information such as dispense and administration information.

To represent this in FHIR, we’re going to need a number of resources.

Obviously we’ll need those that describe each medication. This is the MedicationPrescription resource that records the details of how a single medication should be taken. It includes references to the medication resource (representing the drug), the patient and the prescriber.

To represent the list that is active at any one time, we have a number of options.

Option 1: Query the MedicationPrescription resources for a patient

Each MedicationPrescription resource has a ‘status’ property whose value can be active, paused, completed or nullified. One option then is to get a list of all MedicationPrescription resources that have an active status like this:

GET /Patient/100/MedicationPrescription?status=active

(This uses the compartment feature to retrieve active MedicationPrescription resources for the patient with the ID of 100).

This would certainly work – but it becomes difficult to track changes over time – especially the reason for change.

Option 2: The document

Another option would be to place the medications in a FHIR document. We could have a section for the initial list of drugs and another section for the changed list of drugs. The advantage of this approach is that we can record the name of the person making the change, dates, locations etc. The disadvantage is that it’s a somewhat complex approach – requiring submitters and consumers to create and read documents.

Option 3: The List

There is a third approach that allows us to record these other data items as well as the actual list of medications – the List resource. This resource has been specifically created to maintain lists like this, and offers the following properties:

  • The type of list (we’ll use the LOINC code for ‘history of medication use’ to be consistent with CCDA). This is the code property, and is a codeableConcept datatype
  • The subject of the list – which will be a reference to the Patient resource
  • The source of the list. In this case it will be a reference to the Practitioner who created the list. The cool thing here is that when the list changes, we’ll create a new version of the list setting the source property to the Practitioner who changed it.
  • The date the list (or this version of the list) was created.
  • The mode of the list. In our scenario we’ll set this to ‘working’ as we intend it to be the on-going master list but there are other values that can be of use – eg ‘snapshot’ at a point in time which we may want to use in a referral for example.

Then there are any number of entries in the list. Each entry represents a single medication in the list, and has the following properties:

  • A reference to the medicationPrescription.
  • A flag for the entry. This allows us to indicate the nature of any change to the item between versions of the list – which is incredibly useful in reconciliation situations, or in Use Cases like representing the changes in medication when a patient is discharged from hospital. For example, one of the options could be ‘ceased’ to indicate that the patient was taking the medication on admission, but it was stopped while in hospital.
  • The deleted property. This allows us to explicitly state that this item is no longer active – it has been discontinued. In our case when we stop a medication we will also set the flag and the status in the

One thing that is missing in the entry is the reason for any change. For this we’ll add an extension to the entry element with a datatype of CodeableConcept and we’ll define a set of common reasons why a change occurred. In the example the extension is defined in a profile located at profile/mlomChangeReason

Putting all this together, the following example shows a medication list with two items:

  • Atenolol – which has been stopped due to an allergic reaction.
  • Labetolol – which was started in it’s place.

so the patient is actually only taking Labetolol. If you wanted the details of each prescription, you would get it from the reference in the list.
The list was created by Dr Welby on November 1st, 2011 for Mr I. Amanexample.

&lt;?xml version=&quot;1.0&quot; encoding=&quot;utf-16&quot;?&gt;
&lt;!-- An example showinf a single item in the list - atenolol. As it is cancelled (due to an 
  allergic reaction), we know that the patient is not taking any medicines (as far as we know)--&gt;
&lt;List xmlns=&quot;;&gt;
    &lt;status value=&quot;generated&quot;/&gt;
    &lt;div xmlns=&quot;;&gt;
        &lt;li&gt;Atenolol 50mg at night was stopped due to an allergis reaction&lt;/li&gt;
        &lt;li&gt;Labetolol 50mg at night was started as a replacement&lt;/li&gt;
  &lt;!-- This is the list Code - udentifying it as a list of medications --&gt;
      &lt;system value=&quot;;/&gt;
      &lt;code value=&quot;10160-0&quot;/&gt;
      &lt;display value=&quot;History of Medication Use&quot;/&gt;
    &lt;text value=&quot;Medication List&quot;/&gt;
  &lt;!-- The patient the list refers to --&gt;
    &lt;reference value=&quot;Patient/example&quot;/&gt;
    &lt;display value=&quot;Mr I Amanexample&quot;/&gt;
  &lt;!-- who created the list --&gt;
    &lt;reference value=&quot;Practitioner/100&quot;/&gt;
    &lt;display value=&quot;Dr Welby&quot;/&gt;
  &lt;date value=&quot;2013-11-01&quot;/&gt;
  &lt;mode value='working'/&gt;
  &lt;!-- The first medication entry --&gt;
    &lt;!-- The reason for change --&gt;
      &lt;url value=&quot;profile/mlomChangeReason&quot;/&gt;
          &lt;system value=&quot;urn:oid:;/&gt;
          &lt;code value=&quot;ar&quot;/&gt;
          &lt;display value=&quot;Allergic Reaction&quot;/&gt;
        &lt;text value=&quot;Developed a rash shortly after starting&quot;/&gt;
    &lt;!-- Indicates this is a concelled medication --&gt;
        &lt;system value=&quot;urn:oid:;/&gt;
        &lt;code value=&quot;03&quot;/&gt;
        &lt;display value=&quot;Cancelled&quot;/&gt;
    &lt;!-- So any consumner of this resource knows it is a cancelled med. The deleted property is a code with
    a fixed set of values, whereaes the flag is a codeableConcept, and the meaning depends on the terminology used.
    Every FHIR consumer MUST understand what a deleted property means...--&gt;
    &lt;deleted value=&quot;true&quot;/&gt;
    &lt;date value=&quot;2013-11-01&quot;/&gt;
      &lt;!-- The reference is to the actual prescription resource. This will have details of dose, prescriber etc. --&gt;
      &lt;reference value=&quot;MedicationPrescription/100&quot;/&gt;
      &lt;display value=&quot;Atelolol 50mg at night&quot;/&gt;
        &lt;system value=&quot;urn:oid:;/&gt;
        &lt;code value=&quot;04&quot;/&gt;
        &lt;display value=&quot;Prescribed&quot;/&gt;
      &lt;text value=&quot;Started&quot;/&gt;
    &lt;deleted value=&quot;true&quot;/&gt;
    &lt;date value=&quot;2013-11-01&quot;/&gt;
    &lt;!-- The reference is to the actual prescription resource. This will have details of dose, prescriber etc. --&gt;
      &lt;reference value=&quot;MedicationPrescription/101&quot;/&gt;
      &lt;display value=&quot;Labetolol 10mg at night&quot;/&gt;

We can retrieve this list as follows:

GET /Patient/100/List?code=10160-0


  • This is actually a query in FHIR, so would return a bundle containing the List resource – and there should only ever be one that matches for a patient.

In the next post, we’ll look at how we can record changes to the medication list, using the versioning mechanism in FHIR, as well as updates to the medicationPrescription resources as well.