Health eData 1 Sandbox
0.1.0 - CI Build
Health eData 1 Sandbox
0.1.0 - CI Build
Health eData 1 Sandbox, published by HL7 International / Cross-Group Projects. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/argonautproject/USCDIV7/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-flag | Version: 0.1.0 | |||
| Active as of 2026-05-12 | Maturity Level: 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:
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:
Each Flag Must Support:
This section provides detailed implementation guidance for the US Core Profile to support implementation and certification.
{% include structure-table.md sd=sd source="differential" show_must_support=true show_uscdi=true %}
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.
http://hl7.org/fhir/us/core/StructureDefinition/us-core-flagFlaghttp://hl7.org/fhir/StructureDefinition/Flag| Element | Must Support | Add'l USCDI | Cardinality | Type | Description |
|---|---|---|---|---|---|
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 |
|
↳ categoryslice: 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 | Referencetarget: http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-location target: http://hl7.org/fhir/StructureDefinition/Group target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner target: http://hl7.org/fhir/StructureDefinition/PlanDefinition target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-medication target: 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:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Flag |
0..* | Flag | Key information to flag to healthcare providers | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!SΣ | 1..1 | code | active | inactive | entered-in-error Binding: FlagStatus (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. |
  Slices for category |
SΣ | 0..* | CodeableConcept | Clinical, administrative, etc. Slice: Unordered, Open by value:$this Binding: FlagCategory (example): A general category for flags for filtering/display purposes. |
   category:accommodation |
Σ | 0..1 | CodeableConcept | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Reasonable accommodation category Binding: FlagCategory (example): A general category for flags for filtering/display purposes. Required Pattern: At least the following |
  id |
0..1 | string | Unique id for inter-element referencing | |
 extension |
0..* | Extension | Additional content defined by implementations | |
  coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
 id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-category | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: accommodation | |
| display |
0..1 | string | Representation defined by the system | |
 userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
 text |
0..1 | string | Plain text representation of the concept | |
| code |
SΣ | 1..1 | CodeableConcept | Coded or textual message to display to user Binding: VSAC 2.16.840.1.113762.1.4.1234.567  (extensible): USCDI applicable vocabulary standard: SNOMED CT |
| text |
SΣ | 0..1 | string | Plain text representation of the concept |
 subject |
SΣ | 1..1 | Reference(US Core Patient Profile(9.0.0-ballot) | US Core Location Profile | Group | US Core Organization Profile | US Core Practitioner Profile | PlanDefinition | US Core Medication Profile | US Core Procedure Profile) | Who/What is flag about? |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Flag.status | Base | required | FlagStatus | 📍4.0.1 | FHIR Std. |
| Flag.category | Base | example | Flag Category | 📍4.0.1 | FHIR Std. |
| Flag.category:accommodation | Base | example | Flag Category | 📍4.0.1 | FHIR Std. |
| Flag.code | Base | extensible | http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1234.567 | Not State | Unknown |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Flag | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Flag | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Flag | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Flag | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Flag | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Flag
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Flag |
0..* | Flag | Key information to flag to healthcare providers | |
 status |
S | 1..1 | code | active | inactive | entered-in-error |
| Slices for category |
S | 0..* | CodeableConcept | Clinical, administrative, etc. Slice: Unordered, Open by value:$this |
| category:accommodation |
0..1 | CodeableConcept | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Reasonable accommodation category Required Pattern: At least the following | |
 coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-category | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: accommodation | |
| code |
S | 1..1 | CodeableConcept | Coded or textual message to display to user Binding: VSAC 2.16.840.1.113762.1.4.1234.567 (extensible): USCDI applicable vocabulary standard: SNOMED CT |
| text |
S | 0..1 | string | Plain text representation of the concept |
| subject |
S | 1..1 | Reference(US Core Patient Profile(9.0.0-ballot) | US Core Location Profile | Group | US Core Organization Profile | US Core Practitioner Profile | PlanDefinition | US Core Medication Profile | US Core Procedure Profile) | Who/What is flag about? |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Flag.code | Base | extensible | http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1234.567 | Not State | Unknown |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Flag |
0..* | Flag | Key information to flag to healthcare providers | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | Business identifier | ||||
| status |
?!SΣ | 1..1 | code | active | inactive | entered-in-error Binding: FlagStatus (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. | ||||
| Slices for category |
SΣ | 0..* | CodeableConcept | Clinical, administrative, etc. Slice: Unordered, Open by value:$this Binding: FlagCategory (example): A general category for flags for filtering/display purposes. | ||||
| category:accommodation |
Σ | 0..1 | CodeableConcept | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Reasonable accommodation category Binding: FlagCategory (example): A general category for flags for filtering/display purposes. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-category | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: accommodation | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| code |
SΣ | 1..1 | CodeableConcept | Coded or textual message to display to user Binding: VSAC 2.16.840.1.113762.1.4.1234.567 (extensible): USCDI applicable vocabulary standard: SNOMED CT | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text |
SΣ | 0..1 | string | Plain text representation of the concept | ||||
| subject |
SΣ | 1..1 | Reference(US Core Patient Profile(9.0.0-ballot) | US Core Location Profile | Group | US Core Organization Profile | US Core Practitioner Profile | PlanDefinition | US Core Medication Profile | US Core Procedure Profile) | Who/What is flag about? | ||||
| period |
Σ | 0..1 | Period | Time period when flag is active | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Alert relevant during encounter | ||||
| author |
Σ | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole) | Flag creator | ||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Flag.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Flag.status | Base | required | FlagStatus | 📍4.0.1 | FHIR Std. |
| Flag.category | Base | example | Flag Category | 📍4.0.1 | FHIR Std. |
| Flag.category:accommodation | Base | example | Flag Category | 📍4.0.1 | FHIR Std. |
| Flag.code | Base | extensible | http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1234.567 | Not State | Unknown |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Flag | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Flag | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Flag | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Flag | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Flag | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Flag
Summary
Must-Support: 5 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 3
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Flag |
0..* | Flag | Key information to flag to healthcare providers | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!SΣ | 1..1 | code | active | inactive | entered-in-error Binding: FlagStatus (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. |
| Slices for category |
SΣ | 0..* | CodeableConcept | Clinical, administrative, etc. Slice: Unordered, Open by value:$this Binding: FlagCategory (example): A general category for flags for filtering/display purposes. |
| category:accommodation |
Σ | 0..1 | CodeableConcept | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Reasonable accommodation category Binding: FlagCategory (example): A general category for flags for filtering/display purposes. Required Pattern: At least the following |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-category | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: accommodation | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| code |
SΣ | 1..1 | CodeableConcept | Coded or textual message to display to user Binding: VSAC 2.16.840.1.113762.1.4.1234.567 (extensible): USCDI applicable vocabulary standard: SNOMED CT |
| text |
SΣ | 0..1 | string | Plain text representation of the concept |
| subject |
SΣ | 1..1 | Reference(US Core Patient Profile(9.0.0-ballot) | US Core Location Profile | Group | US Core Organization Profile | US Core Practitioner Profile | PlanDefinition | US Core Medication Profile | US Core Procedure Profile) | Who/What is flag about? |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Flag.status | Base | required | FlagStatus | 📍4.0.1 | FHIR Std. |
| Flag.category | Base | example | Flag Category | 📍4.0.1 | FHIR Std. |
| Flag.category:accommodation | Base | example | Flag Category | 📍4.0.1 | FHIR Std. |
| Flag.code | Base | extensible | http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1234.567 | Not State | Unknown |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Flag | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Flag | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Flag | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Flag | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Flag | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from Flag
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Flag |
0..* | Flag | Key information to flag to healthcare providers | |
| status |
S | 1..1 | code | active | inactive | entered-in-error |
| Slices for category |
S | 0..* | CodeableConcept | Clinical, administrative, etc. Slice: Unordered, Open by value:$this |
| category:accommodation |
0..1 | CodeableConcept | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Reasonable accommodation category Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-category | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: accommodation | |
| code |
S | 1..1 | CodeableConcept | Coded or textual message to display to user Binding: VSAC 2.16.840.1.113762.1.4.1234.567 (extensible): USCDI applicable vocabulary standard: SNOMED CT |
| text |
S | 0..1 | string | Plain text representation of the concept |
| subject |
S | 1..1 | Reference(US Core Patient Profile(9.0.0-ballot) | US Core Location Profile | Group | US Core Organization Profile | US Core Practitioner Profile | PlanDefinition | US Core Medication Profile | US Core Procedure Profile) | Who/What is flag about? |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Flag.code | Base | extensible | http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1234.567 | Not State | Unknown |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Flag |
0..* | Flag | Key information to flag to healthcare providers | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | Business identifier | ||||
| status |
?!SΣ | 1..1 | code | active | inactive | entered-in-error Binding: FlagStatus (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. | ||||
| Slices for category |
SΣ | 0..* | CodeableConcept | Clinical, administrative, etc. Slice: Unordered, Open by value:$this Binding: FlagCategory (example): A general category for flags for filtering/display purposes. | ||||
| category:accommodation |
Σ | 0..1 | CodeableConcept | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Reasonable accommodation category Binding: FlagCategory (example): A general category for flags for filtering/display purposes. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-category | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: accommodation | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| code |
SΣ | 1..1 | CodeableConcept | Coded or textual message to display to user Binding: VSAC 2.16.840.1.113762.1.4.1234.567 (extensible): USCDI applicable vocabulary standard: SNOMED CT | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text |
SΣ | 0..1 | string | Plain text representation of the concept | ||||
| subject |
SΣ | 1..1 | Reference(US Core Patient Profile(9.0.0-ballot) | US Core Location Profile | Group | US Core Organization Profile | US Core Practitioner Profile | PlanDefinition | US Core Medication Profile | US Core Procedure Profile) | Who/What is flag about? | ||||
| period |
Σ | 0..1 | Period | Time period when flag is active | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Alert relevant during encounter | ||||
| author |
Σ | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole) | Flag creator | ||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Flag.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Flag.status | Base | required | FlagStatus | 📍4.0.1 | FHIR Std. |
| Flag.category | Base | example | Flag Category | 📍4.0.1 | FHIR Std. |
| Flag.category:accommodation | Base | example | Flag Category | 📍4.0.1 | FHIR Std. |
| Flag.code | Base | extensible | http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1234.567 | Not State | Unknown |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Flag | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Flag | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Flag | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Flag | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Flag | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Flag
Summary
Must-Support: 5 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 3
Other representations of profile: CSV, Excel, Schematron
IG © 2020+ HL7 International / Cross-Group Projects. Package hl7.fhir.us.healthedata1-sandbox#0.1.0 based on FHIR 4.0.1. Generated 2026-06-10
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change