# US Core Flag Profile - Health eData 1 Sandbox v0.1.0

* [**Table of Contents**](toc.md)
* [**Artifacts Summary**](artifacts.md)
* **US Core Flag Profile**

## Resource Profile: US Core Flag Profile 

| | | |
| :--- | :--- | :--- |
| *Official URL*:http://hl7.org/fhir/us/core/StructureDefinition/us-core-flag | *Version*:0.1.0 | |
| Active as of 2026-05-12 | [Maturity Level](http://hl7.org/fhir/versions.html#maturity): 3 | *Computable Name*:USCoreFlag |
| *Other Identifiers:*OID:2.16.840.1.113883.4.642.40.2.42.71 | | |

 
The US Core Flag Profile inherits from the FHIR Flag resource; refer to it for scope and usage definitions. This profile sets minimum expectations for the Flag resource to record, search, and fetch a patient's reasonable accommodations and other patient-related alerts. It identifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource when using this profile, and constrains the way those elements are used. 

**Example Usage Scenarios:**

The following are example usage scenarios for the US Core Flag profile:

* Query for Flag resources belonging to a Patient
* [Record or update] a Patient Flag

### Mandatory and Must Support Data Elements

The following data elements must always be present ([Mandatory] definition) or must be supported if the data is present in the sending system ([Must Support] definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The [Formal Views] below provides the formal summary, definitions, and terminology requirements.

**Each Flag Must Have:**

1. a status
1. a coded or plain text representation of the accommodation
1. who or what the flag is about

**Each Flag Must Support:**

1. a category

### Profile Specific Implementation Guidance

This section provides detailed implementation guidance for the US Core Profile to support implementation and certification.

* **FOO**

### Liquid Script to Generate StructureDefinition All Nice N Pretty Like

{% include structure-table.md sd=sd source="differential" show_must_support=true show_uscdi=true %}

## USCoreFlag — US Core Flag Profile

The US Core Flag Profile inherits from the FHIR Flag resource; refer to it for scope and usage definitions. This profile sets minimum expectations for the Flag resource to record, search, and fetch a patient's reasonable accommodations and other patient-related alerts. It identifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource when using this profile, and constrains the way those elements are used.

* **URL:** `http://hl7.org/fhir/us/core/StructureDefinition/us-core-flag`
* **Version:** 0.1.0
* **Status:** active
* **Kind:** resource
* **Type:** `Flag`
* **Base Definition:** `http://hl7.org/fhir/StructureDefinition/Flag`
* **Derivation:** constraint

### Elements (differential)

| | | | | | |
| :--- | :--- | :--- | :--- | :--- | :--- |
| `Flag` |   |   | 0..* |   | **Key information to flag to healthcare providers**Prospective warnings of potential issues when providing care to the patient. |
| ↳`status` | ✅ |   | 1..1 | `code` | **active | inactive | entered-in-error**Supports basic workflow.**Binding:** `http://hl7.org/fhir/ValueSet/flag-status\|4.0.1` (required) — Indicates whether this flag is active and needs to be displayed to a user, or whether it is no longer needed or was entered in error. |
| ↳`category` | ✅ |   | 0..* | `CodeableConcept` | **Clinical, administrative, etc.**Allows a flag to be divided into different categories like clinical, administrative etc. Intended to be used as a means of filtering which flags are displayed to particular user or in a given context.**Binding:** `http://hl7.org/fhir/ValueSet/flag-category\|4.0.1` (example) — A general category for flags for filtering/display purposes.**Slicing:** discriminator `value@$this` — rules: open |
| ↳`category`slice: `accommodation` |   | ✅ | 0..1 | `CodeableConcept` | **Reasonable accommodation category**Allows a flag to be divided into different categories like clinical, administrative etc. Intended to be used as a means of filtering which flags are displayed to particular user or in a given context.**Binding:** `http://hl7.org/fhir/ValueSet/flag-category\|4.0.1` (example) — A general category for flags for filtering/display purposes.**Pattern (CodeableConcept):** `http://hl7.org/fhir/us/core/CodeSystem/us-core-category#accommodation` |
| ↳`code` | ✅ |   | 1..1 | `CodeableConcept` | **Coded or textual message to display to user**The coded value or textual component of the flag to display to the user.**Binding:** `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1234.567` (extensible) — USCDI applicable vocabulary standard: SNOMED CT |
| ↳`text` | ✅ |   | 0..1 | `string` | **Plain text representation of the concept**A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
| ↳`subject` | ✅ |   | 1..1 | `Reference`target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-patienttarget: http://hl7.org/fhir/us/core/StructureDefinition/us-core-locationtarget: http://hl7.org/fhir/StructureDefinition/Grouptarget: http://hl7.org/fhir/us/core/StructureDefinition/us-core-organizationtarget: http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionertarget: http://hl7.org/fhir/StructureDefinition/PlanDefinitiontarget: http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationtarget: http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure | **Who/What is flag about?**The patient, location, group, organization, or practitioner etc. this is about record this flag is associated with. |

```


## USCoreFlag — US Core Flag Profile

The US Core Flag Profile inherits from the FHIR Flag resource; refer to it for scope and usage definitions. This profile sets minimum expectations for the Flag resource to record, search, and fetch a patient's reasonable accommodations and other patient-related alerts. It identifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource when using this profile, and constrains the way those elements are used.

- **URL:** `http://hl7.org/fhir/us/core/StructureDefinition/us-core-flag`
- **Version:** 0.1.0
- **Status:** active
- **Kind:** resource
- **Type:** `Flag`
- **Base Definition:** `http://hl7.org/fhir/StructureDefinition/Flag`
- **Derivation:** constraint


### Elements (differential)

| Element | Must Support | Add'l USCDI | Cardinality | Type | Description |
|---|:---:|:---:|---|---|---|
| `Flag` |  |  | 0..* |  | **Key information to flag to healthcare providers**<br/>Prospective warnings of potential issues when providing care to the patient. |
| <span style="padding-left: 1.5em;">↳</span> `status` | ✅ |  | 1..1 | `code` | **active \| inactive \| entered-in-error**<br/>Supports basic workflow.<br/><span style="font-size: 0.85em;">**Binding:** `http://hl7.org/fhir/ValueSet/flag-status\|4.0.1` (required) — Indicates whether this flag is active and needs to be displayed to a user, or whether it is no longer needed or was entered in error.</span> |
| <span style="padding-left: 1.5em;">↳</span> `category` | ✅ |  | 0..* | `CodeableConcept` | **Clinical, administrative, etc.**<br/>Allows a flag to be divided into different categories like clinical, administrative etc. Intended to be used as a means of filtering which flags are displayed to particular user or in a given context.<br/><span style="font-size: 0.85em;">**Binding:** `http://hl7.org/fhir/ValueSet/flag-category\|4.0.1` (example) — A general category for flags for filtering/display purposes.</span><br/><span style="font-size: 0.85em;">**Slicing:** discriminator `value@$this` — rules: open</span> |
| <span style="padding-left: 1.5em;">↳</span> `category`<br/><span style="font-size: 0.85em;">slice: `accommodation`</span> |  | ✅ | 0..1 | `CodeableConcept` | **Reasonable accommodation category**<br/>Allows a flag to be divided into different categories like clinical, administrative etc. Intended to be used as a means of filtering which flags are displayed to particular user or in a given context.<br/><span style="font-size: 0.85em;">**Binding:** `http://hl7.org/fhir/ValueSet/flag-category\|4.0.1` (example) — A general category for flags for filtering/display purposes.</span><br/><span style="font-size: 0.85em;">**Pattern (CodeableConcept):** `http://hl7.org/fhir/us/core/CodeSystem/us-core-category#accommodation`</span> |
| <span style="padding-left: 1.5em;">↳</span> `code` | ✅ |  | 1..1 | `CodeableConcept` | **Coded or textual message to display to user**<br/>The coded value or textual component of the flag to display to the user.<br/><span style="font-size: 0.85em;">**Binding:** `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1234.567` (extensible) — USCDI applicable vocabulary standard: SNOMED CT</span> |
| <span style="padding-left: 3.0em;">↳</span> `text` | ✅ |  | 0..1 | `string` | **Plain text representation of the concept**<br/>A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
| <span style="padding-left: 1.5em;">↳</span> `subject` | ✅ |  | 1..1 | `Reference`<br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient</span><br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-location</span><br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/StructureDefinition/Group</span><br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization</span><br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner</span><br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/StructureDefinition/PlanDefinition</span><br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-medication</span><br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure</span> | **Who/What is flag about?**<br/>The patient, location, group, organization, or practitioner etc. this is about record this flag is associated with. |





```

**Usages:**

* Examples for this Profile: [Flag/flag-asl-interpreter](Flag-flag-asl-interpreter.md), [Flag/flag-service-animal](Flag-flag-service-animal.md) and [Flag/flag-wheelchair-assist](Flag-flag-wheelchair-assist.md)

You can also check for [usages in the FHIR IG Statistics](https://packages2.fhir.org/xig/resource/hl7.fhir.us.healthedata1-sandbox|current/StructureDefinition/StructureDefinition-us-core-flag.json)

### Formal Views of Profile Content

 [Description of Profiles, Differentials, Snapshots and how the different presentations work](http://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#structure-definitions). 

 

Other representations of profile: [CSV](StructureDefinition-us-core-flag.csv), [Excel](StructureDefinition-us-core-flag.xlsx), [Schematron](StructureDefinition-us-core-flag.sch) 



## Resource Content

```json
{
  "resourceType" : "StructureDefinition",
  "id" : "us-core-flag",
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger" : 3
  }],
  "url" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-flag",
  "identifier" : [{
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.40.2.42.71"
  }],
  "version" : "0.1.0",
  "name" : "USCoreFlag",
  "title" : "US Core Flag Profile",
  "status" : "active",
  "experimental" : false,
  "date" : "2026-05-12",
  "publisher" : "HL7 International / Cross-Group Projects",
  "contact" : [{
    "name" : "HL7 International / Cross-Group Projects",
    "telecom" : [{
      "system" : "url",
      "value" : "http://www.hl7.org/Special/committees/cgp"
    },
    {
      "system" : "email",
      "value" : "cgp@lists.HL7.org"
    }]
  }],
  "description" : "The US Core Flag Profile inherits from the FHIR Flag resource; refer to it for scope and usage definitions. This profile sets minimum expectations for the Flag resource to record, search, and fetch a patient's reasonable accommodations and other patient-related alerts. It identifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource when using this profile, and constrains the way those elements are used.",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "urn:iso:std:iso:3166",
      "code" : "US"
    }]
  }],
  "fhirVersion" : "4.0.1",
  "mapping" : [{
    "identity" : "rim",
    "uri" : "http://hl7.org/v3",
    "name" : "RIM Mapping"
  },
  {
    "identity" : "w5",
    "uri" : "http://hl7.org/fhir/fivews",
    "name" : "FiveWs Pattern Mapping"
  }],
  "kind" : "resource",
  "abstract" : false,
  "type" : "Flag",
  "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Flag",
  "derivation" : "constraint",
  "differential" : {
    "element" : [{
      "id" : "Flag",
      "path" : "Flag"
    },
    {
      "id" : "Flag.status",
      "path" : "Flag.status",
      "mustSupport" : true
    },
    {
      "id" : "Flag.category",
      "path" : "Flag.category",
      "slicing" : {
        "discriminator" : [{
          "type" : "value",
          "path" : "$this"
        }],
        "ordered" : false,
        "rules" : "open"
      },
      "mustSupport" : true
    },
    {
      "id" : "Flag.category:accommodation",
      "extension" : [{
        "url" : "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement",
        "valueBoolean" : true
      }],
      "path" : "Flag.category",
      "sliceName" : "accommodation",
      "short" : "𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Reasonable accommodation category",
      "min" : 0,
      "max" : "1",
      "patternCodeableConcept" : {
        "coding" : [{
          "system" : "http://hl7.org/fhir/us/core/CodeSystem/us-core-category",
          "code" : "accommodation"
        }]
      }
    },
    {
      "id" : "Flag.code",
      "path" : "Flag.code",
      "mustSupport" : true,
      "binding" : {
        "strength" : "extensible",
        "description" : "USCDI applicable vocabulary standard: SNOMED CT",
        "valueSet" : "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1234.567"
      }
    },
    {
      "id" : "Flag.code.text",
      "path" : "Flag.code.text",
      "min" : 0,
      "max" : "1",
      "mustSupport" : true
    },
    {
      "id" : "Flag.subject",
      "path" : "Flag.subject",
      "type" : [{
        "code" : "Reference",
        "targetProfile" : ["http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient",
        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-location",
        "http://hl7.org/fhir/StructureDefinition/Group",
        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization",
        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner",
        "http://hl7.org/fhir/StructureDefinition/PlanDefinition",
        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medication",
        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure"]
      }],
      "mustSupport" : true
    }]
  }
}

```
