How-to

Configure the cards on a patient's details

Set which cards a care team sees when it opens a patient from a panel, and what each field reads from the patient's FHIR data, as a JSON configuration.

The cards shown when a patient is opened from a panel are set per panel, as JSON. Each field reads its value with a FHIRPath expression over the patient's FHIR data.

To edit them, with the Panels Admin, Org Admin or Panels Builder role, open the panel, select Configuration (the gear button at the bottom of the panel), open the Cards tab, edit the JSON and select Save Changes.

Card structure

[
  {
    "name": "Patient demographics",
    "color": "blue",
    "fields": [
      { "label": "Date of birth", "key": "birth_date", "fhirPath": "birthDate", "display": "date" },
      { "label": "Phone", "key": "phone", "fhirPath": "telecom.where(system='phone').value" }
    ],
    "buttons": [
      {
        "label": "Open in the EMR",
        "fhirPath": "entry.resource.ofType(Patient).extension.where(url='https://example.org/emr-link').valueUrl",
        "afterField": "phone"
      }
    ]
  }
]
PropertyRequiredWhat it does
nameYesThe card's title
fieldsYesAt least one field, each with a label, a key unique within the card, a fhirPath and an optional display
colorNoblue, red, green, purple, orange, yellow, gray, or a hex code
displayNoThe display mode for every field on the card: auto (default), compact, date, datetime, rich (renders HTML) or form (renders form output, such as questionnaire answers)
buttonsNoLinks that open in a new tab, placed after the field named in afterField. Leave the property out rather than sending an empty list.

A date field shows the raw ISO string unless its display is date or datetime.

How a path is evaluated

Each path runs against the open patient's Patient, the Task when opened from a task, the CarePlan and its first ServiceRequest, and the patient's Observations, Encounters, Communications and Coverage. Another resource type named in ofType(X) is added when it links to the patient, such as Condition or MedicationRequest. Compositions and Appointments are never available.

  • A plain path, such as birthDate, returns the first resource that matches, so use it only for a value that exists on one resource type.
  • A path starting entry.resource. returns every match across all resources. Narrow it with .where(...) and .first().
  • .resolve() finds only resources in that list, so a Practitioner, Organization or Location reference resolves to nothing. Use the reference's display instead.

A card whose fields all come back empty is hidden, so a wrong path shows up as a missing card.

Next steps

Next: Panel column expressions, for the date functions a path can use.

On this page