Uzbekistan Digital Health Platform
0.13.0 - ci-build Uzbekistan flag

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

Resource Profile: UZ Core Group ( Experimental )

Official URL: https://dhp.uz/fhir/core/StructureDefinition/uz-core-group Version: 0.13.0
Active as of 2026-11-19 Computable Name: UZCoreGroup

Uzbekistan Core Group profile, used to represent a defined collection of entities (for example patients, practitioners or specimens), such as screening, vaccination and donation target groups and their outcome cohorts

UZ Core Group describes a set of people or other entities that are treated together: the target group of a screening, vaccination or donation programme, and the cohorts that come out of it, such as patients who were invited, screened, vaccinated or excluded, or donors who did or did not donate. A group either defines its members by shared characteristics (adults with a body mass index of 25 or more, for example) or lists them one by one. A PlanDefinition names the group a programme is for in subjectReference, and a CarePlan or MedicationAdministration can have a group as its subject. Members are usually Patients, but can also be practitioners, organizations, locations, devices, specimens or other groups.

Mandatory and Must Support data elements

The elements below must always be present (mandatory) or must be supported when the data is available (Must Support). Not all of them 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.

Each UZ Core Group Must Have

The profile adds no mandatory elements of its own; the required ones come from the base resource: the type of members and the membership basis. Each characteristic, when sent, must carry its code, its value and the exclude flag, and each member must carry the entity it points to.

Each UZ Core Group Must Support

  • the group's business identifier (identifier) and whether the group is in use (active);
  • the type of members (person / practitioner / organization / location / device / specimen and others);
  • how membership is decided (membership: definitional / enumerated);
  • the purpose or kind of the group (code), such as a screening target group or a vaccinated cohort;
  • the name, a description and the number of members (quantity);
  • the organization or person who manages the group (managingEntity);
  • the characteristics that include or exclude members (characteristic, with its code, value, exclude flag and period);
  • the listed members (member, with the entity, the period of membership and the inactive flag).

Definitional and enumerated groups

A programme usually needs both kinds:

membership Members are Typical use
definitional everyone who matches the characteristic entries; no member list The target group of a screening, vaccination or donation programme
enumerated the entities listed in member An outcome cohort: patients invited, screened, vaccinated or excluded, donors who donated

The two are separate Group resources with different code values. A definitional group can still give the estimated number of matching people in quantity.

Building the JSON, step by step

The examples below go from the smallest valid instance to a defined target group and a listed cohort. Each one validates against this profile. The complete reference instances are the type 2 diabetes screening target group and the measles-vaccinated cohort.

The smallest Group you should send

The required elements come from the base resource. Every UZ Core resource also names its profile in meta.profile, which tells the server which rules to validate against. This much passes validation:

{
  "resourceType": "Group",
  "meta": { "profile": ["https://dhp.uz/fhir/core/StructureDefinition/uz-core-group"] },
  "type": "person",
  "membership": "enumerated"
}

type and membership are plain codes, so send the bare value. A group of patients has type person.

A screening target group defined by characteristics

The target group of a type 2 diabetes screening programme takes in adults with a body mass index of 25 kg/m2 or more and leaves out patients who already have the diagnosis:

{
  "resourceType": "Group",
  "meta": { "profile": ["https://dhp.uz/fhir/core/StructureDefinition/uz-core-group"] },
  "active": true,
  "type": "person",
  "membership": "definitional",
  "code": {
    "coding": [
      { "system": "https://terminology.dhp.uz/fhir/core/CodeSystem/group-kind-cs", "code": "group-0001-00001" }
    ],
    "text": "Screening target group"
  },
  "name": "Type 2 diabetes screening target group",
  "description": "Adults with a BMI of 25 kg/m2 or higher, excluding patients already diagnosed with type 2 diabetes",
  "quantity": 1875,
  "managingEntity": { "reference": "Organization/example-organization" },
  "characteristic": [
    {
      "code": { "coding": [ { "system": "http://loinc.org", "code": "39156-5" } ], "text": "Body mass index (BMI)" },
      "valueRange": {
        "low": { "value": 25, "unit": "kg/m2", "system": "http://unitsofmeasure.org", "code": "kg/m2" }
      },
      "exclude": false
    },
    {
      "code": {
        "coding": [
          {
            "system": "https://terminology.dhp.uz/fhir/core/CodeSystem/group-characteristic-kind-local-cs",
            "code": "diagnosis"
          }
        ],
        "text": "Diagnosis"
      },
      "valueCodeableConcept": { "coding": [ { "system": "http://hl7.org/fhir/sid/icd-10", "code": "E11" } ] },
      "exclude": true
    }
  ]
}

characteristic.code says what is tested: a LOINC code for a measurement or an assessment, such as age or body mass index, or a local code for a trait LOINC does not cover, such as the region of residence, the healthcare organization, a diagnosis or a previous screening. The value is a valueRange, valueQuantity, valueCodeableConcept, valueBoolean or valueReference; use ICD-10 codes for diagnoses. exclude: true turns the characteristic into an exclusion. All characteristics apply together. The code of the group and the local characteristic codes have Uzbek primary displays, so either leave display out and use text, as here, or set the resource language to match the display you send.

A listed cohort

Patients who received a measles-containing vaccine at the polyclinic in the first quarter of 2026 are listed one by one. member.period.start is the date each patient joined the cohort:

{
  "resourceType": "Group",
  "meta": { "profile": ["https://dhp.uz/fhir/core/StructureDefinition/uz-core-group"] },
  "active": true,
  "type": "person",
  "membership": "enumerated",
  "code": {
    "coding": [
      { "system": "https://terminology.dhp.uz/fhir/core/CodeSystem/group-kind-cs", "code": "group-0001-00008" }
    ],
    "text": "Vaccinated patients"
  },
  "name": "Measles-vaccinated patients cohort",
  "quantity": 2,
  "managingEntity": { "reference": "Organization/example-organization" },
  "member": [
    {
      "entity": { "reference": "Patient/example-salim" },
      "period": { "start": "2026-01-15" },
      "inactive": false
    },
    {
      "entity": { "reference": "Patient/example-emma" },
      "period": { "start": "2026-02-03" },
      "inactive": false
    }
  ]
}

To take someone out of the cohort without losing the history, set inactive to true and close their period rather than removing the entry. Keep quantity equal to the number of active members. managingEntity is the Organization, Practitioner, PractitionerRole or RelatedPerson responsible for the group.

Retrieving the data of every member in one request through the Bulk Data Access Group export (GET [base]/Group/[id]/$export) is planned but not yet available.

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

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Group 0..* Group(5.0.0) Group of multiple entities
Group.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Group.contained 0..* Resource Contained, inline Resources
Group.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
Group.identifier This element must be supported. This element is included in summaries. 0..* Identifier Business Identifier for this Group
Group.active This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 boolean Whether this group's record is in active use
Group.type This element must be supported. This element is included in summaries. 1..1 code Identifies the broad classification of the kind of resources the group includes: person | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen
Binding: GroupTypeVS (0.13.0) (required)
Group.membership This element must be supported. This element is included in summaries. 1..1 code Basis for membership: definitional (defined by characteristics) or enumerated (defined by listed members)
Binding: GroupMembershipBasisVS (0.13.0) (required)
Group.code This element must be supported. This element is included in summaries. 0..1 CodeableConcept Purpose or kind of the group, for example a screening, vaccination or donation target group
Binding: GroupKindVS (0.13.0) (extensible)
Group.name This element must be supported. This element is included in summaries. 0..1 string Label for Group
Group.description This element must be supported. 0..1 markdown Natural language description of the group
Group.quantity This element must be supported. This element is included in summaries. 0..1 unsignedInt Number of members
Group.managingEntity This element must be supported. This element is included in summaries. 0..1 Reference(UZ Core Organization(0.13.0) | UZ Core RelatedPerson(0.13.0) | UZ Core Practitioner(0.13.0) | UZ Core PractitionerRole(0.13.0)) Entity that is the custodian of the Group's definition
Group.characteristic This element must be supported. This element is included in summaries. 0..* BackboneElement Include or exclude members of the group by a shared trait
Group.characteristic.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
Group.characteristic.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Kind of characteristic used to define membership
Binding: GroupCharacteristicKindVS (0.13.0) (extensible)
Group.characteristic.value[x] This element must be supported. This element is included in summaries. 1..1 Value held by the characteristic. For diagnosis-based characteristics, ICD-10 codes are recommended
Binding: ICD10Codes (example)
Group.characteristic.value[x].valueCodeableConcept CodeableConcept
Group.characteristic.value[x].valueBoolean boolean
Group.characteristic.value[x].valueQuantity Quantity
Group.characteristic.value[x].valueRange Range
Group.characteristic.value[x].valueReference Reference(Any)
Group.characteristic.exclude This element must be supported. This element is included in summaries. 1..1 boolean Group includes or excludes
Group.characteristic.period This element must be supported. 0..1 Period Period over which characteristic is tested
Group.member This element must be supported. 0..* BackboneElement Who or what is in group
Group.member.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
Group.member.entity This element must be supported. 1..1 Reference(CareTeam | UZ Core Device(0.13.0) | UZ Core Group(0.13.0) | UZ Core HealthcareService(0.13.0) | UZ Core Location(0.13.0) | UZ Core Organization(0.13.0) | UZ Core Patient(0.13.0) | UZ Core Practitioner(0.13.0) | UZ Core PractitionerRole(0.13.0) | UZ Core RelatedPerson(0.13.0) | UZ Core Specimen(0.13.0)) Reference to the group member
Group.member.period This element must be supported. 0..1 Period Period member belonged to the group
Group.member.inactive This element must be supported. 0..1 boolean If member is no longer in group

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Group.type Base required Group type 📍0.13.0 This IG
Group.membership Base required Group membership basis 📍0.13.0 This IG
Group.code Base extensible Group kind 📍0.13.0 This IG
Group.characteristic.​code Base extensible Group characteristic kind 📍0.13.0 This IG
Group.characteristic.​value[x] Base example ICD-10 Codes 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from Group

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Group 0..* Group(5.0.0) Group of multiple entities
Group.identifier This element must be supported. 0..* Identifier Business Identifier for this Group
Group.active This element must be supported. 0..1 boolean Whether this group's record is in active use
Group.type This element must be supported. 1..1 code Identifies the broad classification of the kind of resources the group includes: person | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen
Binding: GroupTypeVS (0.13.0) (required)
Group.code This element must be supported. 0..1 CodeableConcept Purpose or kind of the group, for example a screening, vaccination or donation target group
Binding: GroupKindVS (0.13.0) (extensible)
Group.name This element must be supported. 0..1 string Label for Group
Group.description This element must be supported. 0..1 markdown Natural language description of the group
Group.quantity This element must be supported. 0..1 unsignedInt Number of members
Group.managingEntity This element must be supported. 0..1 Reference(UZ Core Organization(0.13.0) | UZ Core RelatedPerson(0.13.0) | UZ Core Practitioner(0.13.0) | UZ Core PractitionerRole(0.13.0)) Entity that is the custodian of the Group's definition
Group.characteristic This element must be supported. 0..* BackboneElement Include or exclude members of the group by a shared trait
Group.characteristic.code This element must be supported. 1..1 CodeableConcept Kind of characteristic used to define membership
Binding: GroupCharacteristicKindVS (0.13.0) (extensible)
Group.characteristic.value[x] This element must be supported. 1..1 CodeableConcept, boolean, Quantity, Range, Reference() Value held by the characteristic. For diagnosis-based characteristics, ICD-10 codes are recommended
Binding: ICD10Codes (example)
Group.characteristic.exclude This element must be supported. 1..1 boolean Group includes or excludes
Group.characteristic.period This element must be supported. 0..1 Period Period over which characteristic is tested
Group.member This element must be supported. 0..* BackboneElement Who or what is in group
Group.member.entity This element must be supported. 1..1 Reference(CareTeam | UZ Core Device(0.13.0) | UZ Core Group(0.13.0) | UZ Core HealthcareService(0.13.0) | UZ Core Location(0.13.0) | UZ Core Organization(0.13.0) | UZ Core Patient(0.13.0) | UZ Core Practitioner(0.13.0) | UZ Core PractitionerRole(0.13.0) | UZ Core RelatedPerson(0.13.0) | UZ Core Specimen(0.13.0)) Reference to the group member
Group.member.period This element must be supported. 0..1 Period Period member belonged to the group
Group.member.inactive This element must be supported. 0..1 boolean If member is no longer in group

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Group.type Base required Group type 📍0.13.0 This IG
Group.membership Base required Group membership basis 📍0.13.0 This IG
Group.code Base extensible Group kind 📍0.13.0 This IG
Group.characteristic.​code Base extensible Group characteristic kind 📍0.13.0 This IG
Group.characteristic.​value[x] Base example ICD-10 Codes 📍5.0.0 FHIR Std.
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Group 0..* Group(5.0.0) Group of multiple entities
Group.id This element is included in summaries. 0..1 id Logical id of this artifact
Group.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Group.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Group.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
Group.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
Group.contained 0..* Resource Contained, inline Resources
Group.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
Group.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
Group.identifier This element must be supported. This element is included in summaries. 0..* Identifier Business Identifier for this Group
Group.active This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 boolean Whether this group's record is in active use
Group.type This element must be supported. This element is included in summaries. 1..1 code Identifies the broad classification of the kind of resources the group includes: person | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen
Binding: GroupTypeVS (0.13.0) (required)
Group.membership This element must be supported. This element is included in summaries. 1..1 code Basis for membership: definitional (defined by characteristics) or enumerated (defined by listed members)
Binding: GroupMembershipBasisVS (0.13.0) (required)
Group.code This element must be supported. This element is included in summaries. 0..1 CodeableConcept Purpose or kind of the group, for example a screening, vaccination or donation target group
Binding: GroupKindVS (0.13.0) (extensible)
Group.name This element must be supported. This element is included in summaries. 0..1 string Label for Group
Group.description This element must be supported. 0..1 markdown Natural language description of the group
Group.quantity This element must be supported. This element is included in summaries. 0..1 unsignedInt Number of members
Group.managingEntity This element must be supported. This element is included in summaries. 0..1 Reference(UZ Core Organization(0.13.0) | UZ Core RelatedPerson(0.13.0) | UZ Core Practitioner(0.13.0) | UZ Core PractitionerRole(0.13.0)) Entity that is the custodian of the Group's definition
Group.characteristic This element must be supported. This element is included in summaries. 0..* BackboneElement Include or exclude members of the group by a shared trait
Group.characteristic.id 0..1 string Unique id for inter-element referencing
Group.characteristic.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
Group.characteristic.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
Group.characteristic.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Kind of characteristic used to define membership
Binding: GroupCharacteristicKindVS (0.13.0) (extensible)
Group.characteristic.value[x] This element must be supported. This element is included in summaries. 1..1 Value held by the characteristic. For diagnosis-based characteristics, ICD-10 codes are recommended
Binding: ICD10Codes (example)
Group.characteristic.value[x].valueCodeableConcept CodeableConcept
Group.characteristic.value[x].valueBoolean boolean
Group.characteristic.value[x].valueQuantity Quantity
Group.characteristic.value[x].valueRange Range
Group.characteristic.value[x].valueReference Reference(Any)
Group.characteristic.exclude This element must be supported. This element is included in summaries. 1..1 boolean Group includes or excludes
Group.characteristic.period This element must be supported. 0..1 Period Period over which characteristic is tested
Group.member This element must be supported. 0..* BackboneElement Who or what is in group
Group.member.id 0..1 string Unique id for inter-element referencing
Group.member.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
Group.member.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
Group.member.entity This element must be supported. 1..1 Reference(CareTeam | UZ Core Device(0.13.0) | UZ Core Group(0.13.0) | UZ Core HealthcareService(0.13.0) | UZ Core Location(0.13.0) | UZ Core Organization(0.13.0) | UZ Core Patient(0.13.0) | UZ Core Practitioner(0.13.0) | UZ Core PractitionerRole(0.13.0) | UZ Core RelatedPerson(0.13.0) | UZ Core Specimen(0.13.0)) Reference to the group member
Group.member.period This element must be supported. 0..1 Period Period member belonged to the group
Group.member.inactive This element must be supported. 0..1 boolean If member is no longer in group

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Group.language Base required All Languages 📍5.0.0 FHIR Std.
Group.type Base required Group type 📍0.13.0 This IG
Group.membership Base required Group membership basis 📍0.13.0 This IG
Group.code Base extensible Group kind 📍0.13.0 This IG
Group.characteristic.​code Base extensible Group characteristic kind 📍0.13.0 This IG
Group.characteristic.​value[x] Base example ICD-10 Codes 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Group 0..* Group(5.0.0) Group of multiple entities
Group.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Group.contained 0..* Resource Contained, inline Resources
Group.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
Group.identifier This element must be supported. This element is included in summaries. 0..* Identifier Business Identifier for this Group
Group.active This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 boolean Whether this group's record is in active use
Group.type This element must be supported. This element is included in summaries. 1..1 code Identifies the broad classification of the kind of resources the group includes: person | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen
Binding: GroupTypeVS (0.13.0) (required)
Group.membership This element must be supported. This element is included in summaries. 1..1 code Basis for membership: definitional (defined by characteristics) or enumerated (defined by listed members)
Binding: GroupMembershipBasisVS (0.13.0) (required)
Group.code This element must be supported. This element is included in summaries. 0..1 CodeableConcept Purpose or kind of the group, for example a screening, vaccination or donation target group
Binding: GroupKindVS (0.13.0) (extensible)
Group.name This element must be supported. This element is included in summaries. 0..1 string Label for Group
Group.description This element must be supported. 0..1 markdown Natural language description of the group
Group.quantity This element must be supported. This element is included in summaries. 0..1 unsignedInt Number of members
Group.managingEntity This element must be supported. This element is included in summaries. 0..1 Reference(UZ Core Organization(0.13.0) | UZ Core RelatedPerson(0.13.0) | UZ Core Practitioner(0.13.0) | UZ Core PractitionerRole(0.13.0)) Entity that is the custodian of the Group's definition
Group.characteristic This element must be supported. This element is included in summaries. 0..* BackboneElement Include or exclude members of the group by a shared trait
Group.characteristic.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
Group.characteristic.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Kind of characteristic used to define membership
Binding: GroupCharacteristicKindVS (0.13.0) (extensible)
Group.characteristic.value[x] This element must be supported. This element is included in summaries. 1..1 Value held by the characteristic. For diagnosis-based characteristics, ICD-10 codes are recommended
Binding: ICD10Codes (example)
Group.characteristic.value[x].valueCodeableConcept CodeableConcept
Group.characteristic.value[x].valueBoolean boolean
Group.characteristic.value[x].valueQuantity Quantity
Group.characteristic.value[x].valueRange Range
Group.characteristic.value[x].valueReference Reference(Any)
Group.characteristic.exclude This element must be supported. This element is included in summaries. 1..1 boolean Group includes or excludes
Group.characteristic.period This element must be supported. 0..1 Period Period over which characteristic is tested
Group.member This element must be supported. 0..* BackboneElement Who or what is in group
Group.member.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
Group.member.entity This element must be supported. 1..1 Reference(CareTeam | UZ Core Device(0.13.0) | UZ Core Group(0.13.0) | UZ Core HealthcareService(0.13.0) | UZ Core Location(0.13.0) | UZ Core Organization(0.13.0) | UZ Core Patient(0.13.0) | UZ Core Practitioner(0.13.0) | UZ Core PractitionerRole(0.13.0) | UZ Core RelatedPerson(0.13.0) | UZ Core Specimen(0.13.0)) Reference to the group member
Group.member.period This element must be supported. 0..1 Period Period member belonged to the group
Group.member.inactive This element must be supported. 0..1 boolean If member is no longer in group

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Group.type Base required Group type 📍0.13.0 This IG
Group.membership Base required Group membership basis 📍0.13.0 This IG
Group.code Base extensible Group kind 📍0.13.0 This IG
Group.characteristic.​code Base extensible Group characteristic kind 📍0.13.0 This IG
Group.characteristic.​value[x] Base example ICD-10 Codes 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

Differential View

This structure is derived from Group

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Group 0..* Group(5.0.0) Group of multiple entities
Group.identifier This element must be supported. 0..* Identifier Business Identifier for this Group
Group.active This element must be supported. 0..1 boolean Whether this group's record is in active use
Group.type This element must be supported. 1..1 code Identifies the broad classification of the kind of resources the group includes: person | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen
Binding: GroupTypeVS (0.13.0) (required)
Group.membership This element must be supported. 1..1 code Basis for membership: definitional (defined by characteristics) or enumerated (defined by listed members)
Binding: GroupMembershipBasisVS (0.13.0) (required)
Group.code This element must be supported. 0..1 CodeableConcept Purpose or kind of the group, for example a screening, vaccination or donation target group
Binding: GroupKindVS (0.13.0) (extensible)
Group.name This element must be supported. 0..1 string Label for Group
Group.description This element must be supported. 0..1 markdown Natural language description of the group
Group.quantity This element must be supported. 0..1 unsignedInt Number of members
Group.managingEntity This element must be supported. 0..1 Reference(UZ Core Organization(0.13.0) | UZ Core RelatedPerson(0.13.0) | UZ Core Practitioner(0.13.0) | UZ Core PractitionerRole(0.13.0)) Entity that is the custodian of the Group's definition
Group.characteristic This element must be supported. 0..* BackboneElement Include or exclude members of the group by a shared trait
Group.characteristic.code This element must be supported. 1..1 CodeableConcept Kind of characteristic used to define membership
Binding: GroupCharacteristicKindVS (0.13.0) (extensible)
Group.characteristic.value[x] This element must be supported. 1..1 CodeableConcept, boolean, Quantity, Range, Reference() Value held by the characteristic. For diagnosis-based characteristics, ICD-10 codes are recommended
Binding: ICD10Codes (example)
Group.characteristic.exclude This element must be supported. 1..1 boolean Group includes or excludes
Group.characteristic.period This element must be supported. 0..1 Period Period over which characteristic is tested
Group.member This element must be supported. 0..* BackboneElement Who or what is in group
Group.member.entity This element must be supported. 1..1 Reference(CareTeam | UZ Core Device(0.13.0) | UZ Core Group(0.13.0) | UZ Core HealthcareService(0.13.0) | UZ Core Location(0.13.0) | UZ Core Organization(0.13.0) | UZ Core Patient(0.13.0) | UZ Core Practitioner(0.13.0) | UZ Core PractitionerRole(0.13.0) | UZ Core RelatedPerson(0.13.0) | UZ Core Specimen(0.13.0)) Reference to the group member
Group.member.period This element must be supported. 0..1 Period Period member belonged to the group
Group.member.inactive This element must be supported. 0..1 boolean If member is no longer in group

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Group.type Base required Group type 📍0.13.0 This IG
Group.membership Base required Group membership basis 📍0.13.0 This IG
Group.code Base extensible Group kind 📍0.13.0 This IG
Group.characteristic.​code Base extensible Group characteristic kind 📍0.13.0 This IG
Group.characteristic.​value[x] Base example ICD-10 Codes 📍5.0.0 FHIR Std.

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Group 0..* Group(5.0.0) Group of multiple entities
Group.id This element is included in summaries. 0..1 id Logical id of this artifact
Group.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Group.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Group.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
Group.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
Group.contained 0..* Resource Contained, inline Resources
Group.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
Group.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
Group.identifier This element must be supported. This element is included in summaries. 0..* Identifier Business Identifier for this Group
Group.active This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 boolean Whether this group's record is in active use
Group.type This element must be supported. This element is included in summaries. 1..1 code Identifies the broad classification of the kind of resources the group includes: person | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen
Binding: GroupTypeVS (0.13.0) (required)
Group.membership This element must be supported. This element is included in summaries. 1..1 code Basis for membership: definitional (defined by characteristics) or enumerated (defined by listed members)
Binding: GroupMembershipBasisVS (0.13.0) (required)
Group.code This element must be supported. This element is included in summaries. 0..1 CodeableConcept Purpose or kind of the group, for example a screening, vaccination or donation target group
Binding: GroupKindVS (0.13.0) (extensible)
Group.name This element must be supported. This element is included in summaries. 0..1 string Label for Group
Group.description This element must be supported. 0..1 markdown Natural language description of the group
Group.quantity This element must be supported. This element is included in summaries. 0..1 unsignedInt Number of members
Group.managingEntity This element must be supported. This element is included in summaries. 0..1 Reference(UZ Core Organization(0.13.0) | UZ Core RelatedPerson(0.13.0) | UZ Core Practitioner(0.13.0) | UZ Core PractitionerRole(0.13.0)) Entity that is the custodian of the Group's definition
Group.characteristic This element must be supported. This element is included in summaries. 0..* BackboneElement Include or exclude members of the group by a shared trait
Group.characteristic.id 0..1 string Unique id for inter-element referencing
Group.characteristic.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
Group.characteristic.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
Group.characteristic.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Kind of characteristic used to define membership
Binding: GroupCharacteristicKindVS (0.13.0) (extensible)
Group.characteristic.value[x] This element must be supported. This element is included in summaries. 1..1 Value held by the characteristic. For diagnosis-based characteristics, ICD-10 codes are recommended
Binding: ICD10Codes (example)
Group.characteristic.value[x].valueCodeableConcept CodeableConcept
Group.characteristic.value[x].valueBoolean boolean
Group.characteristic.value[x].valueQuantity Quantity
Group.characteristic.value[x].valueRange Range
Group.characteristic.value[x].valueReference Reference(Any)
Group.characteristic.exclude This element must be supported. This element is included in summaries. 1..1 boolean Group includes or excludes
Group.characteristic.period This element must be supported. 0..1 Period Period over which characteristic is tested
Group.member This element must be supported. 0..* BackboneElement Who or what is in group
Group.member.id 0..1 string Unique id for inter-element referencing
Group.member.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
Group.member.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
Group.member.entity This element must be supported. 1..1 Reference(CareTeam | UZ Core Device(0.13.0) | UZ Core Group(0.13.0) | UZ Core HealthcareService(0.13.0) | UZ Core Location(0.13.0) | UZ Core Organization(0.13.0) | UZ Core Patient(0.13.0) | UZ Core Practitioner(0.13.0) | UZ Core PractitionerRole(0.13.0) | UZ Core RelatedPerson(0.13.0) | UZ Core Specimen(0.13.0)) Reference to the group member
Group.member.period This element must be supported. 0..1 Period Period member belonged to the group
Group.member.inactive This element must be supported. 0..1 boolean If member is no longer in group

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Group.language Base required All Languages 📍5.0.0 FHIR Std.
Group.type Base required Group type 📍0.13.0 This IG
Group.membership Base required Group membership basis 📍0.13.0 This IG
Group.code Base extensible Group kind 📍0.13.0 This IG
Group.characteristic.​code Base extensible Group characteristic kind 📍0.13.0 This IG
Group.characteristic.​value[x] Base example ICD-10 Codes 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

 

Other representations of profile: CSV, Excel, Schematron

Quick Start

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 value and must be URL-encoded as %7C.

Read a group by server id, and its earlier versions

GET [base]/Group/[id]
GET [base]/Group/[id]/_history

Search

GET [base]/Group?identifier=[system]%7C[value]
GET [base]/Group?code=https://terminology.dhp.uz/fhir/core/CodeSystem/group-kind-cs%7Cgroup-0001-00001
GET [base]/Group?membership=definitional&type=person
GET [base]/Group?managing-entity=Organization/[id]
GET [base]/Group?name=diabetes

Find the groups a patient belongs to

GET [base]/Group?member=Patient/[id]

Create a group

POST [base]/Group
{
  "resourceType": "Group",
  "meta": { "profile": [ "https://dhp.uz/fhir/core/StructureDefinition/uz-core-group" ] },
  "active": true,
  "type": "person",
  "membership": "enumerated",
  "code": {
    "coding": [
      { "system": "https://terminology.dhp.uz/fhir/core/CodeSystem/group-kind-cs", "code": "group-0001-00005" }
    ]
  },
  "name": "Invited patients",
  "managingEntity": { "reference": "Organization/[id]" },
  "member": [ { "entity": { "reference": "Patient/[id]" } } ],
  ...
}

Update an existing group (e.g. add a member, or mark one inactive and update quantity) - PUT the full resource back:

PUT [base]/Group/[id]
If-Match: W/"3"   # the ETag from your last read; 412 if it changed since
{
  "resourceType": "Group",
  "id": "[id]",
  "meta": { "profile": [ "https://dhp.uz/fhir/core/StructureDefinition/uz-core-group" ] },
  "member": [ ... ],
  "quantity": 3,
  ...
}

See the CapabilityStatement for the full list of supported search parameters.