Skip to content

Flag Profile

Canonical../StructureDefinition/nexus-emr-core-flag
Statusdraft · 1.26.0
BaseFlag (constraint)
SourceFSH · JSON

Nexus EMR profile for Flag, carrying a singleton administrative free-text field about a patient (booking alert or patient note). The patient-flag-type coding discriminates the field; the free text rides on Flag.code.text. Backs the Patient Profile Notes section.

Examples

Booking Alert

Booking alert for Avery Linwood, stored as one active Flag discriminated by the patient-flag-type coding with the field's free text on code.text. Demonstrates the retire-and-replace model (flags are never edited in place)

Flag/flag-avery-booking-alert — claims conformance to Flag Profile

{
  "resourceType": "Flag",
  "id": "flag-avery-booking-alert",
  "meta": {
    "profile": [
      "../StructureDefinition/nexus-emr-core-flag"
    ]
  },
  "text": {
    "status": "generated",
    "div": "<div xmlns='http://www.w3.org/1999/xhtml'><p>Booking alert for Avery Linwood: needs afternoon appointments only, and a longer slot.</p><p>The shape to note: this is a SINGLETON field stored as one active Flag, discriminated by the patient-flag-type coding, with the field's free text on <code>code.text</code>. Flags are never edited in place or deleted -- changing the text retires this Flag to <code>inactive</code> and creates a replacement, so a field's history is the chain of its retired flags. Readers MUST filter to active flags; a retired one no longer backs its field.</p></div>"
  },
  "status": "active",
  "category": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/flag-category",
          "code": "admin",
          "display": "Administrative"
        }
      ]
    }
  ],
  "code": {
    "coding": [
      {
        "system": "../CodeSystem/nexus-emr-patient-flag-type",
        "code": "booking-alert",
        "display": "Booking alert"
      }
    ],
    "text": "Afternoons only -- works nights. Book a double slot; mobility aid needs extra room."
  },
  "subject": {
    "reference": "Patient/avery-linwood",
    "display": "Avery Linwood"
  }
}