Uzbekistan Digital Health Platform
0.13.0 - ci-build
Uzbekistan Digital Health Platform, published by Ministry of Health of the Republic of Uzbekistan. This guide is not an authorized publication; it is the continuous build for version 0.13.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/uzinfocom-org/digital-health-ig/ and changes regularly. See the Directory of published versions
| Official URL: https://dhp.uz/fhir/core/StructureDefinition/uz-core-flag | Version: 0.13.0 | ||||
| Active as of 2026-11-19 | Computable Name: UZCoreFlag | ||||
Uzbekistan Core Flag profile, used to record a prospective warning or notification about a patient that users should be aware of, such as eligibility for blood donation or a medical deferral from it
UZ Core Flag records a prospective warning or notification about a UZ Core Patient that users of the Digital Health Platform should be aware of when dealing with that patient. The flag code currently covers blood donation eligibility: whether the patient may donate blood or is under a temporary or permanent medical deferral. A flag can be linked to the UZ Core Encounter in which it was raised and to its author.
The elements below must always be present (mandatory) or must be supported when the data is available (Must Support) - not all are required, but your system must populate each Must Support element when it has the data and process it on receipt. This is the human-readable summary; the formal views below give the exact cardinalities, types, and terminology bindings.
Every Flag must carry a status, a code saying what the flag is about, and a subject (the patient) - all three are mandatory in base FHIR R5.
identifier with its system, when the source system assigns one;status of the flag (active / inactive / entered-in-error) - it describes the flag itself, not what the flag records, so a medical deferral that still applies is an active flag;code - what the flag is about (eligible for blood donation / temporary or permanent medical deferral);subject - the patient the flag is about.The category (administrative, clinical and so on), the period the flag applies to, the Encounter in which it was raised and its author (Practitioner, PractitionerRole, Organization, Device, Patient or RelatedPerson) are optional; send them when known.
The examples below go from a minimal blood donation decision to one patient's earlier eligibility flag and the medical deferral that replaced it. Each example names this profile in meta.profile.
A minimal Flag needs its status, the blood donation eligibility decision and the patient. The decision code comes from the local blood donor eligibility code system, so its display is in Uzbek and the resource sets language to uz:
{
"resourceType": "Flag",
"meta": {
"profile": ["https://dhp.uz/fhir/core/StructureDefinition/uz-core-flag"]
},
"language": "uz",
"status": "active",
"code": {
"coding": [{
"system": "https://terminology.dhp.uz/fhir/core/CodeSystem/blood-donor-eligibility-cs",
"code": "blood-donation-eligible",
"display": "Qon donorligiga ruxsat berilgan"
}]
},
"subject": { "reference": "Patient/example-nodira" }
}
Add the HL7 flag category, the period and the author. HL7 category codes keep their original system. This flag is inactive: it stopped applying when the deferral below was recorded, and period.end holds that time. An active flag leaves period.end empty, unless it is a temporary deferral:
{
"resourceType": "Flag",
"meta": {
"profile": ["https://dhp.uz/fhir/core/StructureDefinition/uz-core-flag"]
},
"language": "uz",
"status": "inactive",
"category": [{
"coding": [{
"system": "http://terminology.hl7.org/CodeSystem/flag-category",
"code": "admin"
}]
}],
"code": {
"coding": [{
"system": "https://terminology.dhp.uz/fhir/core/CodeSystem/blood-donor-eligibility-cs",
"code": "blood-donation-eligible",
"display": "Qon donorligiga ruxsat berilgan"
}]
},
"subject": { "reference": "Patient/example-salim" },
"period": {
"start": "2026-10-12T10:00:00+05:00",
"end": "2026-11-09T09:00:00+05:00"
},
"author": { "reference": "Practitioner/example-practitioner" }
}
A medical deferral is temporary or permanent. A temporary deferral uses blood-donation-deferred-temporary and sets period.end to when it ends; the flag stays active until then, so read period.end together with status to tell whether it still applies. A permanent deferral uses blood-donation-deferred-permanent and has no period.end while it applies. To lift either one early, set status to inactive and period.end to the time it was lifted:
{
"resourceType": "Flag",
"meta": {
"profile": ["https://dhp.uz/fhir/core/StructureDefinition/uz-core-flag"]
},
"language": "uz",
"status": "active",
"category": [{
"coding": [{
"system": "http://terminology.hl7.org/CodeSystem/flag-category",
"code": "clinical"
}]
}],
"code": {
"coding": [{
"system": "https://terminology.dhp.uz/fhir/core/CodeSystem/blood-donor-eligibility-cs",
"code": "blood-donation-deferred-temporary",
"display": "Tibbiy sabablarga ko'ra qon donorligidan vaqtincha chetlatilgan"
}]
},
"subject": { "reference": "Patient/example-salim" },
"period": {
"start": "2026-11-09T09:00:00+05:00",
"end": "2027-05-09T09:00:00+05:00"
},
"author": { "reference": "Practitioner/example-practitioner" }
}
The complete FSH examples are the minimal flag, the eligible donor flag and the temporary medical deferral flag.
For example API calls, see the Quick Start at the bottom of this page.
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Flag(5.0.0) | Key information to flag to healthcare providers Constraints: uzcore-flag-1, uzcore-flag-2 |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | |
![]() ![]() |
0..* | Identifier | Business identifier of the flag | |
![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |
![]() ![]() |
1..1 | code | Status of the flag, not of what the flag describes Binding: FlagStatusVS (0.13.0) (required) | |
![]() ![]() |
0..* | CodeableConcept | General category of the flag Binding: FlagCategoryVS (0.13.0) (preferred) | |
![]() ![]() |
1..1 | CodeableConcept | What the flag is about, such as blood donation eligibility or a temporary or permanent medical deferral Binding: FlagCodeVS (0.13.0) (extensible) | |
![]() ![]() |
1..1 | Reference(UZ Core Patient(0.13.0)) | Patient the flag is about | |
![]() ![]() |
0..1 | Reference(UZ Core Encounter(0.13.0)) | Encounter during which the flag was raised | |
![]() ![]() |
0..1 | Reference(UZ Core Practitioner(0.13.0) | UZ Core PractitionerRole(0.13.0) | UZ Core Organization(0.13.0) | UZ Core Device(0.13.0) | UZ Core Patient(0.13.0) | UZ Core RelatedPerson(0.13.0)) | Person, organization or device responsible for the flag | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Flag.identifier.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| Flag.status | Base | required | Flag status | 📍0.13.0 | This IG |
| Flag.category | Base | preferred | Flag category | 📍0.13.0 | This IG |
| Flag.code | Base | extensible | Flag code | 📍0.13.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| uzcore-flag-1 | error | Flag | A temporary blood donation deferral states in period.end when it ends |
code.coding.where(system = 'https://terminology.dhp.uz/fhir/core/CodeSystem/blood-donor-eligibility-cs' and code = 'blood-donation-deferred-temporary').exists() implies period.end.exists()
|
| uzcore-flag-2 | error | Flag | An active permanent blood donation deferral has no period.end |
(status = 'active' and code.coding.where(system = 'https://terminology.dhp.uz/fhir/core/CodeSystem/blood-donor-eligibility-cs' and code = 'blood-donation-deferred-permanent').exists()) implies period.end.empty()
|
This structure is derived from Flag
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Flag(5.0.0) | Key information to flag to healthcare providers |
![]() ![]() |
0..* | Identifier | Business identifier of the flag | |
![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value | |
![]() ![]() |
1..1 | code | Status of the flag, not of what the flag describes Binding: FlagStatusVS (0.13.0) (required) | |
![]() ![]() |
0..* | CodeableConcept | General category of the flag Binding: FlagCategoryVS (0.13.0) (preferred) | |
![]() ![]() |
1..1 | CodeableConcept | What the flag is about, such as blood donation eligibility or a temporary or permanent medical deferral Binding: FlagCodeVS (0.13.0) (extensible) | |
![]() ![]() |
1..1 | Reference(UZ Core Patient(0.13.0)) | Patient the flag is about | |
![]() ![]() |
||||
![]() ![]() ![]() |
0..1 | dateTime | When the flag became active | |
![]() ![]() ![]() |
0..1 | dateTime | When the flag was deactivated, or when a temporary deferral ends; otherwise empty while the flag is active | |
![]() ![]() |
0..1 | Reference(UZ Core Encounter(0.13.0)) | Encounter during which the flag was raised | |
![]() ![]() |
0..1 | Reference(UZ Core Practitioner(0.13.0) | UZ Core PractitionerRole(0.13.0) | UZ Core Organization(0.13.0) | UZ Core Device(0.13.0) | UZ Core Patient(0.13.0) | UZ Core RelatedPerson(0.13.0)) | Person, organization or device responsible for the flag | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Flag.status | Base | required | Flag status | 📍0.13.0 | This IG |
| Flag.category | Base | preferred | Flag category | 📍0.13.0 | This IG |
| Flag.code | Base | extensible | Flag code | 📍0.13.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| uzcore-flag-1 | error | Flag | A temporary blood donation deferral states in period.end when it ends |
code.coding.where(system = 'https://terminology.dhp.uz/fhir/core/CodeSystem/blood-donor-eligibility-cs' and code = 'blood-donation-deferred-temporary').exists() implies period.end.exists()
|
| uzcore-flag-2 | error | Flag | An active permanent blood donation deferral has no period.end |
(status = 'active' and code.coding.where(system = 'https://terminology.dhp.uz/fhir/core/CodeSystem/blood-donor-eligibility-cs' and code = 'blood-donation-deferred-permanent').exists()) implies period.end.empty()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | Flag(5.0.0) | Key information to flag to healthcare providers Constraints: uzcore-flag-1, uzcore-flag-2 | ||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | |||||
![]() ![]() |
0..* | Identifier | Business identifier of the flag | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||||
![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||
![]() ![]() ![]() |
C | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() |
1..1 | code | Status of the flag, not of what the flag describes Binding: FlagStatusVS (0.13.0) (required) | |||||
![]() ![]() |
0..* | CodeableConcept | General category of the flag Binding: FlagCategoryVS (0.13.0) (preferred) | |||||
![]() ![]() |
1..1 | CodeableConcept | What the flag is about, such as blood donation eligibility or a temporary or permanent medical deferral Binding: FlagCodeVS (0.13.0) (extensible) | |||||
![]() ![]() |
1..1 | Reference(UZ Core Patient(0.13.0)) | Patient the flag is about | |||||
![]() ![]() |
0..1 | Period | Time period when flag is active | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() |
C | 0..1 | dateTime | When the flag became active | ||||
![]() ![]() ![]() |
C | 0..1 | dateTime | When the flag was deactivated, or when a temporary deferral ends; otherwise empty while the flag is active | ||||
![]() ![]() |
0..1 | Reference(UZ Core Encounter(0.13.0)) | Encounter during which the flag was raised | |||||
![]() ![]() |
0..1 | Reference(UZ Core Practitioner(0.13.0) | UZ Core PractitionerRole(0.13.0) | UZ Core Organization(0.13.0) | UZ Core Device(0.13.0) | UZ Core Patient(0.13.0) | UZ Core RelatedPerson(0.13.0)) | Person, organization or device responsible for the flag | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Flag.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| Flag.identifier.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| Flag.identifier.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| Flag.status | Base | required | Flag status | 📍0.13.0 | This IG |
| Flag.category | Base | preferred | Flag category | 📍0.13.0 | This IG |
| Flag.code | Base | extensible | Flag code | 📍0.13.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| uzcore-flag-1 | error | Flag | A temporary blood donation deferral states in period.end when it ends |
code.coding.where(system = 'https://terminology.dhp.uz/fhir/core/CodeSystem/blood-donor-eligibility-cs' and code = 'blood-donation-deferred-temporary').exists() implies period.end.exists()
|
| uzcore-flag-2 | error | Flag | An active permanent blood donation deferral has no period.end |
(status = 'active' and code.coding.where(system = 'https://terminology.dhp.uz/fhir/core/CodeSystem/blood-donor-eligibility-cs' and code = 'blood-donation-deferred-permanent').exists()) implies period.end.empty()
|
This structure is derived from Flag
Summary
Mandatory: 0 element(1 nested mandatory element)
Must-Support: 4 elements
Structures
This structure refers to these other structures:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Flag(5.0.0) | Key information to flag to healthcare providers Constraints: uzcore-flag-1, uzcore-flag-2 |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | |
![]() ![]() |
0..* | Identifier | Business identifier of the flag | |
![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |
![]() ![]() |
1..1 | code | Status of the flag, not of what the flag describes Binding: FlagStatusVS (0.13.0) (required) | |
![]() ![]() |
0..* | CodeableConcept | General category of the flag Binding: FlagCategoryVS (0.13.0) (preferred) | |
![]() ![]() |
1..1 | CodeableConcept | What the flag is about, such as blood donation eligibility or a temporary or permanent medical deferral Binding: FlagCodeVS (0.13.0) (extensible) | |
![]() ![]() |
1..1 | Reference(UZ Core Patient(0.13.0)) | Patient the flag is about | |
![]() ![]() |
0..1 | Reference(UZ Core Encounter(0.13.0)) | Encounter during which the flag was raised | |
![]() ![]() |
0..1 | Reference(UZ Core Practitioner(0.13.0) | UZ Core PractitionerRole(0.13.0) | UZ Core Organization(0.13.0) | UZ Core Device(0.13.0) | UZ Core Patient(0.13.0) | UZ Core RelatedPerson(0.13.0)) | Person, organization or device responsible for the flag | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Flag.identifier.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| Flag.status | Base | required | Flag status | 📍0.13.0 | This IG |
| Flag.category | Base | preferred | Flag category | 📍0.13.0 | This IG |
| Flag.code | Base | extensible | Flag code | 📍0.13.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| uzcore-flag-1 | error | Flag | A temporary blood donation deferral states in period.end when it ends |
code.coding.where(system = 'https://terminology.dhp.uz/fhir/core/CodeSystem/blood-donor-eligibility-cs' and code = 'blood-donation-deferred-temporary').exists() implies period.end.exists()
|
| uzcore-flag-2 | error | Flag | An active permanent blood donation deferral has no period.end |
(status = 'active' and code.coding.where(system = 'https://terminology.dhp.uz/fhir/core/CodeSystem/blood-donor-eligibility-cs' and code = 'blood-donation-deferred-permanent').exists()) implies period.end.empty()
|
Differential View
This structure is derived from Flag
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Flag(5.0.0) | Key information to flag to healthcare providers |
![]() ![]() |
0..* | Identifier | Business identifier of the flag | |
![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value | |
![]() ![]() |
1..1 | code | Status of the flag, not of what the flag describes Binding: FlagStatusVS (0.13.0) (required) | |
![]() ![]() |
0..* | CodeableConcept | General category of the flag Binding: FlagCategoryVS (0.13.0) (preferred) | |
![]() ![]() |
1..1 | CodeableConcept | What the flag is about, such as blood donation eligibility or a temporary or permanent medical deferral Binding: FlagCodeVS (0.13.0) (extensible) | |
![]() ![]() |
1..1 | Reference(UZ Core Patient(0.13.0)) | Patient the flag is about | |
![]() ![]() |
||||
![]() ![]() ![]() |
0..1 | dateTime | When the flag became active | |
![]() ![]() ![]() |
0..1 | dateTime | When the flag was deactivated, or when a temporary deferral ends; otherwise empty while the flag is active | |
![]() ![]() |
0..1 | Reference(UZ Core Encounter(0.13.0)) | Encounter during which the flag was raised | |
![]() ![]() |
0..1 | Reference(UZ Core Practitioner(0.13.0) | UZ Core PractitionerRole(0.13.0) | UZ Core Organization(0.13.0) | UZ Core Device(0.13.0) | UZ Core Patient(0.13.0) | UZ Core RelatedPerson(0.13.0)) | Person, organization or device responsible for the flag | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Flag.status | Base | required | Flag status | 📍0.13.0 | This IG |
| Flag.category | Base | preferred | Flag category | 📍0.13.0 | This IG |
| Flag.code | Base | extensible | Flag code | 📍0.13.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| uzcore-flag-1 | error | Flag | A temporary blood donation deferral states in period.end when it ends |
code.coding.where(system = 'https://terminology.dhp.uz/fhir/core/CodeSystem/blood-donor-eligibility-cs' and code = 'blood-donation-deferred-temporary').exists() implies period.end.exists()
|
| uzcore-flag-2 | error | Flag | An active permanent blood donation deferral has no period.end |
(status = 'active' and code.coding.where(system = 'https://terminology.dhp.uz/fhir/core/CodeSystem/blood-donor-eligibility-cs' and code = 'blood-donation-deferred-permanent').exists()) implies period.end.empty()
|
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | Flag(5.0.0) | Key information to flag to healthcare providers Constraints: uzcore-flag-1, uzcore-flag-2 | ||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | |||||
![]() ![]() |
0..* | Identifier | Business identifier of the flag | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||||
![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||
![]() ![]() ![]() |
C | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() |
1..1 | code | Status of the flag, not of what the flag describes Binding: FlagStatusVS (0.13.0) (required) | |||||
![]() ![]() |
0..* | CodeableConcept | General category of the flag Binding: FlagCategoryVS (0.13.0) (preferred) | |||||
![]() ![]() |
1..1 | CodeableConcept | What the flag is about, such as blood donation eligibility or a temporary or permanent medical deferral Binding: FlagCodeVS (0.13.0) (extensible) | |||||
![]() ![]() |
1..1 | Reference(UZ Core Patient(0.13.0)) | Patient the flag is about | |||||
![]() ![]() |
0..1 | Period | Time period when flag is active | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() |
C | 0..1 | dateTime | When the flag became active | ||||
![]() ![]() ![]() |
C | 0..1 | dateTime | When the flag was deactivated, or when a temporary deferral ends; otherwise empty while the flag is active | ||||
![]() ![]() |
0..1 | Reference(UZ Core Encounter(0.13.0)) | Encounter during which the flag was raised | |||||
![]() ![]() |
0..1 | Reference(UZ Core Practitioner(0.13.0) | UZ Core PractitionerRole(0.13.0) | UZ Core Organization(0.13.0) | UZ Core Device(0.13.0) | UZ Core Patient(0.13.0) | UZ Core RelatedPerson(0.13.0)) | Person, organization or device responsible for the flag | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Flag.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| Flag.identifier.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| Flag.identifier.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| Flag.status | Base | required | Flag status | 📍0.13.0 | This IG |
| Flag.category | Base | preferred | Flag category | 📍0.13.0 | This IG |
| Flag.code | Base | extensible | Flag code | 📍0.13.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| uzcore-flag-1 | error | Flag | A temporary blood donation deferral states in period.end when it ends |
code.coding.where(system = 'https://terminology.dhp.uz/fhir/core/CodeSystem/blood-donor-eligibility-cs' and code = 'blood-donation-deferred-temporary').exists() implies period.end.exists()
|
| uzcore-flag-2 | error | Flag | An active permanent blood donation deferral has no period.end |
(status = 'active' and code.coding.where(system = 'https://terminology.dhp.uz/fhir/core/CodeSystem/blood-donor-eligibility-cs' and code = 'blood-donation-deferred-permanent').exists()) implies period.end.empty()
|
This structure is derived from Flag
Summary
Mandatory: 0 element(1 nested mandatory element)
Must-Support: 4 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron
Common API interactions for this profile. Requests require a JWT access token - see Security and authentication. [base] is the FHIR server base URL; | separates a code system from its code and must be URL-encoded as %7C.
Read by server id
GET [base]/Flag/[id]
Search flags
GET [base]/Flag?patient=Patient/[id]&status=active&code=blood-donation-deferred-temporary,blood-donation-deferred-permanent
GET [base]/Flag?patient=Patient/[id]&status=active
GET [base]/Flag?patient=Patient/[id]&category=http://terminology.hl7.org/CodeSystem/flag-category%7Cclinical
GET [base]/Flag?identifier=[system]%7C[value]
GET [base]/Flag?encounter=Encounter/[id]
GET [base]/Flag?author=Practitioner/[id]
GET [base]/Flag?date=ge2026-01-01
code is a UZ Core search parameter: FHIR R5 has none for Flag.code. The first query finds a patient's active medical deferrals; a temporary one whose period.end has passed no longer applies.
Create
POST [base]/Flag
{
"resourceType": "Flag",
"meta": {
"profile": ["https://dhp.uz/fhir/core/StructureDefinition/uz-core-flag"]
},
"language": "uz",
"status": "active",
"code": {
"coding": [{
"system": "https://terminology.dhp.uz/fhir/core/CodeSystem/blood-donor-eligibility-cs",
"code": "blood-donation-deferred-permanent"
}]
},
"subject": { "reference": "Patient/[id]" },
"period": { "start": "2026-11-09T09:00:00+05:00" }
}
Update (for example, to end a medical deferral): send the complete resource with PUT [base]/Flag/[id], set status to inactive and period.end to the time it ended, and add an If-Match header carrying the version you read, so a concurrent change is not overwritten.
See the CapabilityStatement for the full list of supported search parameters.