Uzbekistan Digital Health Platform
0.10.0 - draft Uzbekistan flag

This page is part of the Uzbekistan Digital Health Platform (v0.10.0: Releases Draft) based on FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: UZ Core PlanDefinition ( Experimental )

Official URL: https://dhp.uz/fhir/core/StructureDefinition/uz-core-plan-definition Version: 0.10.0
Draft as of 2026-09-29 Computable Name: UZCorePlanDefinition

Uzbekistan Core PlanDefinition profile, used to represent national healthcare schedules - immunization, whole blood donation and screening - including planned activities, recommended administration or visit periods, target groups, dose and visit sequences, and related scheduling rules. It supports consistent planning, implementation, and exchange of these schedules within the national digital health ecosystem.

UZ Core PlanDefinition holds a national healthcare schedule of Uzbekistan expressed as computable logic - each planned activity, its timing, the minimum intervals between activities, and the eligibility rules that decide who it applies to. The same profile covers the national immunization schedule, whole blood donation schedules and screening schedules; a focus use context says which kind a given schedule is. The immunization schedule is the resource the recommendation engine reads to build each patient's ImmunizationRecommendation. Only one schedule version may be active at a time for a given scope or jurisdiction.

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 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 PlanDefinition Must Have

Every PlanDefinition must carry a url (the canonical identifier for this schedule), a machine-processable name, a status (draft, active, retired, unknown) inherited as mandatory from the base resource, a description of what the schedule covers, and exactly one use context with a focus code saying what kind of schedule it is.

Each UZ Core PlanDefinition Must Support

  • an identifier, version and version algorithm, a human-readable title, and the status (draft, active, retired);
  • the subject the schedule applies to (a coded concept or a reference);
  • the date, publisher, use context (including where the schedule applies - nationally or in specific regions), approval date and effective period;
  • the actions that make up the schedule, each with a linkId, title, description and code;
  • per action: a condition (eligibility - its kind and FHIRPath expression), a related action (the target action, relationship, and offset as a duration or range for minimum intervals), the timing (an age or a schedule), a participant (its actor id and type), and the definition (a canonical link to an ActivityDefinition or other definition, or a uri).

The schedule must satisfy schedule-validation rules: no gaps in the dose sequence, no impossible timing windows, and no two active overlapping versions for the same scope.

Building the JSON, step by step

A PlanDefinition is mostly authored once and read by the recommendation engine, so the examples below are short. They go from the smallest instance the server will accept to a schedule that carries its actions. Copy one and adapt it - every value shown validates against this profile. The full reference instance is the example PlanDefinition.

The smallest PlanDefinition you should send

url, name and description are the mandatory elements, and status is mandatory on the base resource (draft | active | retired | unknown - required binding). The url is the canonical identifier other resources link to, so it must be stable. Every UZ Core resource also names the profile it claims to conform to in meta.profile. One useContext with a focus code is also mandatory - it says what kind of schedule this is, and it is how clients find the schedule on the server. This much already passes validation:

{
  "resourceType": "PlanDefinition",
  "meta": {
    "profile": ["https://dhp.uz/fhir/core/StructureDefinition/uz-core-plan-definition"]
  },
  "url": "https://terminology.dhp.uz/fhir/core/PlanDefinition/example-uz-core-immunization-plan-definition",
  "name": "ExampleImmunizationPlanDefinition",
  "status": "draft",
  "description": "Example PlanDefinition demonstrating actions and relationships.",
  "useContext": [
    {
      "code": {
        "system": "http://terminology.hl7.org/CodeSystem/usage-context-type",
        "code": "focus"
      },
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "33879002",
            "display": "Active immunization"
          }
        ]
      }
    }
  ]
}

Exactly one focus context is allowed. Use 33879002 for an immunization schedule, 25179006 for a whole blood donation schedule, or 360156006 for a screening schedule. A schedule is found with GET [base]/PlanDefinition?context-type-value=focus$http://snomed.info/sct|33879002.

National or regional

A jurisdiction use context says where the schedule applies. A national schedule carries one entry with the country code UZ. A regional schedule carries one entry per region instead, using the same region codes as Address.state in a patient's address, so a patient's region can be matched to the schedules that apply there directly. A schedule cannot be both: UZ cannot be combined with region codes. A screening schedule run in Samarqand and Navoiy regions only:

{
  "resourceType": "PlanDefinition",
  "meta": {
    "profile": ["https://dhp.uz/fhir/core/StructureDefinition/uz-core-plan-definition"]
  },
  "url": "https://terminology.dhp.uz/fhir/core/PlanDefinition/example-uz-core-regional-screening-plan-definition",
  "name": "ExampleRegionalDiabetesScreeningPlanDefinition",
  "status": "draft",
  "description": "Example screening PlanDefinition run in Samarqand and Navoiy regions only.",
  "useContext": [
    {
      "code": { "system": "http://terminology.hl7.org/CodeSystem/usage-context-type", "code": "focus" },
      "valueCodeableConcept": {
        "coding": [ { "system": "http://snomed.info/sct", "code": "360156006", "display": "Screening intent" } ]
      }
    },
    {
      "code": { "system": "http://terminology.hl7.org/CodeSystem/usage-context-type", "code": "jurisdiction" },
      "valueCodeableConcept": {
        "coding": [ { "system": "https://terminology.dhp.uz/fhir/core/CodeSystem/states-cs", "code": "1718" } ]
      }
    },
    {
      "code": { "system": "http://terminology.hl7.org/CodeSystem/usage-context-type", "code": "jurisdiction" },
      "valueCodeableConcept": {
        "coding": [ { "system": "https://terminology.dhp.uz/fhir/core/CodeSystem/states-cs", "code": "1712" } ]
      }
    }
  ]
}

For a national schedule, the jurisdiction entry is { "system": "urn:iso:std:iso:3166", "code": "UZ" } instead. Use this use context rather than the jurisdiction element: FHIR R5 deprecates that element, and R6 redefines it as the jurisdiction of the authority that issued the schedule, not where it applies. The schedules that apply in a region are found with GET [base]/PlanDefinition?context-type-value=jurisdiction$https://terminology.dhp.uz/fhir/core/CodeSystem/states-cs|1718. See the regional screening example for a complete instance.

name is the machine-processable name (no spaces); add a human-readable title when you have one. See Metadata for the publisher, date and version fields a published schedule should also carry.

A schedule with its actions

In practice the schedule is the action list. Each dose is one action with a linkId, title, description and a code. Add a condition for eligibility (its kind and a FHIRPath expression), a participant (who performs it - an actorId and a type), and a definitionUri (or definitionCanonical) pointing at the activity that carries the vaccine detail. A later dose uses relatedAction to point back at an earlier one by targetId, with the minimum interval in offsetDuration:

{
  "resourceType": "PlanDefinition",
  "meta": { "profile": [ "https://dhp.uz/fhir/core/StructureDefinition/uz-core-plan-definition" ] },
  "url": "https://terminology.dhp.uz/fhir/core/PlanDefinition/example-uz-core-immunization-plan-definition",
  "name": "ExampleImmunizationPlanDefinition",
  "title": "Example Vaccination Follow-up Plan",
  "status": "draft",
  "date": "2026-08-10",
  "publisher": "DHP Uzbekistan",
  "description": "Example PlanDefinition demonstrating actions and relationships.",
  "useContext": [
    {
      "code": { "system": "http://terminology.hl7.org/CodeSystem/usage-context-type", "code": "focus" },
      "valueCodeableConcept": {
        "coding": [ { "system": "http://snomed.info/sct", "code": "33879002", "display": "Active immunization" } ]
      }
    },
    {
      "code": { "system": "http://terminology.hl7.org/CodeSystem/usage-context-type", "code": "topic" },
      "valueCodeableConcept": {
        "coding": [ { "system": "https://terminology.dhp.uz/fhir/core/CodeSystem/immunization-schedule-type-cs", "code": "pd-type-0001-00001", "display": "Age-based" } ]
      }
    }
  ],
  "approvalDate": "2026-08-01",
  "effectivePeriod": { "start": "2026-08-01", "end": "2027-08-01" },
  "action": [
    {
      "id": "action-1",
      "linkId": "action-1",
      "title": "Initial vaccination",
      "description": "Administer first vaccine dose.",
      "code": {
        "coding": [
          {
            "system": "http://hl7.org/fhir/action-code",
            "code": "recommend-immunization",
            "display": "Recommend an immunization"
          }
        ]
      },
      "condition": [
        {
          "kind": "applicability",
          "expression": {
            "description": "Patient must be 18 years or older",
            "language": "text/fhirpath",
            "expression": "Patient.birthDate <= today() - 18 years"
          }
        }
      ],
      "participant": [ { "type": "practitioner", "actorId": "vaccinator" } ],
      "definitionUri": "https://terminology.dhp.uz/fhir/core/ActivityDefinition/example-activity-definition"
    },
    {
      "id": "action-2",
      "linkId": "action-2",
      "title": "Follow-up vaccination",
      "description": "Administer second vaccine dose.",
      "relatedAction": [
        {
          "targetId": "action-1",
          "relationship": "after-end",
          "offsetDuration": {
            "value": 30,
            "unit": "days",
            "system": "http://unitsofmeasure.org",
            "code": "d"
          }
        }
      ],
      "participant": [ { "type": "practitioner", "actorId": "vaccinator" } ],
      "definitionUri": "https://terminology.dhp.uz/fhir/core/ActivityDefinition/example-activity-definition"
    }
  ]
}

condition.kind, relatedAction.relationship and participant.type each use a required binding - take the value from the bound value set (the Snapshot view below lists each one). The relatedAction.targetId must match the linkId of an action already in the same schedule.

For example API calls and a sample payload, 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: Filtersdoco
.. PlanDefinition C 0..* PlanDefinition(5.0.0) The definition of a plan for a series of actions, independent of any specific patient or context
Interfaces Implemented: MetadataResource
Constraints: cnl-0, pld-3, pld-4, uzcore-plandef-1, uzcore-plandef-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:statusHistory S 0..* (Complex) History of PlanDefinition status changes
URL: https://dhp.uz/fhir/core/StructureDefinition/plan-definition-status-history
Constraints: ext-1
... url SΣC 1..1 uri Canonical identifier for this PlanDefinition
Constraints: cnl-1
... identifier SΣ 0..* Identifier Additional identifier for the plan definition
... version SΣ 0..1 string Business version of the plan definition
... versionAlgorithm[x] SΣ 0..1 How to compare versions
Binding: VersionAlgorithmVS (0.10.0) (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name SΣC 1..1 string Machine-processable name for this PlanDefinition
... title SΣ 0..1 string Plan definition title (in Uzbek language)
.... Slices for extension 0..* Extension Plan definition title (in Russian and Karakalpak languages)
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:translation S 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
Constraints: ext-1
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatusVS (0.10.0) (required)
... Slices for subject[x] S 0..1 Type of individual the plan definition is focused on
Slice: Unordered, Closed by type:$this
Binding: ParticipantResourceTypes (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
.... subjectCodeableConcept CodeableConcept
.... subjectReference Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition)
.... subject[x]:subjectCodeableConcept S 0..1 CodeableConcept Type of individual the plan definition is focused on
Binding: ParticipantResourceTypes (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
.... subject[x]:subjectReference S 0..1 Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition) Type of individual the plan definition is focused on
... date SΣ 0..1 dateTime Date last changed
... publisher SΣ 0..1 string Name of the publisher/steward (organization or individual)
... description SΣ 1..1 markdown Natural language description of the plan definition
... Slices for useContext SΣ 1..* UsageContext The context that the content is intended to support
Slice: Unordered, Open by value:value
.... useContext:immunizationFocus SΣ 0..1 UsageContext Marks this PlanDefinition as an immunization schedule
..... code Σ 1..1 Coding Type of context being specified
Binding: UsageContextType (1.0.1) (extensible): A code that specifies a type of context being specified by a usage context.
Required Pattern: At least the following
...... 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://terminology.hl7.org/CodeSystem/usage-context-type
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: focus
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 1..1 CodeableConcept Value that defines the context
Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified.
Required Pattern: At least the following
...... coding Σ 1..1 Coding Code defined by a terminology system

Fixed Value: (Complex)
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... code ΣC 1..1 code Symbol in syntax defined by the system
Fixed Value: 33879002
.... useContext:scheduleCategory SΣ 0..1 UsageContext Kind of immunization schedule
..... code Σ 1..1 Coding Type of context being specified
Binding: UsageContextType (1.0.1) (extensible): A code that specifies a type of context being specified by a usage context.
Required Pattern: At least the following
...... 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://terminology.hl7.org/CodeSystem/usage-context-type
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: topic
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 1..1 CodeableConcept Value that defines the context
Binding: ImmunizationScheduleTypeVS (0.10.0) (required)
.... useContext:bloodDonationFocus SΣ 0..1 UsageContext Marks this PlanDefinition as a whole blood donation schedule
..... code Σ 1..1 Coding Type of context being specified
Binding: UsageContextType (1.0.1) (extensible): A code that specifies a type of context being specified by a usage context.
Required Pattern: At least the following
...... 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://terminology.hl7.org/CodeSystem/usage-context-type
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: focus
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 1..1 CodeableConcept Value that defines the context
Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified.
Required Pattern: At least the following
...... coding Σ 1..1 Coding Code defined by a terminology system

Fixed Value: (Complex)
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... code ΣC 1..1 code Symbol in syntax defined by the system
Fixed Value: 25179006
.... useContext:screeningFocus SΣ 0..1 UsageContext Marks this PlanDefinition as a screening schedule
..... code Σ 1..1 Coding Type of context being specified
Binding: UsageContextType (1.0.1) (extensible): A code that specifies a type of context being specified by a usage context.
Required Pattern: At least the following
...... 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://terminology.hl7.org/CodeSystem/usage-context-type
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: focus
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 1..1 CodeableConcept Value that defines the context
Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified.
Required Pattern: At least the following
...... coding Σ 1..1 Coding Code defined by a terminology system

Fixed Value: (Complex)
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... code ΣC 1..1 code Symbol in syntax defined by the system
Fixed Value: 360156006
.... useContext:jurisdiction SΣ 0..* UsageContext Where the schedule applies: Uzbekistan for a national schedule, or one entry per region for a regional one
..... code Σ 1..1 Coding Type of context being specified
Binding: UsageContextType (1.0.1) (extensible): A code that specifies a type of context being specified by a usage context.
Required Pattern: At least the following
...... 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://terminology.hl7.org/CodeSystem/usage-context-type
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: jurisdiction
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 1..1 CodeableConcept Value that defines the context
Binding: JurisdictionVS (0.10.0) (required)
...... coding Σ 1..1 Coding Code defined by a terminology system
....... system Σ 1..1 uri Identity of the terminology system
....... code ΣC 1..1 code Symbol in syntax defined by the system
... approvalDate S 0..1 date When the plan definition was approved by publisher
... effectivePeriod SΣ 0..1 Period When the plan definition is expected to be used
... action SC 0..* BackboneElement Definition of action included in the plan
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... linkId S 0..1 string Unique id for the action in the PlanDefinition
.... title S 0..1 string User-visible title
.... description S 0..1 markdown Brief description of the action
.... code S 0..1 CodeableConcept Code representing the meaning of the action or sub-actions
Binding: ActionCodeVS (0.10.0) (example)
.... condition S 0..* BackboneElement Whether or not the action is applicable
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... kind S 1..1 code applicability | start | stop
Binding: ActionConditionVS (0.10.0) (required)
..... expression S 0..1 Expression Boolean-valued expression
.... relatedAction SC 0..* BackboneElement Relationship to another action
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... targetId SC 1..1 id Identifier of related action
..... relationship S 1..1 code before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
Binding: ActionRelationshipTypeVS (0.10.0) (required)
..... Slices for offset[x] S 0..1 Time offset for the relationship
Slice: Unordered, Closed by type:$this
...... offsetDuration Duration
...... offsetRange Range
...... offset[x]:offsetDuration S 0..1 Duration Time offset for the relationship
...... offset[x]:offsetRange S 0..1 Range Time offset for the relationship
.... Slices for timing[x] S 0..1 When the action should take place
Slice: Unordered, Closed by type:$this
..... timingAge Age
..... timingTiming Timing
..... timing[x]:timingAge S 0..1 Age When the action should take place
..... timing[x]:timingTiming S 0..1 Timing When the action should take place
.... participant S 0..* BackboneElement Who should participate in the action
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... actorId S 0..1 string What actor
..... type S 0..1 code careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Binding: ParticipantResourceTypesVS (0.10.0) (required)
.... definition[x] S 0..1 Description of the activity to be performed
..... definitionCanonical canonical(ActivityDefinition | MessageDefinition | ObservationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition)
..... definitionUri uri

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PlanDefinition.versionAlgorithm[x] Base extensible Version algorithm types 📍0.10.0 This IG
PlanDefinition.status Base required Publication Status VS 📍0.10.0 This IG
PlanDefinition.subject[x] Base extensible Participant Resource Types 📍5.0.0 FHIR Std.
PlanDefinition.subject[x]:subjectCodeableConcept Base extensible Participant Resource Types 📍5.0.0 FHIR Std.
PlanDefinition.useContext:immunizationFocus.​code Base extensible UsageContextType 📍1.0.1 THO v7.3
PlanDefinition.useContext:immunizationFocus.​value[x] Base example Context of Use ValueSet 📍5.0.0 FHIR Std.
PlanDefinition.useContext:scheduleCategory.​code Base extensible UsageContextType 📍1.0.1 THO v7.3
PlanDefinition.useContext:scheduleCategory.​value[x] Base required UZ Core Immunization Schedule Type Value Set 📍0.10.0 This IG
PlanDefinition.useContext:bloodDonationFocus.​code Base extensible UsageContextType 📍1.0.1 THO v7.3
PlanDefinition.useContext:bloodDonationFocus.​value[x] Base example Context of Use ValueSet 📍5.0.0 FHIR Std.
PlanDefinition.useContext:screeningFocus.​code Base extensible UsageContextType 📍1.0.1 THO v7.3
PlanDefinition.useContext:screeningFocus.​value[x] Base example Context of Use ValueSet 📍5.0.0 FHIR Std.
PlanDefinition.useContext:jurisdiction.​code Base extensible UsageContextType 📍1.0.1 THO v7.3
PlanDefinition.useContext:jurisdiction.​value[x] Base required Uzbekistan Jurisdictions 📍0.10.0 This IG
PlanDefinition.action.​code Base example Action code translations 📍0.10.0 This IG
PlanDefinition.action.​condition.kind Base required Action condition translations 📍0.10.0 This IG
PlanDefinition.action.​relatedAction.relationship Base required Types of action relationship 📍0.10.0 This IG
PlanDefinition.action.​participant.type Base required Participant resource types translations 📍0.10.0 This IG

Constraints

Id Grade Path(s) Description Expression
uzcore-plandef-1 error PlanDefinition A schedule must declare exactly one focus useContext, so clients can tell what kind of schedule it is useContext.where(code.system = 'http://terminology.hl7.org/CodeSystem/usage-context-type' and code.code = 'focus').count() = 1
uzcore-plandef-2 error PlanDefinition A schedule is either national or regional: a jurisdiction of Uzbekistan as a whole cannot be combined with individual regions useContext.where(code.system = 'http://terminology.hl7.org/CodeSystem/usage-context-type' and code.code = 'jurisdiction' and value.ofType(CodeableConcept).coding.where(system = 'urn:iso:std:iso:3166' and code = 'UZ').exists()).exists() implies useContext.where(code.system = 'http://terminology.hl7.org/CodeSystem/usage-context-type' and code.code = 'jurisdiction').count() = 1

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PlanDefinition C 0..* PlanDefinition(5.0.0) The definition of a plan for a series of actions, independent of any specific patient or context
Interfaces Implemented: MetadataResource
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:statusHistory S 0..* (Complex) History of PlanDefinition status changes
URL: https://dhp.uz/fhir/core/StructureDefinition/plan-definition-status-history
... url S 1..1 uri Canonical identifier for this PlanDefinition
... identifier S 0..* Identifier Additional identifier for the plan definition
... versionAlgorithm[x] S 0..1 string, Coding How to compare versions
Binding: VersionAlgorithmVS (0.10.0) (extensible)
... name S 1..1 string Machine-processable name for this PlanDefinition
... title S 0..1 string Plan definition title (in Uzbek language)
.... Slices for extension 0..* Extension Plan definition title (in Russian and Karakalpak languages)
Slice: Unordered, Open by value:url
..... extension:translation S 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
... status S 1..1 code draft | active | retired | unknown
Binding: PublicationStatusVS (0.10.0) (required)
... Slices for subject[x] S 0..1 Type of individual the plan definition is focused on
Slice: Unordered, Open by type:$this
.... subjectCodeableConcept CodeableConcept
.... subjectReference Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition)
.... subject[x]:subjectCodeableConcept S 0..1 CodeableConcept Type of individual the plan definition is focused on
.... subject[x]:subjectReference S 0..1 Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition) Type of individual the plan definition is focused on
... date S 0..1 dateTime Date last changed
... publisher S 0..1 string Name of the publisher/steward (organization or individual)
... description S 1..1 markdown Natural language description of the plan definition
... Slices for useContext S 1..* UsageContext The context that the content is intended to support
Slice: Unordered, Open by value:value
.... useContext:immunizationFocus S 0..1 UsageContext Marks this PlanDefinition as an immunization schedule
..... code 1..1 Coding Type of context being specified
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: focus
..... value[x] 1..1 CodeableConcept Value that defines the context
Required Pattern: At least the following
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 33879002
.... useContext:scheduleCategory S 0..1 UsageContext Kind of immunization schedule
..... code 1..1 Coding Type of context being specified
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: topic
..... value[x] 1..1 CodeableConcept Value that defines the context
Binding: ImmunizationScheduleTypeVS (0.10.0) (required)
.... useContext:bloodDonationFocus S 0..1 UsageContext Marks this PlanDefinition as a whole blood donation schedule
..... code 1..1 Coding Type of context being specified
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: focus
..... value[x] 1..1 CodeableConcept Value that defines the context
Required Pattern: At least the following
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 25179006
.... useContext:screeningFocus S 0..1 UsageContext Marks this PlanDefinition as a screening schedule
..... code 1..1 Coding Type of context being specified
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: focus
..... value[x] 1..1 CodeableConcept Value that defines the context
Required Pattern: At least the following
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 360156006
.... useContext:jurisdiction S 0..* UsageContext Where the schedule applies: Uzbekistan for a national schedule, or one entry per region for a regional one
..... code 1..1 Coding Type of context being specified
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: jurisdiction
..... value[x] 1..1 CodeableConcept Value that defines the context
Binding: JurisdictionVS (0.10.0) (required)
...... coding 1..1 Coding Code defined by a terminology system
....... system 1..1 uri Identity of the terminology system
....... code 1..1 code Symbol in syntax defined by the system
... approvalDate S 0..1 date When the plan definition was approved by publisher
... effectivePeriod S 0..1 Period When the plan definition is expected to be used
... action S 0..* BackboneElement Definition of action included in the plan
.... linkId S 0..1 string Unique id for the action in the PlanDefinition
.... title S 0..1 string User-visible title
.... description S 0..1 markdown Brief description of the action
.... code S 0..1 CodeableConcept Code representing the meaning of the action or sub-actions
Binding: ActionCodeVS (0.10.0) (example)
.... condition S 0..* BackboneElement Whether or not the action is applicable
..... kind S 1..1 code applicability | start | stop
Binding: ActionConditionVS (0.10.0) (required)
..... expression S 0..1 Expression Boolean-valued expression
.... relatedAction S 0..* BackboneElement Relationship to another action
..... targetId S 1..1 id Identifier of related action
..... relationship S 1..1 code before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
Binding: ActionRelationshipTypeVS (0.10.0) (required)
..... Slices for offset[x] S 0..1 Duration, Range Time offset for the relationship
Slice: Unordered, Open by type:$this
...... offset[x]:offsetDuration S 0..1 Duration Time offset for the relationship
...... offset[x]:offsetRange S 0..1 Range Time offset for the relationship
.... Slices for timing[x] S 0..1 When the action should take place
Slice: Unordered, Open by type:$this
..... timingAge Age
..... timingTiming Timing
..... timing[x]:timingAge S 0..1 Age When the action should take place
..... timing[x]:timingTiming S 0..1 Timing When the action should take place
.... participant S 0..* BackboneElement Who should participate in the action
..... actorId S 0..1 string What actor
..... type S 0..1 code careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Binding: ParticipantResourceTypesVS (0.10.0) (required)
.... definition[x] S 0..1 canonical(ActivityDefinition | MessageDefinition | ObservationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition), uri Description of the activity to be performed

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
PlanDefinition.versionAlgorithm[x] Base extensible Version algorithm types 📍0.10.0 This IG
PlanDefinition.status Base required Publication Status VS 📍0.10.0 This IG
PlanDefinition.useContext:scheduleCategory.​value[x] Base required UZ Core Immunization Schedule Type Value Set 📍0.10.0 This IG
PlanDefinition.useContext:jurisdiction.​value[x] Base required Uzbekistan Jurisdictions 📍0.10.0 This IG
PlanDefinition.action.​code Base example Action code translations 📍0.10.0 This IG
PlanDefinition.action.​condition.kind Base required Action condition translations 📍0.10.0 This IG
PlanDefinition.action.​relatedAction.relationship Base required Types of action relationship 📍0.10.0 This IG
PlanDefinition.action.​participant.type Base required Participant resource types translations 📍0.10.0 This IG

Constraints

Id Grade Path(s) Description Expression
uzcore-plandef-1 error PlanDefinition A schedule must declare exactly one focus useContext, so clients can tell what kind of schedule it is useContext.where(code.system = 'http://terminology.hl7.org/CodeSystem/usage-context-type' and code.code = 'focus').count() = 1
uzcore-plandef-2 error PlanDefinition A schedule is either national or regional: a jurisdiction of Uzbekistan as a whole cannot be combined with individual regions useContext.where(code.system = 'http://terminology.hl7.org/CodeSystem/usage-context-type' and code.code = 'jurisdiction' and value.ofType(CodeableConcept).coding.where(system = 'urn:iso:std:iso:3166' and code = 'UZ').exists()).exists() implies useContext.where(code.system = 'http://terminology.hl7.org/CodeSystem/usage-context-type' and code.code = 'jurisdiction').count() = 1
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PlanDefinition C 0..* PlanDefinition(5.0.0) The definition of a plan for a series of actions, independent of any specific patient or context
Interfaces Implemented: MetadataResource
Constraints: cnl-0, pld-3, pld-4, uzcore-plandef-1, uzcore-plandef-2
... 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: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... 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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:statusHistory S 0..* (Complex) History of PlanDefinition status changes
URL: https://dhp.uz/fhir/core/StructureDefinition/plan-definition-status-history
Constraints: ext-1
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... url SΣC 1..1 uri Canonical identifier for this PlanDefinition
Constraints: cnl-1
... identifier SΣ 0..* Identifier Additional identifier for the plan definition
... version SΣ 0..1 string Business version of the plan definition
... versionAlgorithm[x] SΣ 0..1 How to compare versions
Binding: VersionAlgorithmVS (0.10.0) (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name SΣC 1..1 string Machine-processable name for this PlanDefinition
... title SΣ 0..1 string Plan definition title (in Uzbek language)
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Plan definition title (in Russian and Karakalpak languages)
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:translation S 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
Constraints: ext-1
.... value 0..1 string Primitive value for string
Max Length:1048576
... subtitle 0..1 string Subordinate title of the plan definition
... type Σ 0..1 CodeableConcept order-set | clinical-protocol | eca-rule | workflow-definition
Binding: PlanDefinitionType (extensible): The type of PlanDefinition.
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatusVS (0.10.0) (required)
... experimental Σ 0..1 boolean For testing purposes, not real usage
... Slices for subject[x] S 0..1 Type of individual the plan definition is focused on
Slice: Unordered, Closed by type:$this
Binding: ParticipantResourceTypes (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
.... subjectCodeableConcept CodeableConcept
.... subjectReference Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition)
.... subject[x]:subjectCodeableConcept S 0..1 CodeableConcept Type of individual the plan definition is focused on
Binding: ParticipantResourceTypes (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
.... subject[x]:subjectReference S 0..1 Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition) Type of individual the plan definition is focused on
... date SΣ 0..1 dateTime Date last changed
... publisher SΣ 0..1 string Name of the publisher/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description SΣ 1..1 markdown Natural language description of the plan definition
... Slices for useContext SΣ 1..* UsageContext The context that the content is intended to support
Slice: Unordered, Open by value:value
.... useContext:immunizationFocus SΣ 0..1 UsageContext Marks this PlanDefinition as an immunization schedule
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... code Σ 1..1 Coding Type of context being specified
Binding: UsageContextType (1.0.1) (extensible): A code that specifies a type of context being specified by a usage context.
Required Pattern: At least the following
...... 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://terminology.hl7.org/CodeSystem/usage-context-type
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: focus
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 1..1 CodeableConcept Value that defines the context
Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified.
Required Pattern: At least the following
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... coding Σ 1..1 Coding Code defined by a terminology system

Fixed Value: (Complex)
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... version Σ 0..1 string Version of the system - if relevant
....... code ΣC 1..1 code Symbol in syntax defined by the system
Fixed Value: 33879002
....... display ΣC 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
.... useContext:scheduleCategory SΣ 0..1 UsageContext Kind of immunization schedule
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... code Σ 1..1 Coding Type of context being specified
Binding: UsageContextType (1.0.1) (extensible): A code that specifies a type of context being specified by a usage context.
Required Pattern: At least the following
...... 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://terminology.hl7.org/CodeSystem/usage-context-type
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: topic
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 1..1 CodeableConcept Value that defines the context
Binding: ImmunizationScheduleTypeVS (0.10.0) (required)
.... useContext:bloodDonationFocus SΣ 0..1 UsageContext Marks this PlanDefinition as a whole blood donation schedule
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... code Σ 1..1 Coding Type of context being specified
Binding: UsageContextType (1.0.1) (extensible): A code that specifies a type of context being specified by a usage context.
Required Pattern: At least the following
...... 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://terminology.hl7.org/CodeSystem/usage-context-type
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: focus
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 1..1 CodeableConcept Value that defines the context
Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified.
Required Pattern: At least the following
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... coding Σ 1..1 Coding Code defined by a terminology system

Fixed Value: (Complex)
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... version Σ 0..1 string Version of the system - if relevant
....... code ΣC 1..1 code Symbol in syntax defined by the system
Fixed Value: 25179006
....... display ΣC 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
.... useContext:screeningFocus SΣ 0..1 UsageContext Marks this PlanDefinition as a screening schedule
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... code Σ 1..1 Coding Type of context being specified
Binding: UsageContextType (1.0.1) (extensible): A code that specifies a type of context being specified by a usage context.
Required Pattern: At least the following
...... 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://terminology.hl7.org/CodeSystem/usage-context-type
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: focus
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 1..1 CodeableConcept Value that defines the context
Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified.
Required Pattern: At least the following
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... coding Σ 1..1 Coding Code defined by a terminology system

Fixed Value: (Complex)
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... version Σ 0..1 string Version of the system - if relevant
....... code ΣC 1..1 code Symbol in syntax defined by the system
Fixed Value: 360156006
....... display ΣC 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
.... useContext:jurisdiction SΣ 0..* UsageContext Where the schedule applies: Uzbekistan for a national schedule, or one entry per region for a regional one
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... code Σ 1..1 Coding Type of context being specified
Binding: UsageContextType (1.0.1) (extensible): A code that specifies a type of context being specified by a usage context.
Required Pattern: At least the following
...... 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://terminology.hl7.org/CodeSystem/usage-context-type
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: jurisdiction
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 1..1 CodeableConcept Value that defines the context
Binding: JurisdictionVS (0.10.0) (required)
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... coding Σ 1..1 Coding Code defined by a terminology system
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... system Σ 1..1 uri Identity of the terminology system
....... version Σ 0..1 string Version of the system - if relevant
....... code ΣC 1..1 code Symbol in syntax defined by the system
....... display ΣC 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
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for plan definition (if applicable)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.
... purpose 0..1 markdown Why this plan definition is defined
... usage 0..1 markdown Describes the clinical usage of the plan
... copyright 0..1 markdown Use and/or publishing restrictions
... copyrightLabel 0..1 string Copyright holder and year(s)
... approvalDate S 0..1 date When the plan definition was approved by publisher
... lastReviewDate 0..1 date When the plan definition was last reviewed by the publisher
... effectivePeriod SΣ 0..1 Period When the plan definition is expected to be used
... topic 0..* CodeableConcept E.g. Education, Treatment, Assessment
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
... author 0..* ContactDetail Who authored the content
... editor 0..* ContactDetail Who edited the content
... reviewer 0..* ContactDetail Who reviewed the content
... endorser 0..* ContactDetail Who endorsed the content
... relatedArtifact 0..* RelatedArtifact Additional documentation, citations
... library 0..* canonical(Library) Logic used by the plan definition
... goal C 0..* BackboneElement What the plan is trying to accomplish
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... category 0..1 CodeableConcept E.g. Treatment, dietary, behavioral
Binding: GoalCategory (example): Example codes for grouping goals for filtering or presentation.
.... description 1..1 CodeableConcept Code or text describing the goal
Binding: SNOMEDCTClinicalFindings (example): Describes goals that can be achieved.
.... priority 0..1 CodeableConcept high-priority | medium-priority | low-priority
Binding: GoalPriority (preferred): Indicates the level of importance associated with reaching or sustaining a goal.
.... start 0..1 CodeableConcept When goal pursuit begins
Binding: GoalStartEvent (example): Identifies the types of events that might trigger the start of a goal.
.... addresses 0..* CodeableConcept What does the goal address
Binding: ConditionProblemDiagnosisCodes (example): Identifies problems, conditions, issues, or concerns that goals may address.
.... documentation 0..* RelatedArtifact Supporting documentation for the goal
.... target 0..* BackboneElement Target outcome for the goal
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... measure 0..1 CodeableConcept The parameter whose value is to be tracked
Binding: LOINCCodes (example): Identifies types of parameters that can be tracked to determine goal achievement.
..... detail[x] 0..1 The target value to be achieved
...... detailQuantity Quantity
...... detailRange Range
...... detailCodeableConcept CodeableConcept
...... detailString string
...... detailBoolean boolean
...... detailInteger integer
...... detailRatio Ratio
..... due 0..1 Duration Reach goal within
... actor 0..* BackboneElement Actors within the plan
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... title 0..1 string User-visible title
.... description 0..1 markdown Describes the actor
.... option 1..* BackboneElement Who or what can be this actor
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... type 0..1 code careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Binding: ActionParticipantType (required): The type of participant in the activity.
..... typeCanonical 0..1 canonical(CapabilityStatement) Who or what can participate
..... typeReference 0..1 Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) Who or what can participate
..... role 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent
Binding: ActionParticipantRole (2.0.0) (example)
... action SC 0..* BackboneElement Definition of action included in the plan
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... linkId S 0..1 string Unique id for the action in the PlanDefinition
.... prefix 0..1 string User-visible prefix for the action (e.g. 1. or A.)
.... title S 0..1 string User-visible title
.... description S 0..1 markdown Brief description of the action
.... textEquivalent 0..1 markdown Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
.... priority 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
.... code S 0..1 CodeableConcept Code representing the meaning of the action or sub-actions
Binding: ActionCodeVS (0.10.0) (example)
.... reason 0..* CodeableConcept Why the action should be performed
Binding: ActionReasonCode (example): Provides examples of reasons for actions to be performed.
.... documentation 0..* RelatedArtifact Supporting documentation for the intended performer of the action
.... goalId C 0..* id What goals this action supports
.... subject[x] 0..1 Type of individual the action is focused on
Binding: ParticipantResourceTypes (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
..... subjectCodeableConcept CodeableConcept
..... subjectReference Reference(Group)
..... subjectCanonical canonical(Any)
.... trigger 0..* TriggerDefinition When the action should be triggered
.... condition S 0..* BackboneElement Whether or not the action is applicable
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... kind S 1..1 code applicability | start | stop
Binding: ActionConditionVS (0.10.0) (required)
..... expression S 0..1 Expression Boolean-valued expression
.... input C 0..* BackboneElement Input data requirements
Constraints: pld-0
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... title 0..1 string User-visible title
..... requirement C 0..1 DataRequirement What data is provided
..... relatedData C 0..1 id What data is provided
.... output C 0..* BackboneElement Output data definition
Constraints: pld-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... title 0..1 string User-visible title
..... requirement C 0..1 DataRequirement What data is provided
..... relatedData C 0..1 string What data is provided
.... relatedAction SC 0..* BackboneElement Relationship to another action
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... targetId SC 1..1 id Identifier of related action
..... relationship S 1..1 code before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
Binding: ActionRelationshipTypeVS (0.10.0) (required)
..... endRelationship 0..1 code before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
Binding: ActionRelationshipType (required): Defines the types of relationships between actions.
..... Slices for offset[x] S 0..1 Time offset for the relationship
Slice: Unordered, Closed by type:$this
...... offsetDuration Duration
...... offsetRange Range
...... offset[x]:offsetDuration S 0..1 Duration Time offset for the relationship
...... offset[x]:offsetRange S 0..1 Range Time offset for the relationship
.... Slices for timing[x] S 0..1 When the action should take place
Slice: Unordered, Closed by type:$this
..... timingAge Age
..... timingTiming Timing
..... timing[x]:timingAge S 0..1 Age When the action should take place
..... timing[x]:timingTiming S 0..1 Timing When the action should take place
.... location 0..1 CodeableReference(Location) Where it should happen
.... participant S 0..* BackboneElement Who should participate in the action
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... actorId S 0..1 string What actor
..... type S 0..1 code careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Binding: ParticipantResourceTypesVS (0.10.0) (required)
..... typeCanonical 0..1 canonical(CapabilityStatement) Who or what can participate
..... typeReference 0..1 Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) Who or what can participate
..... role 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent
Binding: ActionParticipantRole (2.0.0) (example): Defines roles played by participants for the action.
..... function 0..1 CodeableConcept E.g. Author, Reviewer, Witness, etc
Binding: ActionParticipantFunction (example)
.... type 0..1 CodeableConcept create | update | remove | fire-event
Binding: ActionType (extensible): The type of action to be performed.
.... groupingBehavior 0..1 code visual-group | logical-group | sentence-group
Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.
.... selectionBehavior 0..1 code any | all | all-or-none | exactly-one | at-most-one | one-or-more
Binding: ActionSelectionBehavior (required): Defines selection behavior of a group.
.... requiredBehavior 0..1 code must | could | must-unless-documented
Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.
.... precheckBehavior 0..1 code yes | no
Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.
.... cardinalityBehavior 0..1 code single | multiple
Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated.
.... definition[x] S 0..1 Description of the activity to be performed
..... definitionCanonical canonical(ActivityDefinition | MessageDefinition | ObservationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition)
..... definitionUri uri
.... transform 0..1 canonical(StructureMap) Transform to apply the template
.... dynamicValue 0..* BackboneElement Dynamic aspects of the definition
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... path 0..1 string The path to the element to be set dynamically
..... expression 0..1 Expression An expression that provides the dynamic value for the customization
.... action 0..* See action (PlanDefinition) A sub-action
... asNeeded[x] Σ 0..1 Preconditions for service
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.
.... asNeededBoolean boolean
.... asNeededCodeableConcept CodeableConcept

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PlanDefinition.language Base required All Languages 📍5.0.0 FHIR Std.
PlanDefinition.versionAlgorithm[x] Base extensible Version algorithm types 📍0.10.0 This IG
PlanDefinition.type Base extensible Plan Definition Type 📍5.0.0 FHIR Std.
PlanDefinition.status Base required Publication Status VS 📍0.10.0 This IG
PlanDefinition.subject[x] Base extensible Participant Resource Types 📍5.0.0 FHIR Std.
PlanDefinition.subject[x]:subjectCodeableConcept Base extensible Participant Resource Types 📍5.0.0 FHIR Std.
PlanDefinition.useContext:immunizationFocus.​code Base extensible UsageContextType 📍1.0.1 THO v7.3
PlanDefinition.useContext:immunizationFocus.​value[x] Base example Context of Use ValueSet 📍5.0.0 FHIR Std.
PlanDefinition.useContext:scheduleCategory.​code Base extensible UsageContextType 📍1.0.1 THO v7.3
PlanDefinition.useContext:scheduleCategory.​value[x] Base required UZ Core Immunization Schedule Type Value Set 📍0.10.0 This IG
PlanDefinition.useContext:bloodDonationFocus.​code Base extensible UsageContextType 📍1.0.1 THO v7.3
PlanDefinition.useContext:bloodDonationFocus.​value[x] Base example Context of Use ValueSet 📍5.0.0 FHIR Std.
PlanDefinition.useContext:screeningFocus.​code Base extensible UsageContextType 📍1.0.1 THO v7.3
PlanDefinition.useContext:screeningFocus.​value[x] Base example Context of Use ValueSet 📍5.0.0 FHIR Std.
PlanDefinition.useContext:jurisdiction.​code Base extensible UsageContextType 📍1.0.1 THO v7.3
PlanDefinition.useContext:jurisdiction.​value[x] Base required Uzbekistan Jurisdictions 📍0.10.0 This IG
PlanDefinition.jurisdiction Base extensible Jurisdiction ValueSet 📍5.0.0 FHIR Std.
PlanDefinition.topic Base example Definition Topic 📍5.0.0 FHIR Std.
PlanDefinition.goal.​category Base example Goal Category 📍5.0.0 FHIR Std.
PlanDefinition.goal.​description Base example SNOMED CT Clinical Findings 📍5.0.0 FHIR Std.
PlanDefinition.goal.​priority Base preferred Goal Priority 📍5.0.0 FHIR Std.
PlanDefinition.goal.​start Base example Goal Start Event 📍5.0.0 FHIR Std.
PlanDefinition.goal.​addresses Base example Condition/Problem/Diagnosis Codes 📍5.0.0 FHIR Std.
PlanDefinition.goal.​target.measure Base example LOINC Codes 📍5.0.0 FHIR Std.
PlanDefinition.actor.​option.type Base required Action Participant Type 📍5.0.0 FHIR Std.
PlanDefinition.actor.​option.role Base example Action Participant Role 📍2.0.0 THO v7.3
PlanDefinition.action.​priority Base required RequestPriority 📍5.0.0 FHIR Std.
PlanDefinition.action.​code Base example Action code translations 📍0.10.0 This IG
PlanDefinition.action.​reason Base example Action Reason Code 📍5.0.0 FHIR Std.
PlanDefinition.action.​subject[x] Base extensible Participant Resource Types 📍5.0.0 FHIR Std.
PlanDefinition.action.​condition.kind Base required Action condition translations 📍0.10.0 This IG
PlanDefinition.action.​relatedAction.relationship Base required Types of action relationship 📍0.10.0 This IG
PlanDefinition.action.​relatedAction.endRelationship Base required Action Relationship Type 📍5.0.0 FHIR Std.
PlanDefinition.action.​participant.type Base required Participant resource types translations 📍0.10.0 This IG
PlanDefinition.action.​participant.role Base example Action Participant Role 📍2.0.0 THO v7.3
PlanDefinition.action.​participant.function Base example Action Participant Function 📍5.0.0 FHIR Std.
PlanDefinition.action.​type Base extensible Action Type 📍5.0.0 FHIR Std.
PlanDefinition.action.​groupingBehavior Base required Action Grouping Behavior 📍5.0.0 FHIR Std.
PlanDefinition.action.​selectionBehavior Base required Action Selection Behavior 📍5.0.0 FHIR Std.
PlanDefinition.action.​requiredBehavior Base required Action Required Behavior 📍5.0.0 FHIR Std.
PlanDefinition.action.​precheckBehavior Base required Action Precheck Behavior 📍5.0.0 FHIR Std.
PlanDefinition.action.​cardinalityBehavior Base required Action Cardinality Behavior 📍5.0.0 FHIR Std.
PlanDefinition.asNeeded[x] Base example SNOMED CT Medication As Needed Reason Codes 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
uzcore-plandef-1 error PlanDefinition A schedule must declare exactly one focus useContext, so clients can tell what kind of schedule it is useContext.where(code.system = 'http://terminology.hl7.org/CodeSystem/usage-context-type' and code.code = 'focus').count() = 1
uzcore-plandef-2 error PlanDefinition A schedule is either national or regional: a jurisdiction of Uzbekistan as a whole cannot be combined with individual regions useContext.where(code.system = 'http://terminology.hl7.org/CodeSystem/usage-context-type' and code.code = 'jurisdiction' and value.ofType(CodeableConcept).coding.where(system = 'urn:iso:std:iso:3166' and code = 'UZ').exists()).exists() implies useContext.where(code.system = 'http://terminology.hl7.org/CodeSystem/usage-context-type' and code.code = 'jurisdiction').count() = 1

Summary

Mandatory: 4 elements(12 nested mandatory elements)
Must-Support: 44 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of PlanDefinition.subject[x]
  • The element 1 is sliced based on the value of PlanDefinition.useContext
  • The element 1 is sliced based on the value of PlanDefinition.action.relatedAction.offset[x]
  • The element 1 is sliced based on the value of PlanDefinition.action.timing[x]

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PlanDefinition C 0..* PlanDefinition(5.0.0) The definition of a plan for a series of actions, independent of any specific patient or context
Interfaces Implemented: MetadataResource
Constraints: cnl-0, pld-3, pld-4, uzcore-plandef-1, uzcore-plandef-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:statusHistory S 0..* (Complex) History of PlanDefinition status changes
URL: https://dhp.uz/fhir/core/StructureDefinition/plan-definition-status-history
Constraints: ext-1
... url SΣC 1..1 uri Canonical identifier for this PlanDefinition
Constraints: cnl-1
... identifier SΣ 0..* Identifier Additional identifier for the plan definition
... version SΣ 0..1 string Business version of the plan definition
... versionAlgorithm[x] SΣ 0..1 How to compare versions
Binding: VersionAlgorithmVS (0.10.0) (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name SΣC 1..1 string Machine-processable name for this PlanDefinition
... title SΣ 0..1 string Plan definition title (in Uzbek language)
.... Slices for extension 0..* Extension Plan definition title (in Russian and Karakalpak languages)
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:translation S 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
Constraints: ext-1
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatusVS (0.10.0) (required)
... Slices for subject[x] S 0..1 Type of individual the plan definition is focused on
Slice: Unordered, Closed by type:$this
Binding: ParticipantResourceTypes (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
.... subjectCodeableConcept CodeableConcept
.... subjectReference Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition)
.... subject[x]:subjectCodeableConcept S 0..1 CodeableConcept Type of individual the plan definition is focused on
Binding: ParticipantResourceTypes (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
.... subject[x]:subjectReference S 0..1 Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition) Type of individual the plan definition is focused on
... date SΣ 0..1 dateTime Date last changed
... publisher SΣ 0..1 string Name of the publisher/steward (organization or individual)
... description SΣ 1..1 markdown Natural language description of the plan definition
... Slices for useContext SΣ 1..* UsageContext The context that the content is intended to support
Slice: Unordered, Open by value:value
.... useContext:immunizationFocus SΣ 0..1 UsageContext Marks this PlanDefinition as an immunization schedule
..... code Σ 1..1 Coding Type of context being specified
Binding: UsageContextType (1.0.1) (extensible): A code that specifies a type of context being specified by a usage context.
Required Pattern: At least the following
...... 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://terminology.hl7.org/CodeSystem/usage-context-type
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: focus
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 1..1 CodeableConcept Value that defines the context
Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified.
Required Pattern: At least the following
...... coding Σ 1..1 Coding Code defined by a terminology system

Fixed Value: (Complex)
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... code ΣC 1..1 code Symbol in syntax defined by the system
Fixed Value: 33879002
.... useContext:scheduleCategory SΣ 0..1 UsageContext Kind of immunization schedule
..... code Σ 1..1 Coding Type of context being specified
Binding: UsageContextType (1.0.1) (extensible): A code that specifies a type of context being specified by a usage context.
Required Pattern: At least the following
...... 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://terminology.hl7.org/CodeSystem/usage-context-type
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: topic
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 1..1 CodeableConcept Value that defines the context
Binding: ImmunizationScheduleTypeVS (0.10.0) (required)
.... useContext:bloodDonationFocus SΣ 0..1 UsageContext Marks this PlanDefinition as a whole blood donation schedule
..... code Σ 1..1 Coding Type of context being specified
Binding: UsageContextType (1.0.1) (extensible): A code that specifies a type of context being specified by a usage context.
Required Pattern: At least the following
...... 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://terminology.hl7.org/CodeSystem/usage-context-type
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: focus
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 1..1 CodeableConcept Value that defines the context
Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified.
Required Pattern: At least the following
...... coding Σ 1..1 Coding Code defined by a terminology system

Fixed Value: (Complex)
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... code ΣC 1..1 code Symbol in syntax defined by the system
Fixed Value: 25179006
.... useContext:screeningFocus SΣ 0..1 UsageContext Marks this PlanDefinition as a screening schedule
..... code Σ 1..1 Coding Type of context being specified
Binding: UsageContextType (1.0.1) (extensible): A code that specifies a type of context being specified by a usage context.
Required Pattern: At least the following
...... 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://terminology.hl7.org/CodeSystem/usage-context-type
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: focus
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 1..1 CodeableConcept Value that defines the context
Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified.
Required Pattern: At least the following
...... coding Σ 1..1 Coding Code defined by a terminology system

Fixed Value: (Complex)
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... code ΣC 1..1 code Symbol in syntax defined by the system
Fixed Value: 360156006
.... useContext:jurisdiction SΣ 0..* UsageContext Where the schedule applies: Uzbekistan for a national schedule, or one entry per region for a regional one
..... code Σ 1..1 Coding Type of context being specified
Binding: UsageContextType (1.0.1) (extensible): A code that specifies a type of context being specified by a usage context.
Required Pattern: At least the following
...... 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://terminology.hl7.org/CodeSystem/usage-context-type
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: jurisdiction
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 1..1 CodeableConcept Value that defines the context
Binding: JurisdictionVS (0.10.0) (required)
...... coding Σ 1..1 Coding Code defined by a terminology system
....... system Σ 1..1 uri Identity of the terminology system
....... code ΣC 1..1 code Symbol in syntax defined by the system
... approvalDate S 0..1 date When the plan definition was approved by publisher
... effectivePeriod SΣ 0..1 Period When the plan definition is expected to be used
... action SC 0..* BackboneElement Definition of action included in the plan
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... linkId S 0..1 string Unique id for the action in the PlanDefinition
.... title S 0..1 string User-visible title
.... description S 0..1 markdown Brief description of the action
.... code S 0..1 CodeableConcept Code representing the meaning of the action or sub-actions
Binding: ActionCodeVS (0.10.0) (example)
.... condition S 0..* BackboneElement Whether or not the action is applicable
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... kind S 1..1 code applicability | start | stop
Binding: ActionConditionVS (0.10.0) (required)
..... expression S 0..1 Expression Boolean-valued expression
.... relatedAction SC 0..* BackboneElement Relationship to another action
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... targetId SC 1..1 id Identifier of related action
..... relationship S 1..1 code before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
Binding: ActionRelationshipTypeVS (0.10.0) (required)
..... Slices for offset[x] S 0..1 Time offset for the relationship
Slice: Unordered, Closed by type:$this
...... offsetDuration Duration
...... offsetRange Range
...... offset[x]:offsetDuration S 0..1 Duration Time offset for the relationship
...... offset[x]:offsetRange S 0..1 Range Time offset for the relationship
.... Slices for timing[x] S 0..1 When the action should take place
Slice: Unordered, Closed by type:$this
..... timingAge Age
..... timingTiming Timing
..... timing[x]:timingAge S 0..1 Age When the action should take place
..... timing[x]:timingTiming S 0..1 Timing When the action should take place
.... participant S 0..* BackboneElement Who should participate in the action
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... actorId S 0..1 string What actor
..... type S 0..1 code careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Binding: ParticipantResourceTypesVS (0.10.0) (required)
.... definition[x] S 0..1 Description of the activity to be performed
..... definitionCanonical canonical(ActivityDefinition | MessageDefinition | ObservationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition)
..... definitionUri uri

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PlanDefinition.versionAlgorithm[x] Base extensible Version algorithm types 📍0.10.0 This IG
PlanDefinition.status Base required Publication Status VS 📍0.10.0 This IG
PlanDefinition.subject[x] Base extensible Participant Resource Types 📍5.0.0 FHIR Std.
PlanDefinition.subject[x]:subjectCodeableConcept Base extensible Participant Resource Types 📍5.0.0 FHIR Std.
PlanDefinition.useContext:immunizationFocus.​code Base extensible UsageContextType 📍1.0.1 THO v7.3
PlanDefinition.useContext:immunizationFocus.​value[x] Base example Context of Use ValueSet 📍5.0.0 FHIR Std.
PlanDefinition.useContext:scheduleCategory.​code Base extensible UsageContextType 📍1.0.1 THO v7.3
PlanDefinition.useContext:scheduleCategory.​value[x] Base required UZ Core Immunization Schedule Type Value Set 📍0.10.0 This IG
PlanDefinition.useContext:bloodDonationFocus.​code Base extensible UsageContextType 📍1.0.1 THO v7.3
PlanDefinition.useContext:bloodDonationFocus.​value[x] Base example Context of Use ValueSet 📍5.0.0 FHIR Std.
PlanDefinition.useContext:screeningFocus.​code Base extensible UsageContextType 📍1.0.1 THO v7.3
PlanDefinition.useContext:screeningFocus.​value[x] Base example Context of Use ValueSet 📍5.0.0 FHIR Std.
PlanDefinition.useContext:jurisdiction.​code Base extensible UsageContextType 📍1.0.1 THO v7.3
PlanDefinition.useContext:jurisdiction.​value[x] Base required Uzbekistan Jurisdictions 📍0.10.0 This IG
PlanDefinition.action.​code Base example Action code translations 📍0.10.0 This IG
PlanDefinition.action.​condition.kind Base required Action condition translations 📍0.10.0 This IG
PlanDefinition.action.​relatedAction.relationship Base required Types of action relationship 📍0.10.0 This IG
PlanDefinition.action.​participant.type Base required Participant resource types translations 📍0.10.0 This IG

Constraints

Id Grade Path(s) Description Expression
uzcore-plandef-1 error PlanDefinition A schedule must declare exactly one focus useContext, so clients can tell what kind of schedule it is useContext.where(code.system = 'http://terminology.hl7.org/CodeSystem/usage-context-type' and code.code = 'focus').count() = 1
uzcore-plandef-2 error PlanDefinition A schedule is either national or regional: a jurisdiction of Uzbekistan as a whole cannot be combined with individual regions useContext.where(code.system = 'http://terminology.hl7.org/CodeSystem/usage-context-type' and code.code = 'jurisdiction' and value.ofType(CodeableConcept).coding.where(system = 'urn:iso:std:iso:3166' and code = 'UZ').exists()).exists() implies useContext.where(code.system = 'http://terminology.hl7.org/CodeSystem/usage-context-type' and code.code = 'jurisdiction').count() = 1

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PlanDefinition C 0..* PlanDefinition(5.0.0) The definition of a plan for a series of actions, independent of any specific patient or context
Interfaces Implemented: MetadataResource
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:statusHistory S 0..* (Complex) History of PlanDefinition status changes
URL: https://dhp.uz/fhir/core/StructureDefinition/plan-definition-status-history
... url S 1..1 uri Canonical identifier for this PlanDefinition
... identifier S 0..* Identifier Additional identifier for the plan definition
... versionAlgorithm[x] S 0..1 string, Coding How to compare versions
Binding: VersionAlgorithmVS (0.10.0) (extensible)
... name S 1..1 string Machine-processable name for this PlanDefinition
... title S 0..1 string Plan definition title (in Uzbek language)
.... Slices for extension 0..* Extension Plan definition title (in Russian and Karakalpak languages)
Slice: Unordered, Open by value:url
..... extension:translation S 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
... status S 1..1 code draft | active | retired | unknown
Binding: PublicationStatusVS (0.10.0) (required)
... Slices for subject[x] S 0..1 Type of individual the plan definition is focused on
Slice: Unordered, Open by type:$this
.... subjectCodeableConcept CodeableConcept
.... subjectReference Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition)
.... subject[x]:subjectCodeableConcept S 0..1 CodeableConcept Type of individual the plan definition is focused on
.... subject[x]:subjectReference S 0..1 Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition) Type of individual the plan definition is focused on
... date S 0..1 dateTime Date last changed
... publisher S 0..1 string Name of the publisher/steward (organization or individual)
... description S 1..1 markdown Natural language description of the plan definition
... Slices for useContext S 1..* UsageContext The context that the content is intended to support
Slice: Unordered, Open by value:value
.... useContext:immunizationFocus S 0..1 UsageContext Marks this PlanDefinition as an immunization schedule
..... code 1..1 Coding Type of context being specified
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: focus
..... value[x] 1..1 CodeableConcept Value that defines the context
Required Pattern: At least the following
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 33879002
.... useContext:scheduleCategory S 0..1 UsageContext Kind of immunization schedule
..... code 1..1 Coding Type of context being specified
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: topic
..... value[x] 1..1 CodeableConcept Value that defines the context
Binding: ImmunizationScheduleTypeVS (0.10.0) (required)
.... useContext:bloodDonationFocus S 0..1 UsageContext Marks this PlanDefinition as a whole blood donation schedule
..... code 1..1 Coding Type of context being specified
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: focus
..... value[x] 1..1 CodeableConcept Value that defines the context
Required Pattern: At least the following
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 25179006
.... useContext:screeningFocus S 0..1 UsageContext Marks this PlanDefinition as a screening schedule
..... code 1..1 Coding Type of context being specified
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: focus
..... value[x] 1..1 CodeableConcept Value that defines the context
Required Pattern: At least the following
...... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 360156006
.... useContext:jurisdiction S 0..* UsageContext Where the schedule applies: Uzbekistan for a national schedule, or one entry per region for a regional one
..... code 1..1 Coding Type of context being specified
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: jurisdiction
..... value[x] 1..1 CodeableConcept Value that defines the context
Binding: JurisdictionVS (0.10.0) (required)
...... coding 1..1 Coding Code defined by a terminology system
....... system 1..1 uri Identity of the terminology system
....... code 1..1 code Symbol in syntax defined by the system
... approvalDate S 0..1 date When the plan definition was approved by publisher
... effectivePeriod S 0..1 Period When the plan definition is expected to be used
... action S 0..* BackboneElement Definition of action included in the plan
.... linkId S 0..1 string Unique id for the action in the PlanDefinition
.... title S 0..1 string User-visible title
.... description S 0..1 markdown Brief description of the action
.... code S 0..1 CodeableConcept Code representing the meaning of the action or sub-actions
Binding: ActionCodeVS (0.10.0) (example)
.... condition S 0..* BackboneElement Whether or not the action is applicable
..... kind S 1..1 code applicability | start | stop
Binding: ActionConditionVS (0.10.0) (required)
..... expression S 0..1 Expression Boolean-valued expression
.... relatedAction S 0..* BackboneElement Relationship to another action
..... targetId S 1..1 id Identifier of related action
..... relationship S 1..1 code before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
Binding: ActionRelationshipTypeVS (0.10.0) (required)
..... Slices for offset[x] S 0..1 Duration, Range Time offset for the relationship
Slice: Unordered, Open by type:$this
...... offset[x]:offsetDuration S 0..1 Duration Time offset for the relationship
...... offset[x]:offsetRange S 0..1 Range Time offset for the relationship
.... Slices for timing[x] S 0..1 When the action should take place
Slice: Unordered, Open by type:$this
..... timingAge Age
..... timingTiming Timing
..... timing[x]:timingAge S 0..1 Age When the action should take place
..... timing[x]:timingTiming S 0..1 Timing When the action should take place
.... participant S 0..* BackboneElement Who should participate in the action
..... actorId S 0..1 string What actor
..... type S 0..1 code careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Binding: ParticipantResourceTypesVS (0.10.0) (required)
.... definition[x] S 0..1 canonical(ActivityDefinition | MessageDefinition | ObservationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition), uri Description of the activity to be performed

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
PlanDefinition.versionAlgorithm[x] Base extensible Version algorithm types 📍0.10.0 This IG
PlanDefinition.status Base required Publication Status VS 📍0.10.0 This IG
PlanDefinition.useContext:scheduleCategory.​value[x] Base required UZ Core Immunization Schedule Type Value Set 📍0.10.0 This IG
PlanDefinition.useContext:jurisdiction.​value[x] Base required Uzbekistan Jurisdictions 📍0.10.0 This IG
PlanDefinition.action.​code Base example Action code translations 📍0.10.0 This IG
PlanDefinition.action.​condition.kind Base required Action condition translations 📍0.10.0 This IG
PlanDefinition.action.​relatedAction.relationship Base required Types of action relationship 📍0.10.0 This IG
PlanDefinition.action.​participant.type Base required Participant resource types translations 📍0.10.0 This IG

Constraints

Id Grade Path(s) Description Expression
uzcore-plandef-1 error PlanDefinition A schedule must declare exactly one focus useContext, so clients can tell what kind of schedule it is useContext.where(code.system = 'http://terminology.hl7.org/CodeSystem/usage-context-type' and code.code = 'focus').count() = 1
uzcore-plandef-2 error PlanDefinition A schedule is either national or regional: a jurisdiction of Uzbekistan as a whole cannot be combined with individual regions useContext.where(code.system = 'http://terminology.hl7.org/CodeSystem/usage-context-type' and code.code = 'jurisdiction' and value.ofType(CodeableConcept).coding.where(system = 'urn:iso:std:iso:3166' and code = 'UZ').exists()).exists() implies useContext.where(code.system = 'http://terminology.hl7.org/CodeSystem/usage-context-type' and code.code = 'jurisdiction').count() = 1

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PlanDefinition C 0..* PlanDefinition(5.0.0) The definition of a plan for a series of actions, independent of any specific patient or context
Interfaces Implemented: MetadataResource
Constraints: cnl-0, pld-3, pld-4, uzcore-plandef-1, uzcore-plandef-2
... 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: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... 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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:statusHistory S 0..* (Complex) History of PlanDefinition status changes
URL: https://dhp.uz/fhir/core/StructureDefinition/plan-definition-status-history
Constraints: ext-1
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... url SΣC 1..1 uri Canonical identifier for this PlanDefinition
Constraints: cnl-1
... identifier SΣ 0..* Identifier Additional identifier for the plan definition
... version SΣ 0..1 string Business version of the plan definition
... versionAlgorithm[x] SΣ 0..1 How to compare versions
Binding: VersionAlgorithmVS (0.10.0) (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name SΣC 1..1 string Machine-processable name for this PlanDefinition
... title SΣ 0..1 string Plan definition title (in Uzbek language)
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Plan definition title (in Russian and Karakalpak languages)
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:translation S 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
Constraints: ext-1
.... value 0..1 string Primitive value for string
Max Length:1048576
... subtitle 0..1 string Subordinate title of the plan definition
... type Σ 0..1 CodeableConcept order-set | clinical-protocol | eca-rule | workflow-definition
Binding: PlanDefinitionType (extensible): The type of PlanDefinition.
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatusVS (0.10.0) (required)
... experimental Σ 0..1 boolean For testing purposes, not real usage
... Slices for subject[x] S 0..1 Type of individual the plan definition is focused on
Slice: Unordered, Closed by type:$this
Binding: ParticipantResourceTypes (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
.... subjectCodeableConcept CodeableConcept
.... subjectReference Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition)
.... subject[x]:subjectCodeableConcept S 0..1 CodeableConcept Type of individual the plan definition is focused on
Binding: ParticipantResourceTypes (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
.... subject[x]:subjectReference S 0..1 Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition) Type of individual the plan definition is focused on
... date SΣ 0..1 dateTime Date last changed
... publisher SΣ 0..1 string Name of the publisher/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description SΣ 1..1 markdown Natural language description of the plan definition
... Slices for useContext SΣ 1..* UsageContext The context that the content is intended to support
Slice: Unordered, Open by value:value
.... useContext:immunizationFocus SΣ 0..1 UsageContext Marks this PlanDefinition as an immunization schedule
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... code Σ 1..1 Coding Type of context being specified
Binding: UsageContextType (1.0.1) (extensible): A code that specifies a type of context being specified by a usage context.
Required Pattern: At least the following
...... 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://terminology.hl7.org/CodeSystem/usage-context-type
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: focus
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 1..1 CodeableConcept Value that defines the context
Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified.
Required Pattern: At least the following
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... coding Σ 1..1 Coding Code defined by a terminology system

Fixed Value: (Complex)
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... version Σ 0..1 string Version of the system - if relevant
....... code ΣC 1..1 code Symbol in syntax defined by the system
Fixed Value: 33879002
....... display ΣC 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
.... useContext:scheduleCategory SΣ 0..1 UsageContext Kind of immunization schedule
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... code Σ 1..1 Coding Type of context being specified
Binding: UsageContextType (1.0.1) (extensible): A code that specifies a type of context being specified by a usage context.
Required Pattern: At least the following
...... 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://terminology.hl7.org/CodeSystem/usage-context-type
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: topic
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 1..1 CodeableConcept Value that defines the context
Binding: ImmunizationScheduleTypeVS (0.10.0) (required)
.... useContext:bloodDonationFocus SΣ 0..1 UsageContext Marks this PlanDefinition as a whole blood donation schedule
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... code Σ 1..1 Coding Type of context being specified
Binding: UsageContextType (1.0.1) (extensible): A code that specifies a type of context being specified by a usage context.
Required Pattern: At least the following
...... 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://terminology.hl7.org/CodeSystem/usage-context-type
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: focus
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 1..1 CodeableConcept Value that defines the context
Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified.
Required Pattern: At least the following
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... coding Σ 1..1 Coding Code defined by a terminology system

Fixed Value: (Complex)
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... version Σ 0..1 string Version of the system - if relevant
....... code ΣC 1..1 code Symbol in syntax defined by the system
Fixed Value: 25179006
....... display ΣC 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
.... useContext:screeningFocus SΣ 0..1 UsageContext Marks this PlanDefinition as a screening schedule
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... code Σ 1..1 Coding Type of context being specified
Binding: UsageContextType (1.0.1) (extensible): A code that specifies a type of context being specified by a usage context.
Required Pattern: At least the following
...... 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://terminology.hl7.org/CodeSystem/usage-context-type
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: focus
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 1..1 CodeableConcept Value that defines the context
Binding: ContextOfUseValueSet (example): A code that defines the specific value for the context being specified.
Required Pattern: At least the following
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... coding Σ 1..1 Coding Code defined by a terminology system

Fixed Value: (Complex)
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... version Σ 0..1 string Version of the system - if relevant
....... code ΣC 1..1 code Symbol in syntax defined by the system
Fixed Value: 360156006
....... display ΣC 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
.... useContext:jurisdiction SΣ 0..* UsageContext Where the schedule applies: Uzbekistan for a national schedule, or one entry per region for a regional one
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... code Σ 1..1 Coding Type of context being specified
Binding: UsageContextType (1.0.1) (extensible): A code that specifies a type of context being specified by a usage context.
Required Pattern: At least the following
...... 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://terminology.hl7.org/CodeSystem/usage-context-type
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: jurisdiction
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... value[x] Σ 1..1 CodeableConcept Value that defines the context
Binding: JurisdictionVS (0.10.0) (required)
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... coding Σ 1..1 Coding Code defined by a terminology system
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... system Σ 1..1 uri Identity of the terminology system
....... version Σ 0..1 string Version of the system - if relevant
....... code ΣC 1..1 code Symbol in syntax defined by the system
....... display ΣC 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
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for plan definition (if applicable)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.
... purpose 0..1 markdown Why this plan definition is defined
... usage 0..1 markdown Describes the clinical usage of the plan
... copyright 0..1 markdown Use and/or publishing restrictions
... copyrightLabel 0..1 string Copyright holder and year(s)
... approvalDate S 0..1 date When the plan definition was approved by publisher
... lastReviewDate 0..1 date When the plan definition was last reviewed by the publisher
... effectivePeriod SΣ 0..1 Period When the plan definition is expected to be used
... topic 0..* CodeableConcept E.g. Education, Treatment, Assessment
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
... author 0..* ContactDetail Who authored the content
... editor 0..* ContactDetail Who edited the content
... reviewer 0..* ContactDetail Who reviewed the content
... endorser 0..* ContactDetail Who endorsed the content
... relatedArtifact 0..* RelatedArtifact Additional documentation, citations
... library 0..* canonical(Library) Logic used by the plan definition
... goal C 0..* BackboneElement What the plan is trying to accomplish
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... category 0..1 CodeableConcept E.g. Treatment, dietary, behavioral
Binding: GoalCategory (example): Example codes for grouping goals for filtering or presentation.
.... description 1..1 CodeableConcept Code or text describing the goal
Binding: SNOMEDCTClinicalFindings (example): Describes goals that can be achieved.
.... priority 0..1 CodeableConcept high-priority | medium-priority | low-priority
Binding: GoalPriority (preferred): Indicates the level of importance associated with reaching or sustaining a goal.
.... start 0..1 CodeableConcept When goal pursuit begins
Binding: GoalStartEvent (example): Identifies the types of events that might trigger the start of a goal.
.... addresses 0..* CodeableConcept What does the goal address
Binding: ConditionProblemDiagnosisCodes (example): Identifies problems, conditions, issues, or concerns that goals may address.
.... documentation 0..* RelatedArtifact Supporting documentation for the goal
.... target 0..* BackboneElement Target outcome for the goal
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... measure 0..1 CodeableConcept The parameter whose value is to be tracked
Binding: LOINCCodes (example): Identifies types of parameters that can be tracked to determine goal achievement.
..... detail[x] 0..1 The target value to be achieved
...... detailQuantity Quantity
...... detailRange Range
...... detailCodeableConcept CodeableConcept
...... detailString string
...... detailBoolean boolean
...... detailInteger integer
...... detailRatio Ratio
..... due 0..1 Duration Reach goal within
... actor 0..* BackboneElement Actors within the plan
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... title 0..1 string User-visible title
.... description 0..1 markdown Describes the actor
.... option 1..* BackboneElement Who or what can be this actor
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... type 0..1 code careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Binding: ActionParticipantType (required): The type of participant in the activity.
..... typeCanonical 0..1 canonical(CapabilityStatement) Who or what can participate
..... typeReference 0..1 Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) Who or what can participate
..... role 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent
Binding: ActionParticipantRole (2.0.0) (example)
... action SC 0..* BackboneElement Definition of action included in the plan
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... linkId S 0..1 string Unique id for the action in the PlanDefinition
.... prefix 0..1 string User-visible prefix for the action (e.g. 1. or A.)
.... title S 0..1 string User-visible title
.... description S 0..1 markdown Brief description of the action
.... textEquivalent 0..1 markdown Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
.... priority 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
.... code S 0..1 CodeableConcept Code representing the meaning of the action or sub-actions
Binding: ActionCodeVS (0.10.0) (example)
.... reason 0..* CodeableConcept Why the action should be performed
Binding: ActionReasonCode (example): Provides examples of reasons for actions to be performed.
.... documentation 0..* RelatedArtifact Supporting documentation for the intended performer of the action
.... goalId C 0..* id What goals this action supports
.... subject[x] 0..1 Type of individual the action is focused on
Binding: ParticipantResourceTypes (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
..... subjectCodeableConcept CodeableConcept
..... subjectReference Reference(Group)
..... subjectCanonical canonical(Any)
.... trigger 0..* TriggerDefinition When the action should be triggered
.... condition S 0..* BackboneElement Whether or not the action is applicable
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... kind S 1..1 code applicability | start | stop
Binding: ActionConditionVS (0.10.0) (required)
..... expression S 0..1 Expression Boolean-valued expression
.... input C 0..* BackboneElement Input data requirements
Constraints: pld-0
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... title 0..1 string User-visible title
..... requirement C 0..1 DataRequirement What data is provided
..... relatedData C 0..1 id What data is provided
.... output C 0..* BackboneElement Output data definition
Constraints: pld-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... title 0..1 string User-visible title
..... requirement C 0..1 DataRequirement What data is provided
..... relatedData C 0..1 string What data is provided
.... relatedAction SC 0..* BackboneElement Relationship to another action
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... targetId SC 1..1 id Identifier of related action
..... relationship S 1..1 code before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
Binding: ActionRelationshipTypeVS (0.10.0) (required)
..... endRelationship 0..1 code before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
Binding: ActionRelationshipType (required): Defines the types of relationships between actions.
..... Slices for offset[x] S 0..1 Time offset for the relationship
Slice: Unordered, Closed by type:$this
...... offsetDuration Duration
...... offsetRange Range
...... offset[x]:offsetDuration S 0..1 Duration Time offset for the relationship
...... offset[x]:offsetRange S 0..1 Range Time offset for the relationship
.... Slices for timing[x] S 0..1 When the action should take place
Slice: Unordered, Closed by type:$this
..... timingAge Age
..... timingTiming Timing
..... timing[x]:timingAge S 0..1 Age When the action should take place
..... timing[x]:timingTiming S 0..1 Timing When the action should take place
.... location 0..1 CodeableReference(Location) Where it should happen
.... participant S 0..* BackboneElement Who should participate in the action
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... actorId S 0..1 string What actor
..... type S 0..1 code careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Binding: ParticipantResourceTypesVS (0.10.0) (required)
..... typeCanonical 0..1 canonical(CapabilityStatement) Who or what can participate
..... typeReference 0..1 Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) Who or what can participate
..... role 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent
Binding: ActionParticipantRole (2.0.0) (example): Defines roles played by participants for the action.
..... function 0..1 CodeableConcept E.g. Author, Reviewer, Witness, etc
Binding: ActionParticipantFunction (example)
.... type 0..1 CodeableConcept create | update | remove | fire-event
Binding: ActionType (extensible): The type of action to be performed.
.... groupingBehavior 0..1 code visual-group | logical-group | sentence-group
Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.
.... selectionBehavior 0..1 code any | all | all-or-none | exactly-one | at-most-one | one-or-more
Binding: ActionSelectionBehavior (required): Defines selection behavior of a group.
.... requiredBehavior 0..1 code must | could | must-unless-documented
Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.
.... precheckBehavior 0..1 code yes | no
Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.
.... cardinalityBehavior 0..1 code single | multiple
Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated.
.... definition[x] S 0..1 Description of the activity to be performed
..... definitionCanonical canonical(ActivityDefinition | MessageDefinition | ObservationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition)
..... definitionUri uri
.... transform 0..1 canonical(StructureMap) Transform to apply the template
.... dynamicValue 0..* BackboneElement Dynamic aspects of the definition
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... path 0..1 string The path to the element to be set dynamically
..... expression 0..1 Expression An expression that provides the dynamic value for the customization
.... action 0..* See action (PlanDefinition) A sub-action
... asNeeded[x] Σ 0..1 Preconditions for service
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.
.... asNeededBoolean boolean
.... asNeededCodeableConcept CodeableConcept

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PlanDefinition.language Base required All Languages 📍5.0.0 FHIR Std.
PlanDefinition.versionAlgorithm[x] Base extensible Version algorithm types 📍0.10.0 This IG
PlanDefinition.type Base extensible Plan Definition Type 📍5.0.0 FHIR Std.
PlanDefinition.status Base required Publication Status VS 📍0.10.0 This IG
PlanDefinition.subject[x] Base extensible Participant Resource Types 📍5.0.0 FHIR Std.
PlanDefinition.subject[x]:subjectCodeableConcept Base extensible Participant Resource Types 📍5.0.0 FHIR Std.
PlanDefinition.useContext:immunizationFocus.​code Base extensible UsageContextType 📍1.0.1 THO v7.3
PlanDefinition.useContext:immunizationFocus.​value[x] Base example Context of Use ValueSet 📍5.0.0 FHIR Std.
PlanDefinition.useContext:scheduleCategory.​code Base extensible UsageContextType 📍1.0.1 THO v7.3
PlanDefinition.useContext:scheduleCategory.​value[x] Base required UZ Core Immunization Schedule Type Value Set 📍0.10.0 This IG
PlanDefinition.useContext:bloodDonationFocus.​code Base extensible UsageContextType 📍1.0.1 THO v7.3
PlanDefinition.useContext:bloodDonationFocus.​value[x] Base example Context of Use ValueSet 📍5.0.0 FHIR Std.
PlanDefinition.useContext:screeningFocus.​code Base extensible UsageContextType 📍1.0.1 THO v7.3
PlanDefinition.useContext:screeningFocus.​value[x] Base example Context of Use ValueSet 📍5.0.0 FHIR Std.
PlanDefinition.useContext:jurisdiction.​code Base extensible UsageContextType 📍1.0.1 THO v7.3
PlanDefinition.useContext:jurisdiction.​value[x] Base required Uzbekistan Jurisdictions 📍0.10.0 This IG
PlanDefinition.jurisdiction Base extensible Jurisdiction ValueSet 📍5.0.0 FHIR Std.
PlanDefinition.topic Base example Definition Topic 📍5.0.0 FHIR Std.
PlanDefinition.goal.​category Base example Goal Category 📍5.0.0 FHIR Std.
PlanDefinition.goal.​description Base example SNOMED CT Clinical Findings 📍5.0.0 FHIR Std.
PlanDefinition.goal.​priority Base preferred Goal Priority 📍5.0.0 FHIR Std.
PlanDefinition.goal.​start Base example Goal Start Event 📍5.0.0 FHIR Std.
PlanDefinition.goal.​addresses Base example Condition/Problem/Diagnosis Codes 📍5.0.0 FHIR Std.
PlanDefinition.goal.​target.measure Base example LOINC Codes 📍5.0.0 FHIR Std.
PlanDefinition.actor.​option.type Base required Action Participant Type 📍5.0.0 FHIR Std.
PlanDefinition.actor.​option.role Base example Action Participant Role 📍2.0.0 THO v7.3
PlanDefinition.action.​priority Base required RequestPriority 📍5.0.0 FHIR Std.
PlanDefinition.action.​code Base example Action code translations 📍0.10.0 This IG
PlanDefinition.action.​reason Base example Action Reason Code 📍5.0.0 FHIR Std.
PlanDefinition.action.​subject[x] Base extensible Participant Resource Types 📍5.0.0 FHIR Std.
PlanDefinition.action.​condition.kind Base required Action condition translations 📍0.10.0 This IG
PlanDefinition.action.​relatedAction.relationship Base required Types of action relationship 📍0.10.0 This IG
PlanDefinition.action.​relatedAction.endRelationship Base required Action Relationship Type 📍5.0.0 FHIR Std.
PlanDefinition.action.​participant.type Base required Participant resource types translations 📍0.10.0 This IG
PlanDefinition.action.​participant.role Base example Action Participant Role 📍2.0.0 THO v7.3
PlanDefinition.action.​participant.function Base example Action Participant Function 📍5.0.0 FHIR Std.
PlanDefinition.action.​type Base extensible Action Type 📍5.0.0 FHIR Std.
PlanDefinition.action.​groupingBehavior Base required Action Grouping Behavior 📍5.0.0 FHIR Std.
PlanDefinition.action.​selectionBehavior Base required Action Selection Behavior 📍5.0.0 FHIR Std.
PlanDefinition.action.​requiredBehavior Base required Action Required Behavior 📍5.0.0 FHIR Std.
PlanDefinition.action.​precheckBehavior Base required Action Precheck Behavior 📍5.0.0 FHIR Std.
PlanDefinition.action.​cardinalityBehavior Base required Action Cardinality Behavior 📍5.0.0 FHIR Std.
PlanDefinition.asNeeded[x] Base example SNOMED CT Medication As Needed Reason Codes 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
uzcore-plandef-1 error PlanDefinition A schedule must declare exactly one focus useContext, so clients can tell what kind of schedule it is useContext.where(code.system = 'http://terminology.hl7.org/CodeSystem/usage-context-type' and code.code = 'focus').count() = 1
uzcore-plandef-2 error PlanDefinition A schedule is either national or regional: a jurisdiction of Uzbekistan as a whole cannot be combined with individual regions useContext.where(code.system = 'http://terminology.hl7.org/CodeSystem/usage-context-type' and code.code = 'jurisdiction' and value.ofType(CodeableConcept).coding.where(system = 'urn:iso:std:iso:3166' and code = 'UZ').exists()).exists() implies useContext.where(code.system = 'http://terminology.hl7.org/CodeSystem/usage-context-type' and code.code = 'jurisdiction').count() = 1

Summary

Mandatory: 4 elements(12 nested mandatory elements)
Must-Support: 44 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of PlanDefinition.subject[x]
  • The element 1 is sliced based on the value of PlanDefinition.useContext
  • The element 1 is sliced based on the value of PlanDefinition.action.relatedAction.offset[x]
  • The element 1 is sliced based on the value of PlanDefinition.action.timing[x]

 

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 token system from its value and must be URL-encoded as %7C. These interactions use standard FHIR R5 search parameters; see the CapabilityStatement as it is finalized for this resource.

Read a schedule by server id

GET [base]/PlanDefinition/[id]

Useful searches

# the active national schedule
GET [base]/PlanDefinition?status=active

# by machine name, title, or version
GET [base]/PlanDefinition?name=NationalImmunizationSchedule
GET [base]/PlanDefinition?title=National%20Immunization%20Schedule
GET [base]/PlanDefinition?version=1.0.0

# by publication date or use-context value
GET [base]/PlanDefinition?date=ge2026-01-01

# national schedules, or the schedules for one region (here Samarqand)
GET [base]/PlanDefinition?context-type-value=jurisdiction$urn:iso:std:iso:3166%7CUZ
GET [base]/PlanDefinition?context-type-value=jurisdiction$https://terminology.dhp.uz/fhir/core/CodeSystem/states-cs%7C1718
GET [base]/PlanDefinition?context-type-value=focus$http://snomed.info/sct%7C14189004

Create a schedule

POST [base]/PlanDefinition
{
  "resourceType": "PlanDefinition",
  "meta": { "profile": [ "https://dhp.uz/fhir/core/StructureDefinition/uz-core-plan-definition" ] },
  ...
}

Before activating, confirm the schedule passes validation (no dose-sequence gaps, no impossible timing windows) and that no other version is already active for the same scope.

Update a schedule (e.g. publish a new version or retire an old one)

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