Uzbekistan Digital Health Platform
0.11.1 - ci-build Uzbekistan flag

Uzbekistan Digital Health Platform, published by Ministry of Health of the Republic of Uzbekistan. This guide is not an authorized publication; it is the continuous build for version 0.11.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/uzinfocom-org/digital-health-ig/ and changes regularly. See the Directory of published versions

Resource Profile: UZ Core PlanDefinition ( Experimental )

Official URL: https://dhp.uz/fhir/core/StructureDefinition/uz-core-plan-definition Version: 0.11.1
Draft as of 2026-10-26 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: doco
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
PlanDefinition.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
PlanDefinition.contained 0..* Resource Contained, inline Resources
PlanDefinition.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.Slices for extension.extension:statusHistory This element must be supported. 0..* (Complex) History of PlanDefinition status changes
URL: https://dhp.uz/fhir/core/StructureDefinition/plan-definition-status-history
Constraints: ext-1
PlanDefinition.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
PlanDefinition.url This element must be supported. This element is included in summaries. C 1..1 uri Canonical identifier for this PlanDefinition
Constraints: cnl-1
PlanDefinition.identifier This element must be supported. This element is included in summaries. 0..* Identifier Additional identifier for the plan definition
PlanDefinition.version This element must be supported. This element is included in summaries. 0..1 string Business version of the plan definition
PlanDefinition.versionAlgorithm[x] This element must be supported. This element is included in summaries. 0..1 How to compare versions
Binding: VersionAlgorithmVS (0.11.1) (extensible)
PlanDefinition.versionAlgorithm[x].versionAlgorithmString string
PlanDefinition.versionAlgorithm[x].versionAlgorithmCoding Coding
PlanDefinition.name This element must be supported. This element is included in summaries. C 1..1 string Machine-processable name for this PlanDefinition
PlanDefinition.title This element must be supported. This element is included in summaries. 0..1 string Plan definition title (in Uzbek language)
PlanDefinition.title.Slices for extension 0..* Extension Plan definition title (in Russian and Karakalpak languages)
Slice: Unordered, Open by value:url
Constraints: ext-1

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.title.Slices for extension.extension:translation This element must be supported. 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
Constraints: ext-1
PlanDefinition.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatusVS (0.11.1) (required)
PlanDefinition.Slices for subject[x] This element must be supported. 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.).
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.Slices for subject[x].subjectCodeableConcept CodeableConcept
PlanDefinition.Slices for subject[x].subjectReference Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition)
PlanDefinition.Slices for subject[x].subject[x]:subjectCodeableConcept This element must be supported. 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.).
PlanDefinition.Slices for subject[x].subject[x]:subjectReference This element must be supported. 0..1 Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition) Type of individual the plan definition is focused on
PlanDefinition.date This element must be supported. This element is included in summaries. 0..1 dateTime Date last changed
PlanDefinition.publisher This element must be supported. This element is included in summaries. 0..1 string Name of the publisher/steward (organization or individual)
PlanDefinition.description This element must be supported. This element is included in summaries. 1..1 markdown Natural language description of the plan definition
PlanDefinition.Slices for useContext This element must be supported. This element is included in summaries. 1..* UsageContext The context that the content is intended to support
Slice: Unordered, Open by value:value

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.Slices for useContext.useContext:immunizationFocus This element must be supported. This element is included in summaries. 0..1 UsageContext Marks this PlanDefinition as an immunization schedule
PlanDefinition.Slices for useContext.useContext:immunizationFocus.code This element is included in summaries. 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:
{
  "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
  "code" : "focus"
}
PlanDefinition.Slices for useContext.useContext:immunizationFocus.value[x] This element is included in summaries. 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:
{
  "coding" : [
    {
      "system" : "http://snomed.info/sct",
      "code" : "33879002"
    }
  ]
}
PlanDefinition.Slices for useContext.useContext:immunizationFocus.value[x].coding This element is included in summaries. 1..1 Coding Code defined by a terminology system
PlanDefinition.Slices for useContext.useContext:immunizationFocus.value[x].coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
PlanDefinition.Slices for useContext.useContext:immunizationFocus.value[x].coding.code This element is included in summaries. C 1..1 code Symbol in syntax defined by the system
PlanDefinition.Slices for useContext.useContext:scheduleCategory This element must be supported. This element is included in summaries. 0..1 UsageContext Kind of immunization schedule
PlanDefinition.Slices for useContext.useContext:scheduleCategory.code This element is included in summaries. 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:
{
  "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
  "code" : "topic"
}
PlanDefinition.Slices for useContext.useContext:scheduleCategory.value[x] This element is included in summaries. 1..1 CodeableConcept Value that defines the context
Binding: ImmunizationScheduleTypeVS (0.11.1) (required)
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus This element must be supported. This element is included in summaries. 0..1 UsageContext Marks this PlanDefinition as a whole blood donation schedule
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.code This element is included in summaries. 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:
{
  "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
  "code" : "focus"
}
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.value[x] This element is included in summaries. 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:
{
  "coding" : [
    {
      "system" : "http://snomed.info/sct",
      "code" : "25179006"
    }
  ]
}
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.value[x].coding This element is included in summaries. 1..1 Coding Code defined by a terminology system
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.value[x].coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.value[x].coding.code This element is included in summaries. C 1..1 code Symbol in syntax defined by the system
PlanDefinition.Slices for useContext.useContext:screeningFocus This element must be supported. This element is included in summaries. 0..1 UsageContext Marks this PlanDefinition as a screening schedule
PlanDefinition.Slices for useContext.useContext:screeningFocus.code This element is included in summaries. 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:
{
  "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
  "code" : "focus"
}
PlanDefinition.Slices for useContext.useContext:screeningFocus.value[x] This element is included in summaries. 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:
{
  "coding" : [
    {
      "system" : "http://snomed.info/sct",
      "code" : "360156006"
    }
  ]
}
PlanDefinition.Slices for useContext.useContext:screeningFocus.value[x].coding This element is included in summaries. 1..1 Coding Code defined by a terminology system
PlanDefinition.Slices for useContext.useContext:screeningFocus.value[x].coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
PlanDefinition.Slices for useContext.useContext:screeningFocus.value[x].coding.code This element is included in summaries. C 1..1 code Symbol in syntax defined by the system
PlanDefinition.Slices for useContext.useContext:jurisdiction This element must be supported. This element is included in summaries. 0..* UsageContext Where the schedule applies: Uzbekistan for a national schedule, or one entry per region for a regional one
PlanDefinition.Slices for useContext.useContext:jurisdiction.code This element is included in summaries. 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:
{
  "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
  "code" : "jurisdiction"
}
PlanDefinition.Slices for useContext.useContext:jurisdiction.value[x] This element is included in summaries. 1..1 CodeableConcept Value that defines the context
Binding: JurisdictionVS (0.11.1) (required)
PlanDefinition.Slices for useContext.useContext:jurisdiction.value[x].coding This element is included in summaries. 1..1 Coding Code defined by a terminology system
PlanDefinition.Slices for useContext.useContext:jurisdiction.value[x].coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
PlanDefinition.Slices for useContext.useContext:jurisdiction.value[x].coding.code This element is included in summaries. C 1..1 code Symbol in syntax defined by the system
PlanDefinition.approvalDate This element must be supported. 0..1 date When the plan definition was approved by publisher
PlanDefinition.effectivePeriod This element must be supported. This element is included in summaries. 0..1 Period When the plan definition is expected to be used
PlanDefinition.action This element must be supported. C 0..* BackboneElement Definition of action included in the plan
PlanDefinition.action.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
PlanDefinition.action.linkId This element must be supported. 0..1 string Unique id for the action in the PlanDefinition
PlanDefinition.action.title This element must be supported. 0..1 string User-visible title
PlanDefinition.action.description This element must be supported. 0..1 markdown Brief description of the action
PlanDefinition.action.code This element must be supported. 0..1 CodeableConcept Code representing the meaning of the action or sub-actions
Binding: ActionCodeVS (0.11.1) (example)
PlanDefinition.action.condition This element must be supported. 0..* BackboneElement Whether or not the action is applicable
PlanDefinition.action.condition.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
PlanDefinition.action.condition.kind This element must be supported. 1..1 code applicability | start | stop
Binding: ActionConditionVS (0.11.1) (required)
PlanDefinition.action.condition.expression This element must be supported. 0..1 Expression Boolean-valued expression
PlanDefinition.action.relatedAction This element must be supported. C 0..* BackboneElement Relationship to another action
PlanDefinition.action.relatedAction.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
PlanDefinition.action.relatedAction.targetId This element must be supported. C 1..1 id Identifier of related action
PlanDefinition.action.relatedAction.relationship This element must be supported. 1..1 code before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
Binding: ActionRelationshipTypeVS (0.11.1) (required)
PlanDefinition.action.relatedAction.Slices for offset[x] This element must be supported. 0..1 Time offset for the relationship
Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.action.relatedAction.Slices for offset[x].offsetDuration Duration
PlanDefinition.action.relatedAction.Slices for offset[x].offsetRange Range
PlanDefinition.action.relatedAction.Slices for offset[x].offset[x]:offsetDuration This element must be supported. 0..1 Duration Time offset for the relationship
PlanDefinition.action.relatedAction.Slices for offset[x].offset[x]:offsetRange This element must be supported. 0..1 Range Time offset for the relationship
PlanDefinition.action.Slices for timing[x] This element must be supported. 0..1 When the action should take place
Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.action.Slices for timing[x].timingAge Age
PlanDefinition.action.Slices for timing[x].timingTiming Timing
PlanDefinition.action.Slices for timing[x].timing[x]:timingAge This element must be supported. 0..1 Age When the action should take place
PlanDefinition.action.Slices for timing[x].timing[x]:timingTiming This element must be supported. 0..1 Timing When the action should take place
PlanDefinition.action.participant This element must be supported. 0..* BackboneElement Who should participate in the action
PlanDefinition.action.participant.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
PlanDefinition.action.participant.actorId This element must be supported. 0..1 string What actor
PlanDefinition.action.participant.type This element must be supported. 0..1 code careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Binding: ParticipantResourceTypesVS (0.11.1) (required)
PlanDefinition.action.definition[x] This element must be supported. 0..1 Description of the activity to be performed
PlanDefinition.action.definition[x].definitionCanonical canonical(ActivityDefinition | MessageDefinition | ObservationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition)
PlanDefinition.action.definition[x].definitionUri uri

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PlanDefinition.versionAlgorithm[x] Base extensible Version algorithm types 📍0.11.1 This IG
PlanDefinition.status Base required Publication Status VS 📍0.11.1 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.11.1 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.11.1 This IG
PlanDefinition.action.​code Base example Action code translations 📍0.11.1 This IG
PlanDefinition.action.​condition.kind Base required Action condition translations 📍0.11.1 This IG
PlanDefinition.action.​relatedAction.relationship Base required Types of action relationship 📍0.11.1 This IG
PlanDefinition.action.​participant.type Base required Participant resource types translations 📍0.11.1 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

This structure is derived from PlanDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: doco
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
PlanDefinition.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.Slices for extension.extension:statusHistory This element must be supported. 0..* (Complex) History of PlanDefinition status changes
URL: https://dhp.uz/fhir/core/StructureDefinition/plan-definition-status-history
PlanDefinition.url This element must be supported. 1..1 uri Canonical identifier for this PlanDefinition
PlanDefinition.identifier This element must be supported. 0..* Identifier Additional identifier for the plan definition
PlanDefinition.versionAlgorithm[x] This element must be supported. 0..1 string, Coding How to compare versions
Binding: VersionAlgorithmVS (0.11.1) (extensible)
PlanDefinition.name This element must be supported. 1..1 string Machine-processable name for this PlanDefinition
PlanDefinition.title This element must be supported. 0..1 string Plan definition title (in Uzbek language)
PlanDefinition.title.Slices for extension 0..* Extension Plan definition title (in Russian and Karakalpak languages)
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.title.Slices for extension.extension:translation This element must be supported. 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
PlanDefinition.status This element must be supported. 1..1 code draft | active | retired | unknown
Binding: PublicationStatusVS (0.11.1) (required)
PlanDefinition.Slices for subject[x] This element must be supported. 0..1 Type of individual the plan definition is focused on
Slice: Unordered, Open by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.Slices for subject[x].subjectCodeableConcept CodeableConcept
PlanDefinition.Slices for subject[x].subjectReference Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition)
PlanDefinition.Slices for subject[x].subject[x]:subjectCodeableConcept This element must be supported. 0..1 CodeableConcept Type of individual the plan definition is focused on
PlanDefinition.Slices for subject[x].subject[x]:subjectReference This element must be supported. 0..1 Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition) Type of individual the plan definition is focused on
PlanDefinition.date This element must be supported. 0..1 dateTime Date last changed
PlanDefinition.publisher This element must be supported. 0..1 string Name of the publisher/steward (organization or individual)
PlanDefinition.description This element must be supported. 1..1 markdown Natural language description of the plan definition
PlanDefinition.Slices for useContext This element must be supported. 1..* UsageContext The context that the content is intended to support
Slice: Unordered, Open by value:value
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.Slices for useContext.useContext:immunizationFocus This element must be supported. 0..1 UsageContext Marks this PlanDefinition as an immunization schedule
PlanDefinition.Slices for useContext.useContext:immunizationFocus.code 1..1 Coding Type of context being specified
Required Pattern:
{
  "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
  "code" : "focus"
}
PlanDefinition.Slices for useContext.useContext:immunizationFocus.value[x] 1..1 CodeableConcept Value that defines the context
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://snomed.info/sct",
      "code" : "33879002"
    }
  ]
}
PlanDefinition.Slices for useContext.useContext:immunizationFocus.value[x].coding 1..1 Coding Code defined by a terminology system
PlanDefinition.Slices for useContext.useContext:immunizationFocus.value[x].coding.system 1..1 uri Identity of the terminology system
PlanDefinition.Slices for useContext.useContext:immunizationFocus.value[x].coding.code 1..1 code Symbol in syntax defined by the system
PlanDefinition.Slices for useContext.useContext:scheduleCategory This element must be supported. 0..1 UsageContext Kind of immunization schedule
PlanDefinition.Slices for useContext.useContext:scheduleCategory.code 1..1 Coding Type of context being specified
Required Pattern:
{
  "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
  "code" : "topic"
}
PlanDefinition.Slices for useContext.useContext:scheduleCategory.value[x] 1..1 CodeableConcept Value that defines the context
Binding: ImmunizationScheduleTypeVS (0.11.1) (required)
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus This element must be supported. 0..1 UsageContext Marks this PlanDefinition as a whole blood donation schedule
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.code 1..1 Coding Type of context being specified
Required Pattern:
{
  "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
  "code" : "focus"
}
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.value[x] 1..1 CodeableConcept Value that defines the context
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://snomed.info/sct",
      "code" : "25179006"
    }
  ]
}
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.value[x].coding 1..1 Coding Code defined by a terminology system
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.value[x].coding.system 1..1 uri Identity of the terminology system
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.value[x].coding.code 1..1 code Symbol in syntax defined by the system
PlanDefinition.Slices for useContext.useContext:screeningFocus This element must be supported. 0..1 UsageContext Marks this PlanDefinition as a screening schedule
PlanDefinition.Slices for useContext.useContext:screeningFocus.code 1..1 Coding Type of context being specified
Required Pattern:
{
  "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
  "code" : "focus"
}
PlanDefinition.Slices for useContext.useContext:screeningFocus.value[x] 1..1 CodeableConcept Value that defines the context
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://snomed.info/sct",
      "code" : "360156006"
    }
  ]
}
PlanDefinition.Slices for useContext.useContext:screeningFocus.value[x].coding 1..1 Coding Code defined by a terminology system
PlanDefinition.Slices for useContext.useContext:screeningFocus.value[x].coding.system 1..1 uri Identity of the terminology system
PlanDefinition.Slices for useContext.useContext:screeningFocus.value[x].coding.code 1..1 code Symbol in syntax defined by the system
PlanDefinition.Slices for useContext.useContext:jurisdiction This element must be supported. 0..* UsageContext Where the schedule applies: Uzbekistan for a national schedule, or one entry per region for a regional one
PlanDefinition.Slices for useContext.useContext:jurisdiction.code 1..1 Coding Type of context being specified
Required Pattern:
{
  "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
  "code" : "jurisdiction"
}
PlanDefinition.Slices for useContext.useContext:jurisdiction.value[x] 1..1 CodeableConcept Value that defines the context
Binding: JurisdictionVS (0.11.1) (required)
PlanDefinition.Slices for useContext.useContext:jurisdiction.value[x].coding 1..1 Coding Code defined by a terminology system
PlanDefinition.Slices for useContext.useContext:jurisdiction.value[x].coding.system 1..1 uri Identity of the terminology system
PlanDefinition.Slices for useContext.useContext:jurisdiction.value[x].coding.code 1..1 code Symbol in syntax defined by the system
PlanDefinition.approvalDate This element must be supported. 0..1 date When the plan definition was approved by publisher
PlanDefinition.effectivePeriod This element must be supported. 0..1 Period When the plan definition is expected to be used
PlanDefinition.action This element must be supported. 0..* BackboneElement Definition of action included in the plan
PlanDefinition.action.linkId This element must be supported. 0..1 string Unique id for the action in the PlanDefinition
PlanDefinition.action.title This element must be supported. 0..1 string User-visible title
PlanDefinition.action.description This element must be supported. 0..1 markdown Brief description of the action
PlanDefinition.action.code This element must be supported. 0..1 CodeableConcept Code representing the meaning of the action or sub-actions
Binding: ActionCodeVS (0.11.1) (example)
PlanDefinition.action.condition This element must be supported. 0..* BackboneElement Whether or not the action is applicable
PlanDefinition.action.condition.kind This element must be supported. 1..1 code applicability | start | stop
Binding: ActionConditionVS (0.11.1) (required)
PlanDefinition.action.condition.expression This element must be supported. 0..1 Expression Boolean-valued expression
PlanDefinition.action.relatedAction This element must be supported. 0..* BackboneElement Relationship to another action
PlanDefinition.action.relatedAction.targetId This element must be supported. 1..1 id Identifier of related action
PlanDefinition.action.relatedAction.relationship This element must be supported. 1..1 code before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
Binding: ActionRelationshipTypeVS (0.11.1) (required)
PlanDefinition.action.relatedAction.Slices for offset[x] This element must be supported. 0..1 Duration, Range Time offset for the relationship
Slice: Unordered, Open by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.action.relatedAction.Slices for offset[x].offset[x]:offsetDuration This element must be supported. 0..1 Duration Time offset for the relationship
PlanDefinition.action.relatedAction.Slices for offset[x].offset[x]:offsetRange This element must be supported. 0..1 Range Time offset for the relationship
PlanDefinition.action.Slices for timing[x] This element must be supported. 0..1 When the action should take place
Slice: Unordered, Open by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.action.Slices for timing[x].timingAge Age
PlanDefinition.action.Slices for timing[x].timingTiming Timing
PlanDefinition.action.Slices for timing[x].timing[x]:timingAge This element must be supported. 0..1 Age When the action should take place
PlanDefinition.action.Slices for timing[x].timing[x]:timingTiming This element must be supported. 0..1 Timing When the action should take place
PlanDefinition.action.participant This element must be supported. 0..* BackboneElement Who should participate in the action
PlanDefinition.action.participant.actorId This element must be supported. 0..1 string What actor
PlanDefinition.action.participant.type This element must be supported. 0..1 code careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Binding: ParticipantResourceTypesVS (0.11.1) (required)
PlanDefinition.action.definition[x] This element must be supported. 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.11.1 This IG
PlanDefinition.status Base required Publication Status VS 📍0.11.1 This IG
PlanDefinition.useContext:scheduleCategory.​value[x] Base required UZ Core Immunization Schedule Type Value Set 📍0.11.1 This IG
PlanDefinition.useContext:jurisdiction.​value[x] Base required Uzbekistan Jurisdictions 📍0.11.1 This IG
PlanDefinition.action.​code Base example Action code translations 📍0.11.1 This IG
PlanDefinition.action.​condition.kind Base required Action condition translations 📍0.11.1 This IG
PlanDefinition.action.​relatedAction.relationship Base required Types of action relationship 📍0.11.1 This IG
PlanDefinition.action.​participant.type Base required Participant resource types translations 📍0.11.1 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: doco
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
PlanDefinition.id This element is included in summaries. 0..1 id Logical id of this artifact
PlanDefinition.meta This element is included in summaries. 0..1 Meta Metadata about the resource
PlanDefinition.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
PlanDefinition.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
PlanDefinition.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
PlanDefinition.contained 0..* Resource Contained, inline Resources
PlanDefinition.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.Slices for extension.extension:statusHistory This element must be supported. 0..* (Complex) History of PlanDefinition status changes
URL: https://dhp.uz/fhir/core/StructureDefinition/plan-definition-status-history
Constraints: ext-1
PlanDefinition.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
PlanDefinition.url This element must be supported. This element is included in summaries. C 1..1 uri Canonical identifier for this PlanDefinition
Constraints: cnl-1
PlanDefinition.identifier This element must be supported. This element is included in summaries. 0..* Identifier Additional identifier for the plan definition
PlanDefinition.version This element must be supported. This element is included in summaries. 0..1 string Business version of the plan definition
PlanDefinition.versionAlgorithm[x] This element must be supported. This element is included in summaries. 0..1 How to compare versions
Binding: VersionAlgorithmVS (0.11.1) (extensible)
PlanDefinition.versionAlgorithm[x].versionAlgorithmString string
PlanDefinition.versionAlgorithm[x].versionAlgorithmCoding Coding
PlanDefinition.name This element must be supported. This element is included in summaries. C 1..1 string Machine-processable name for this PlanDefinition
PlanDefinition.title This element must be supported. This element is included in summaries. 0..1 string Plan definition title (in Uzbek language)
PlanDefinition.title.id 0..1 string xml:id (or equivalent in JSON)
PlanDefinition.title.Slices for extension 0..* Extension Plan definition title (in Russian and Karakalpak languages)
Slice: Unordered, Open by value:url
Constraints: ext-1

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.title.Slices for extension.extension:translation This element must be supported. 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
Constraints: ext-1
PlanDefinition.title.value 0..1 string Primitive value for string
Max Length:1048576
PlanDefinition.subtitle 0..1 string Subordinate title of the plan definition
PlanDefinition.type This element is included in summaries. 0..1 CodeableConcept order-set | clinical-protocol | eca-rule | workflow-definition
Binding: PlanDefinitionType (extensible): The type of PlanDefinition.
PlanDefinition.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatusVS (0.11.1) (required)
PlanDefinition.experimental This element is included in summaries. 0..1 boolean For testing purposes, not real usage
PlanDefinition.Slices for subject[x] This element must be supported. 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.).
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.Slices for subject[x].subjectCodeableConcept CodeableConcept
PlanDefinition.Slices for subject[x].subjectReference Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition)
PlanDefinition.Slices for subject[x].subject[x]:subjectCodeableConcept This element must be supported. 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.).
PlanDefinition.Slices for subject[x].subject[x]:subjectReference This element must be supported. 0..1 Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition) Type of individual the plan definition is focused on
PlanDefinition.date This element must be supported. This element is included in summaries. 0..1 dateTime Date last changed
PlanDefinition.publisher This element must be supported. This element is included in summaries. 0..1 string Name of the publisher/steward (organization or individual)
PlanDefinition.contact This element is included in summaries. 0..* ContactDetail Contact details for the publisher
PlanDefinition.description This element must be supported. This element is included in summaries. 1..1 markdown Natural language description of the plan definition
PlanDefinition.Slices for useContext This element must be supported. This element is included in summaries. 1..* UsageContext The context that the content is intended to support
Slice: Unordered, Open by value:value

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.Slices for useContext.useContext:immunizationFocus This element must be supported. This element is included in summaries. 0..1 UsageContext Marks this PlanDefinition as an immunization schedule
PlanDefinition.Slices for useContext.useContext:immunizationFocus.id 0..1 id Unique id for inter-element referencing
PlanDefinition.Slices for useContext.useContext:immunizationFocus.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
PlanDefinition.Slices for useContext.useContext:immunizationFocus.code This element is included in summaries. 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:
{
  "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
  "code" : "focus"
}
PlanDefinition.Slices for useContext.useContext:immunizationFocus.value[x] This element is included in summaries. 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:
{
  "coding" : [
    {
      "system" : "http://snomed.info/sct",
      "code" : "33879002"
    }
  ]
}
PlanDefinition.Slices for useContext.useContext:immunizationFocus.value[x].id 0..1 id Unique id for inter-element referencing
PlanDefinition.Slices for useContext.useContext:immunizationFocus.value[x].extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
PlanDefinition.Slices for useContext.useContext:immunizationFocus.value[x].coding This element is included in summaries. 1..1 Coding Code defined by a terminology system
PlanDefinition.Slices for useContext.useContext:immunizationFocus.value[x].coding.id 0..1 id Unique id for inter-element referencing
PlanDefinition.Slices for useContext.useContext:immunizationFocus.value[x].coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
PlanDefinition.Slices for useContext.useContext:immunizationFocus.value[x].coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
PlanDefinition.Slices for useContext.useContext:immunizationFocus.value[x].coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
PlanDefinition.Slices for useContext.useContext:immunizationFocus.value[x].coding.code This element is included in summaries. C 1..1 code Symbol in syntax defined by the system
PlanDefinition.Slices for useContext.useContext:immunizationFocus.value[x].coding.display This element is included in summaries. C 0..1 string Representation defined by the system
PlanDefinition.Slices for useContext.useContext:immunizationFocus.value[x].coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
PlanDefinition.Slices for useContext.useContext:immunizationFocus.value[x].text This element is included in summaries. 0..1 string Plain text representation of the concept
PlanDefinition.Slices for useContext.useContext:scheduleCategory This element must be supported. This element is included in summaries. 0..1 UsageContext Kind of immunization schedule
PlanDefinition.Slices for useContext.useContext:scheduleCategory.id 0..1 id Unique id for inter-element referencing
PlanDefinition.Slices for useContext.useContext:scheduleCategory.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
PlanDefinition.Slices for useContext.useContext:scheduleCategory.code This element is included in summaries. 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:
{
  "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
  "code" : "topic"
}
PlanDefinition.Slices for useContext.useContext:scheduleCategory.value[x] This element is included in summaries. 1..1 CodeableConcept Value that defines the context
Binding: ImmunizationScheduleTypeVS (0.11.1) (required)
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus This element must be supported. This element is included in summaries. 0..1 UsageContext Marks this PlanDefinition as a whole blood donation schedule
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.id 0..1 id Unique id for inter-element referencing
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.code This element is included in summaries. 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:
{
  "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
  "code" : "focus"
}
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.value[x] This element is included in summaries. 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:
{
  "coding" : [
    {
      "system" : "http://snomed.info/sct",
      "code" : "25179006"
    }
  ]
}
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.value[x].id 0..1 id Unique id for inter-element referencing
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.value[x].extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.value[x].coding This element is included in summaries. 1..1 Coding Code defined by a terminology system
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.value[x].coding.id 0..1 id Unique id for inter-element referencing
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.value[x].coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.value[x].coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.value[x].coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.value[x].coding.code This element is included in summaries. C 1..1 code Symbol in syntax defined by the system
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.value[x].coding.display This element is included in summaries. C 0..1 string Representation defined by the system
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.value[x].coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.value[x].text This element is included in summaries. 0..1 string Plain text representation of the concept
PlanDefinition.Slices for useContext.useContext:screeningFocus This element must be supported. This element is included in summaries. 0..1 UsageContext Marks this PlanDefinition as a screening schedule
PlanDefinition.Slices for useContext.useContext:screeningFocus.id 0..1 id Unique id for inter-element referencing
PlanDefinition.Slices for useContext.useContext:screeningFocus.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
PlanDefinition.Slices for useContext.useContext:screeningFocus.code This element is included in summaries. 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:
{
  "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
  "code" : "focus"
}
PlanDefinition.Slices for useContext.useContext:screeningFocus.value[x] This element is included in summaries. 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:
{
  "coding" : [
    {
      "system" : "http://snomed.info/sct",
      "code" : "360156006"
    }
  ]
}
PlanDefinition.Slices for useContext.useContext:screeningFocus.value[x].id 0..1 id Unique id for inter-element referencing
PlanDefinition.Slices for useContext.useContext:screeningFocus.value[x].extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
PlanDefinition.Slices for useContext.useContext:screeningFocus.value[x].coding This element is included in summaries. 1..1 Coding Code defined by a terminology system
PlanDefinition.Slices for useContext.useContext:screeningFocus.value[x].coding.id 0..1 id Unique id for inter-element referencing
PlanDefinition.Slices for useContext.useContext:screeningFocus.value[x].coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
PlanDefinition.Slices for useContext.useContext:screeningFocus.value[x].coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
PlanDefinition.Slices for useContext.useContext:screeningFocus.value[x].coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
PlanDefinition.Slices for useContext.useContext:screeningFocus.value[x].coding.code This element is included in summaries. C 1..1 code Symbol in syntax defined by the system
PlanDefinition.Slices for useContext.useContext:screeningFocus.value[x].coding.display This element is included in summaries. C 0..1 string Representation defined by the system
PlanDefinition.Slices for useContext.useContext:screeningFocus.value[x].coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
PlanDefinition.Slices for useContext.useContext:screeningFocus.value[x].text This element is included in summaries. 0..1 string Plain text representation of the concept
PlanDefinition.Slices for useContext.useContext:jurisdiction This element must be supported. This element is included in summaries. 0..* UsageContext Where the schedule applies: Uzbekistan for a national schedule, or one entry per region for a regional one
PlanDefinition.Slices for useContext.useContext:jurisdiction.id 0..1 id Unique id for inter-element referencing
PlanDefinition.Slices for useContext.useContext:jurisdiction.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
PlanDefinition.Slices for useContext.useContext:jurisdiction.code This element is included in summaries. 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:
{
  "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
  "code" : "jurisdiction"
}
PlanDefinition.Slices for useContext.useContext:jurisdiction.value[x] This element is included in summaries. 1..1 CodeableConcept Value that defines the context
Binding: JurisdictionVS (0.11.1) (required)
PlanDefinition.Slices for useContext.useContext:jurisdiction.value[x].id 0..1 id Unique id for inter-element referencing
PlanDefinition.Slices for useContext.useContext:jurisdiction.value[x].extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
PlanDefinition.Slices for useContext.useContext:jurisdiction.value[x].coding This element is included in summaries. 1..1 Coding Code defined by a terminology system
PlanDefinition.Slices for useContext.useContext:jurisdiction.value[x].coding.id 0..1 id Unique id for inter-element referencing
PlanDefinition.Slices for useContext.useContext:jurisdiction.value[x].coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
PlanDefinition.Slices for useContext.useContext:jurisdiction.value[x].coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
PlanDefinition.Slices for useContext.useContext:jurisdiction.value[x].coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
PlanDefinition.Slices for useContext.useContext:jurisdiction.value[x].coding.code This element is included in summaries. C 1..1 code Symbol in syntax defined by the system
PlanDefinition.Slices for useContext.useContext:jurisdiction.value[x].coding.display This element is included in summaries. C 0..1 string Representation defined by the system
PlanDefinition.Slices for useContext.useContext:jurisdiction.value[x].coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
PlanDefinition.Slices for useContext.useContext:jurisdiction.value[x].text This element is included in summaries. 0..1 string Plain text representation of the concept
PlanDefinition.jurisdiction This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for plan definition (if applicable)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.
PlanDefinition.purpose 0..1 markdown Why this plan definition is defined
PlanDefinition.usage 0..1 markdown Describes the clinical usage of the plan
PlanDefinition.copyright 0..1 markdown Use and/or publishing restrictions
PlanDefinition.copyrightLabel 0..1 string Copyright holder and year(s)
PlanDefinition.approvalDate This element must be supported. 0..1 date When the plan definition was approved by publisher
PlanDefinition.lastReviewDate 0..1 date When the plan definition was last reviewed by the publisher
PlanDefinition.effectivePeriod This element must be supported. This element is included in summaries. 0..1 Period When the plan definition is expected to be used
PlanDefinition.topic 0..* CodeableConcept E.g. Education, Treatment, Assessment
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
PlanDefinition.author 0..* ContactDetail Who authored the content
PlanDefinition.editor 0..* ContactDetail Who edited the content
PlanDefinition.reviewer 0..* ContactDetail Who reviewed the content
PlanDefinition.endorser 0..* ContactDetail Who endorsed the content
PlanDefinition.relatedArtifact 0..* RelatedArtifact Additional documentation, citations
PlanDefinition.library 0..* canonical(Library) Logic used by the plan definition
PlanDefinition.goal C 0..* BackboneElement What the plan is trying to accomplish
PlanDefinition.goal.id 0..1 string Unique id for inter-element referencing
PlanDefinition.goal.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
PlanDefinition.goal.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
PlanDefinition.goal.category 0..1 CodeableConcept E.g. Treatment, dietary, behavioral
Binding: GoalCategory (example): Example codes for grouping goals for filtering or presentation.
PlanDefinition.goal.description 1..1 CodeableConcept Code or text describing the goal
Binding: SNOMEDCTClinicalFindings (example): Describes goals that can be achieved.
PlanDefinition.goal.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.
PlanDefinition.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.
PlanDefinition.goal.addresses 0..* CodeableConcept What does the goal address
Binding: ConditionProblemDiagnosisCodes (example): Identifies problems, conditions, issues, or concerns that goals may address.
PlanDefinition.goal.documentation 0..* RelatedArtifact Supporting documentation for the goal
PlanDefinition.goal.target 0..* BackboneElement Target outcome for the goal
PlanDefinition.goal.target.id 0..1 string Unique id for inter-element referencing
PlanDefinition.goal.target.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
PlanDefinition.goal.target.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
PlanDefinition.goal.target.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.
PlanDefinition.goal.target.detail[x] 0..1 The target value to be achieved
PlanDefinition.goal.target.detail[x].detailQuantity Quantity
PlanDefinition.goal.target.detail[x].detailRange Range
PlanDefinition.goal.target.detail[x].detailCodeableConcept CodeableConcept
PlanDefinition.goal.target.detail[x].detailString string
PlanDefinition.goal.target.detail[x].detailBoolean boolean
PlanDefinition.goal.target.detail[x].detailInteger integer
PlanDefinition.goal.target.detail[x].detailRatio Ratio
PlanDefinition.goal.target.due 0..1 Duration Reach goal within
PlanDefinition.actor 0..* BackboneElement Actors within the plan
PlanDefinition.actor.id 0..1 string Unique id for inter-element referencing
PlanDefinition.actor.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
PlanDefinition.actor.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
PlanDefinition.actor.title 0..1 string User-visible title
PlanDefinition.actor.description 0..1 markdown Describes the actor
PlanDefinition.actor.option 1..* BackboneElement Who or what can be this actor
PlanDefinition.actor.option.id 0..1 string Unique id for inter-element referencing
PlanDefinition.actor.option.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
PlanDefinition.actor.option.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
PlanDefinition.actor.option.type 0..1 code careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Binding: ActionParticipantType (required): The type of participant in the activity.
PlanDefinition.actor.option.typeCanonical 0..1 canonical(CapabilityStatement) Who or what can participate
PlanDefinition.actor.option.typeReference 0..1 Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) Who or what can participate
PlanDefinition.actor.option.role 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent
Binding: ActionParticipantRole (2.0.0) (example)
PlanDefinition.action This element must be supported. C 0..* BackboneElement Definition of action included in the plan
PlanDefinition.action.id 0..1 string Unique id for inter-element referencing
PlanDefinition.action.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
PlanDefinition.action.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
PlanDefinition.action.linkId This element must be supported. 0..1 string Unique id for the action in the PlanDefinition
PlanDefinition.action.prefix 0..1 string User-visible prefix for the action (e.g. 1. or A.)
PlanDefinition.action.title This element must be supported. 0..1 string User-visible title
PlanDefinition.action.description This element must be supported. 0..1 markdown Brief description of the action
PlanDefinition.action.textEquivalent 0..1 markdown Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
PlanDefinition.action.priority 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
PlanDefinition.action.code This element must be supported. 0..1 CodeableConcept Code representing the meaning of the action or sub-actions
Binding: ActionCodeVS (0.11.1) (example)
PlanDefinition.action.reason 0..* CodeableConcept Why the action should be performed
Binding: ActionReasonCode (example): Provides examples of reasons for actions to be performed.
PlanDefinition.action.documentation 0..* RelatedArtifact Supporting documentation for the intended performer of the action
PlanDefinition.action.goalId C 0..* id What goals this action supports
PlanDefinition.action.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.).
PlanDefinition.action.subject[x].subjectCodeableConcept CodeableConcept
PlanDefinition.action.subject[x].subjectReference Reference(Group)
PlanDefinition.action.subject[x].subjectCanonical canonical(Any)
PlanDefinition.action.trigger 0..* TriggerDefinition When the action should be triggered
PlanDefinition.action.condition This element must be supported. 0..* BackboneElement Whether or not the action is applicable
PlanDefinition.action.condition.id 0..1 string Unique id for inter-element referencing
PlanDefinition.action.condition.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
PlanDefinition.action.condition.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
PlanDefinition.action.condition.kind This element must be supported. 1..1 code applicability | start | stop
Binding: ActionConditionVS (0.11.1) (required)
PlanDefinition.action.condition.expression This element must be supported. 0..1 Expression Boolean-valued expression
PlanDefinition.action.input C 0..* BackboneElement Input data requirements
Constraints: pld-0
PlanDefinition.action.input.id 0..1 string Unique id for inter-element referencing
PlanDefinition.action.input.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
PlanDefinition.action.input.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
PlanDefinition.action.input.title 0..1 string User-visible title
PlanDefinition.action.input.requirement C 0..1 DataRequirement What data is provided
PlanDefinition.action.input.relatedData C 0..1 id What data is provided
PlanDefinition.action.output C 0..* BackboneElement Output data definition
Constraints: pld-1
PlanDefinition.action.output.id 0..1 string Unique id for inter-element referencing
PlanDefinition.action.output.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
PlanDefinition.action.output.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
PlanDefinition.action.output.title 0..1 string User-visible title
PlanDefinition.action.output.requirement C 0..1 DataRequirement What data is provided
PlanDefinition.action.output.relatedData C 0..1 string What data is provided
PlanDefinition.action.relatedAction This element must be supported. C 0..* BackboneElement Relationship to another action
PlanDefinition.action.relatedAction.id 0..1 string Unique id for inter-element referencing
PlanDefinition.action.relatedAction.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
PlanDefinition.action.relatedAction.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
PlanDefinition.action.relatedAction.targetId This element must be supported. C 1..1 id Identifier of related action
PlanDefinition.action.relatedAction.relationship This element must be supported. 1..1 code before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
Binding: ActionRelationshipTypeVS (0.11.1) (required)
PlanDefinition.action.relatedAction.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.
PlanDefinition.action.relatedAction.Slices for offset[x] This element must be supported. 0..1 Time offset for the relationship
Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.action.relatedAction.Slices for offset[x].offsetDuration Duration
PlanDefinition.action.relatedAction.Slices for offset[x].offsetRange Range
PlanDefinition.action.relatedAction.Slices for offset[x].offset[x]:offsetDuration This element must be supported. 0..1 Duration Time offset for the relationship
PlanDefinition.action.relatedAction.Slices for offset[x].offset[x]:offsetRange This element must be supported. 0..1 Range Time offset for the relationship
PlanDefinition.action.Slices for timing[x] This element must be supported. 0..1 When the action should take place
Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.action.Slices for timing[x].timingAge Age
PlanDefinition.action.Slices for timing[x].timingTiming Timing
PlanDefinition.action.Slices for timing[x].timing[x]:timingAge This element must be supported. 0..1 Age When the action should take place
PlanDefinition.action.Slices for timing[x].timing[x]:timingTiming This element must be supported. 0..1 Timing When the action should take place
PlanDefinition.action.location 0..1 CodeableReference(Location) Where it should happen
PlanDefinition.action.participant This element must be supported. 0..* BackboneElement Who should participate in the action
PlanDefinition.action.participant.id 0..1 string Unique id for inter-element referencing
PlanDefinition.action.participant.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
PlanDefinition.action.participant.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
PlanDefinition.action.participant.actorId This element must be supported. 0..1 string What actor
PlanDefinition.action.participant.type This element must be supported. 0..1 code careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Binding: ParticipantResourceTypesVS (0.11.1) (required)
PlanDefinition.action.participant.typeCanonical 0..1 canonical(CapabilityStatement) Who or what can participate
PlanDefinition.action.participant.typeReference 0..1 Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) Who or what can participate
PlanDefinition.action.participant.role 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent
Binding: ActionParticipantRole (2.0.0) (example): Defines roles played by participants for the action.
PlanDefinition.action.participant.function 0..1 CodeableConcept E.g. Author, Reviewer, Witness, etc
Binding: ActionParticipantFunction (example)
PlanDefinition.action.type 0..1 CodeableConcept create | update | remove | fire-event
Binding: ActionType (extensible): The type of action to be performed.
PlanDefinition.action.groupingBehavior 0..1 code visual-group | logical-group | sentence-group
Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.
PlanDefinition.action.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.
PlanDefinition.action.requiredBehavior 0..1 code must | could | must-unless-documented
Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.
PlanDefinition.action.precheckBehavior 0..1 code yes | no
Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.
PlanDefinition.action.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.
PlanDefinition.action.definition[x] This element must be supported. 0..1 Description of the activity to be performed
PlanDefinition.action.definition[x].definitionCanonical canonical(ActivityDefinition | MessageDefinition | ObservationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition)
PlanDefinition.action.definition[x].definitionUri uri
PlanDefinition.action.transform 0..1 canonical(StructureMap) Transform to apply the template
PlanDefinition.action.dynamicValue 0..* BackboneElement Dynamic aspects of the definition
PlanDefinition.action.dynamicValue.id 0..1 string Unique id for inter-element referencing
PlanDefinition.action.dynamicValue.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
PlanDefinition.action.dynamicValue.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
PlanDefinition.action.dynamicValue.path 0..1 string The path to the element to be set dynamically
PlanDefinition.action.dynamicValue.expression 0..1 Expression An expression that provides the dynamic value for the customization
PlanDefinition.action.action 0..* See action (PlanDefinition) A sub-action
PlanDefinition.asNeeded[x] This element is included in summaries. 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.
PlanDefinition.asNeeded[x].asNeededBoolean boolean
PlanDefinition.asNeeded[x].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.11.1 This IG
PlanDefinition.type Base extensible Plan Definition Type 📍5.0.0 FHIR Std.
PlanDefinition.status Base required Publication Status VS 📍0.11.1 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.11.1 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.11.1 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.11.1 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.11.1 This IG
PlanDefinition.action.​relatedAction.relationship Base required Types of action relationship 📍0.11.1 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.11.1 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

This structure is derived from PlanDefinition

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: doco
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
PlanDefinition.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
PlanDefinition.contained 0..* Resource Contained, inline Resources
PlanDefinition.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.Slices for extension.extension:statusHistory This element must be supported. 0..* (Complex) History of PlanDefinition status changes
URL: https://dhp.uz/fhir/core/StructureDefinition/plan-definition-status-history
Constraints: ext-1
PlanDefinition.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
PlanDefinition.url This element must be supported. This element is included in summaries. C 1..1 uri Canonical identifier for this PlanDefinition
Constraints: cnl-1
PlanDefinition.identifier This element must be supported. This element is included in summaries. 0..* Identifier Additional identifier for the plan definition
PlanDefinition.version This element must be supported. This element is included in summaries. 0..1 string Business version of the plan definition
PlanDefinition.versionAlgorithm[x] This element must be supported. This element is included in summaries. 0..1 How to compare versions
Binding: VersionAlgorithmVS (0.11.1) (extensible)
PlanDefinition.versionAlgorithm[x].versionAlgorithmString string
PlanDefinition.versionAlgorithm[x].versionAlgorithmCoding Coding
PlanDefinition.name This element must be supported. This element is included in summaries. C 1..1 string Machine-processable name for this PlanDefinition
PlanDefinition.title This element must be supported. This element is included in summaries. 0..1 string Plan definition title (in Uzbek language)
PlanDefinition.title.Slices for extension 0..* Extension Plan definition title (in Russian and Karakalpak languages)
Slice: Unordered, Open by value:url
Constraints: ext-1

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.title.Slices for extension.extension:translation This element must be supported. 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
Constraints: ext-1
PlanDefinition.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatusVS (0.11.1) (required)
PlanDefinition.Slices for subject[x] This element must be supported. 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.).
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.Slices for subject[x].subjectCodeableConcept CodeableConcept
PlanDefinition.Slices for subject[x].subjectReference Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition)
PlanDefinition.Slices for subject[x].subject[x]:subjectCodeableConcept This element must be supported. 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.).
PlanDefinition.Slices for subject[x].subject[x]:subjectReference This element must be supported. 0..1 Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition) Type of individual the plan definition is focused on
PlanDefinition.date This element must be supported. This element is included in summaries. 0..1 dateTime Date last changed
PlanDefinition.publisher This element must be supported. This element is included in summaries. 0..1 string Name of the publisher/steward (organization or individual)
PlanDefinition.description This element must be supported. This element is included in summaries. 1..1 markdown Natural language description of the plan definition
PlanDefinition.Slices for useContext This element must be supported. This element is included in summaries. 1..* UsageContext The context that the content is intended to support
Slice: Unordered, Open by value:value

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.Slices for useContext.useContext:immunizationFocus This element must be supported. This element is included in summaries. 0..1 UsageContext Marks this PlanDefinition as an immunization schedule
PlanDefinition.Slices for useContext.useContext:immunizationFocus.code This element is included in summaries. 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:
{
  "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
  "code" : "focus"
}
PlanDefinition.Slices for useContext.useContext:immunizationFocus.value[x] This element is included in summaries. 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:
{
  "coding" : [
    {
      "system" : "http://snomed.info/sct",
      "code" : "33879002"
    }
  ]
}
PlanDefinition.Slices for useContext.useContext:immunizationFocus.value[x].coding This element is included in summaries. 1..1 Coding Code defined by a terminology system
PlanDefinition.Slices for useContext.useContext:immunizationFocus.value[x].coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
PlanDefinition.Slices for useContext.useContext:immunizationFocus.value[x].coding.code This element is included in summaries. C 1..1 code Symbol in syntax defined by the system
PlanDefinition.Slices for useContext.useContext:scheduleCategory This element must be supported. This element is included in summaries. 0..1 UsageContext Kind of immunization schedule
PlanDefinition.Slices for useContext.useContext:scheduleCategory.code This element is included in summaries. 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:
{
  "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
  "code" : "topic"
}
PlanDefinition.Slices for useContext.useContext:scheduleCategory.value[x] This element is included in summaries. 1..1 CodeableConcept Value that defines the context
Binding: ImmunizationScheduleTypeVS (0.11.1) (required)
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus This element must be supported. This element is included in summaries. 0..1 UsageContext Marks this PlanDefinition as a whole blood donation schedule
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.code This element is included in summaries. 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:
{
  "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
  "code" : "focus"
}
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.value[x] This element is included in summaries. 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:
{
  "coding" : [
    {
      "system" : "http://snomed.info/sct",
      "code" : "25179006"
    }
  ]
}
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.value[x].coding This element is included in summaries. 1..1 Coding Code defined by a terminology system
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.value[x].coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.value[x].coding.code This element is included in summaries. C 1..1 code Symbol in syntax defined by the system
PlanDefinition.Slices for useContext.useContext:screeningFocus This element must be supported. This element is included in summaries. 0..1 UsageContext Marks this PlanDefinition as a screening schedule
PlanDefinition.Slices for useContext.useContext:screeningFocus.code This element is included in summaries. 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:
{
  "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
  "code" : "focus"
}
PlanDefinition.Slices for useContext.useContext:screeningFocus.value[x] This element is included in summaries. 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:
{
  "coding" : [
    {
      "system" : "http://snomed.info/sct",
      "code" : "360156006"
    }
  ]
}
PlanDefinition.Slices for useContext.useContext:screeningFocus.value[x].coding This element is included in summaries. 1..1 Coding Code defined by a terminology system
PlanDefinition.Slices for useContext.useContext:screeningFocus.value[x].coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
PlanDefinition.Slices for useContext.useContext:screeningFocus.value[x].coding.code This element is included in summaries. C 1..1 code Symbol in syntax defined by the system
PlanDefinition.Slices for useContext.useContext:jurisdiction This element must be supported. This element is included in summaries. 0..* UsageContext Where the schedule applies: Uzbekistan for a national schedule, or one entry per region for a regional one
PlanDefinition.Slices for useContext.useContext:jurisdiction.code This element is included in summaries. 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:
{
  "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
  "code" : "jurisdiction"
}
PlanDefinition.Slices for useContext.useContext:jurisdiction.value[x] This element is included in summaries. 1..1 CodeableConcept Value that defines the context
Binding: JurisdictionVS (0.11.1) (required)
PlanDefinition.Slices for useContext.useContext:jurisdiction.value[x].coding This element is included in summaries. 1..1 Coding Code defined by a terminology system
PlanDefinition.Slices for useContext.useContext:jurisdiction.value[x].coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
PlanDefinition.Slices for useContext.useContext:jurisdiction.value[x].coding.code This element is included in summaries. C 1..1 code Symbol in syntax defined by the system
PlanDefinition.approvalDate This element must be supported. 0..1 date When the plan definition was approved by publisher
PlanDefinition.effectivePeriod This element must be supported. This element is included in summaries. 0..1 Period When the plan definition is expected to be used
PlanDefinition.action This element must be supported. C 0..* BackboneElement Definition of action included in the plan
PlanDefinition.action.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
PlanDefinition.action.linkId This element must be supported. 0..1 string Unique id for the action in the PlanDefinition
PlanDefinition.action.title This element must be supported. 0..1 string User-visible title
PlanDefinition.action.description This element must be supported. 0..1 markdown Brief description of the action
PlanDefinition.action.code This element must be supported. 0..1 CodeableConcept Code representing the meaning of the action or sub-actions
Binding: ActionCodeVS (0.11.1) (example)
PlanDefinition.action.condition This element must be supported. 0..* BackboneElement Whether or not the action is applicable
PlanDefinition.action.condition.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
PlanDefinition.action.condition.kind This element must be supported. 1..1 code applicability | start | stop
Binding: ActionConditionVS (0.11.1) (required)
PlanDefinition.action.condition.expression This element must be supported. 0..1 Expression Boolean-valued expression
PlanDefinition.action.relatedAction This element must be supported. C 0..* BackboneElement Relationship to another action
PlanDefinition.action.relatedAction.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
PlanDefinition.action.relatedAction.targetId This element must be supported. C 1..1 id Identifier of related action
PlanDefinition.action.relatedAction.relationship This element must be supported. 1..1 code before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
Binding: ActionRelationshipTypeVS (0.11.1) (required)
PlanDefinition.action.relatedAction.Slices for offset[x] This element must be supported. 0..1 Time offset for the relationship
Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.action.relatedAction.Slices for offset[x].offsetDuration Duration
PlanDefinition.action.relatedAction.Slices for offset[x].offsetRange Range
PlanDefinition.action.relatedAction.Slices for offset[x].offset[x]:offsetDuration This element must be supported. 0..1 Duration Time offset for the relationship
PlanDefinition.action.relatedAction.Slices for offset[x].offset[x]:offsetRange This element must be supported. 0..1 Range Time offset for the relationship
PlanDefinition.action.Slices for timing[x] This element must be supported. 0..1 When the action should take place
Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.action.Slices for timing[x].timingAge Age
PlanDefinition.action.Slices for timing[x].timingTiming Timing
PlanDefinition.action.Slices for timing[x].timing[x]:timingAge This element must be supported. 0..1 Age When the action should take place
PlanDefinition.action.Slices for timing[x].timing[x]:timingTiming This element must be supported. 0..1 Timing When the action should take place
PlanDefinition.action.participant This element must be supported. 0..* BackboneElement Who should participate in the action
PlanDefinition.action.participant.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
PlanDefinition.action.participant.actorId This element must be supported. 0..1 string What actor
PlanDefinition.action.participant.type This element must be supported. 0..1 code careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Binding: ParticipantResourceTypesVS (0.11.1) (required)
PlanDefinition.action.definition[x] This element must be supported. 0..1 Description of the activity to be performed
PlanDefinition.action.definition[x].definitionCanonical canonical(ActivityDefinition | MessageDefinition | ObservationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition)
PlanDefinition.action.definition[x].definitionUri uri

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PlanDefinition.versionAlgorithm[x] Base extensible Version algorithm types 📍0.11.1 This IG
PlanDefinition.status Base required Publication Status VS 📍0.11.1 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.11.1 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.11.1 This IG
PlanDefinition.action.​code Base example Action code translations 📍0.11.1 This IG
PlanDefinition.action.​condition.kind Base required Action condition translations 📍0.11.1 This IG
PlanDefinition.action.​relatedAction.relationship Base required Types of action relationship 📍0.11.1 This IG
PlanDefinition.action.​participant.type Base required Participant resource types translations 📍0.11.1 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

This structure is derived from PlanDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: doco
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
PlanDefinition.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.Slices for extension.extension:statusHistory This element must be supported. 0..* (Complex) History of PlanDefinition status changes
URL: https://dhp.uz/fhir/core/StructureDefinition/plan-definition-status-history
PlanDefinition.url This element must be supported. 1..1 uri Canonical identifier for this PlanDefinition
PlanDefinition.identifier This element must be supported. 0..* Identifier Additional identifier for the plan definition
PlanDefinition.version This element must be supported. 0..1 string Business version of the plan definition
PlanDefinition.versionAlgorithm[x] This element must be supported. 0..1 string, Coding How to compare versions
Binding: VersionAlgorithmVS (0.11.1) (extensible)
PlanDefinition.name This element must be supported. 1..1 string Machine-processable name for this PlanDefinition
PlanDefinition.title This element must be supported. 0..1 string Plan definition title (in Uzbek language)
PlanDefinition.title.Slices for extension 0..* Extension Plan definition title (in Russian and Karakalpak languages)
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.title.Slices for extension.extension:translation This element must be supported. 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
PlanDefinition.status This element must be supported. 1..1 code draft | active | retired | unknown
Binding: PublicationStatusVS (0.11.1) (required)
PlanDefinition.Slices for subject[x] This element must be supported. 0..1 Type of individual the plan definition is focused on
Slice: Unordered, Open by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.Slices for subject[x].subjectCodeableConcept CodeableConcept
PlanDefinition.Slices for subject[x].subjectReference Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition)
PlanDefinition.Slices for subject[x].subject[x]:subjectCodeableConcept This element must be supported. 0..1 CodeableConcept Type of individual the plan definition is focused on
PlanDefinition.Slices for subject[x].subject[x]:subjectReference This element must be supported. 0..1 Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition) Type of individual the plan definition is focused on
PlanDefinition.date This element must be supported. 0..1 dateTime Date last changed
PlanDefinition.publisher This element must be supported. 0..1 string Name of the publisher/steward (organization or individual)
PlanDefinition.description This element must be supported. 1..1 markdown Natural language description of the plan definition
PlanDefinition.Slices for useContext This element must be supported. 1..* UsageContext The context that the content is intended to support
Slice: Unordered, Open by value:value
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.Slices for useContext.useContext:immunizationFocus This element must be supported. 0..1 UsageContext Marks this PlanDefinition as an immunization schedule
PlanDefinition.Slices for useContext.useContext:immunizationFocus.code 1..1 Coding Type of context being specified
Required Pattern:
{
  "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
  "code" : "focus"
}
PlanDefinition.Slices for useContext.useContext:immunizationFocus.value[x] 1..1 CodeableConcept Value that defines the context
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://snomed.info/sct",
      "code" : "33879002"
    }
  ]
}
PlanDefinition.Slices for useContext.useContext:immunizationFocus.value[x].coding 1..1 Coding Code defined by a terminology system
PlanDefinition.Slices for useContext.useContext:immunizationFocus.value[x].coding.system 1..1 uri Identity of the terminology system
PlanDefinition.Slices for useContext.useContext:immunizationFocus.value[x].coding.code 1..1 code Symbol in syntax defined by the system
PlanDefinition.Slices for useContext.useContext:scheduleCategory This element must be supported. 0..1 UsageContext Kind of immunization schedule
PlanDefinition.Slices for useContext.useContext:scheduleCategory.code 1..1 Coding Type of context being specified
Required Pattern:
{
  "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
  "code" : "topic"
}
PlanDefinition.Slices for useContext.useContext:scheduleCategory.value[x] 1..1 CodeableConcept Value that defines the context
Binding: ImmunizationScheduleTypeVS (0.11.1) (required)
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus This element must be supported. 0..1 UsageContext Marks this PlanDefinition as a whole blood donation schedule
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.code 1..1 Coding Type of context being specified
Required Pattern:
{
  "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
  "code" : "focus"
}
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.value[x] 1..1 CodeableConcept Value that defines the context
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://snomed.info/sct",
      "code" : "25179006"
    }
  ]
}
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.value[x].coding 1..1 Coding Code defined by a terminology system
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.value[x].coding.system 1..1 uri Identity of the terminology system
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.value[x].coding.code 1..1 code Symbol in syntax defined by the system
PlanDefinition.Slices for useContext.useContext:screeningFocus This element must be supported. 0..1 UsageContext Marks this PlanDefinition as a screening schedule
PlanDefinition.Slices for useContext.useContext:screeningFocus.code 1..1 Coding Type of context being specified
Required Pattern:
{
  "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
  "code" : "focus"
}
PlanDefinition.Slices for useContext.useContext:screeningFocus.value[x] 1..1 CodeableConcept Value that defines the context
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://snomed.info/sct",
      "code" : "360156006"
    }
  ]
}
PlanDefinition.Slices for useContext.useContext:screeningFocus.value[x].coding 1..1 Coding Code defined by a terminology system
PlanDefinition.Slices for useContext.useContext:screeningFocus.value[x].coding.system 1..1 uri Identity of the terminology system
PlanDefinition.Slices for useContext.useContext:screeningFocus.value[x].coding.code 1..1 code Symbol in syntax defined by the system
PlanDefinition.Slices for useContext.useContext:jurisdiction This element must be supported. 0..* UsageContext Where the schedule applies: Uzbekistan for a national schedule, or one entry per region for a regional one
PlanDefinition.Slices for useContext.useContext:jurisdiction.code 1..1 Coding Type of context being specified
Required Pattern:
{
  "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
  "code" : "jurisdiction"
}
PlanDefinition.Slices for useContext.useContext:jurisdiction.value[x] 1..1 CodeableConcept Value that defines the context
Binding: JurisdictionVS (0.11.1) (required)
PlanDefinition.Slices for useContext.useContext:jurisdiction.value[x].coding 1..1 Coding Code defined by a terminology system
PlanDefinition.Slices for useContext.useContext:jurisdiction.value[x].coding.system 1..1 uri Identity of the terminology system
PlanDefinition.Slices for useContext.useContext:jurisdiction.value[x].coding.code 1..1 code Symbol in syntax defined by the system
PlanDefinition.approvalDate This element must be supported. 0..1 date When the plan definition was approved by publisher
PlanDefinition.effectivePeriod This element must be supported. 0..1 Period When the plan definition is expected to be used
PlanDefinition.action This element must be supported. 0..* BackboneElement Definition of action included in the plan
PlanDefinition.action.linkId This element must be supported. 0..1 string Unique id for the action in the PlanDefinition
PlanDefinition.action.title This element must be supported. 0..1 string User-visible title
PlanDefinition.action.description This element must be supported. 0..1 markdown Brief description of the action
PlanDefinition.action.code This element must be supported. 0..1 CodeableConcept Code representing the meaning of the action or sub-actions
Binding: ActionCodeVS (0.11.1) (example)
PlanDefinition.action.condition This element must be supported. 0..* BackboneElement Whether or not the action is applicable
PlanDefinition.action.condition.kind This element must be supported. 1..1 code applicability | start | stop
Binding: ActionConditionVS (0.11.1) (required)
PlanDefinition.action.condition.expression This element must be supported. 0..1 Expression Boolean-valued expression
PlanDefinition.action.relatedAction This element must be supported. 0..* BackboneElement Relationship to another action
PlanDefinition.action.relatedAction.targetId This element must be supported. 1..1 id Identifier of related action
PlanDefinition.action.relatedAction.relationship This element must be supported. 1..1 code before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
Binding: ActionRelationshipTypeVS (0.11.1) (required)
PlanDefinition.action.relatedAction.Slices for offset[x] This element must be supported. 0..1 Duration, Range Time offset for the relationship
Slice: Unordered, Open by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.action.relatedAction.Slices for offset[x].offset[x]:offsetDuration This element must be supported. 0..1 Duration Time offset for the relationship
PlanDefinition.action.relatedAction.Slices for offset[x].offset[x]:offsetRange This element must be supported. 0..1 Range Time offset for the relationship
PlanDefinition.action.Slices for timing[x] This element must be supported. 0..1 When the action should take place
Slice: Unordered, Open by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.action.Slices for timing[x].timingAge Age
PlanDefinition.action.Slices for timing[x].timingTiming Timing
PlanDefinition.action.Slices for timing[x].timing[x]:timingAge This element must be supported. 0..1 Age When the action should take place
PlanDefinition.action.Slices for timing[x].timing[x]:timingTiming This element must be supported. 0..1 Timing When the action should take place
PlanDefinition.action.participant This element must be supported. 0..* BackboneElement Who should participate in the action
PlanDefinition.action.participant.actorId This element must be supported. 0..1 string What actor
PlanDefinition.action.participant.type This element must be supported. 0..1 code careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Binding: ParticipantResourceTypesVS (0.11.1) (required)
PlanDefinition.action.definition[x] This element must be supported. 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.11.1 This IG
PlanDefinition.status Base required Publication Status VS 📍0.11.1 This IG
PlanDefinition.useContext:scheduleCategory.​value[x] Base required UZ Core Immunization Schedule Type Value Set 📍0.11.1 This IG
PlanDefinition.useContext:jurisdiction.​value[x] Base required Uzbekistan Jurisdictions 📍0.11.1 This IG
PlanDefinition.action.​code Base example Action code translations 📍0.11.1 This IG
PlanDefinition.action.​condition.kind Base required Action condition translations 📍0.11.1 This IG
PlanDefinition.action.​relatedAction.relationship Base required Types of action relationship 📍0.11.1 This IG
PlanDefinition.action.​participant.type Base required Participant resource types translations 📍0.11.1 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: doco
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
PlanDefinition.id This element is included in summaries. 0..1 id Logical id of this artifact
PlanDefinition.meta This element is included in summaries. 0..1 Meta Metadata about the resource
PlanDefinition.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
PlanDefinition.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
PlanDefinition.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
PlanDefinition.contained 0..* Resource Contained, inline Resources
PlanDefinition.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.Slices for extension.extension:statusHistory This element must be supported. 0..* (Complex) History of PlanDefinition status changes
URL: https://dhp.uz/fhir/core/StructureDefinition/plan-definition-status-history
Constraints: ext-1
PlanDefinition.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
PlanDefinition.url This element must be supported. This element is included in summaries. C 1..1 uri Canonical identifier for this PlanDefinition
Constraints: cnl-1
PlanDefinition.identifier This element must be supported. This element is included in summaries. 0..* Identifier Additional identifier for the plan definition
PlanDefinition.version This element must be supported. This element is included in summaries. 0..1 string Business version of the plan definition
PlanDefinition.versionAlgorithm[x] This element must be supported. This element is included in summaries. 0..1 How to compare versions
Binding: VersionAlgorithmVS (0.11.1) (extensible)
PlanDefinition.versionAlgorithm[x].versionAlgorithmString string
PlanDefinition.versionAlgorithm[x].versionAlgorithmCoding Coding
PlanDefinition.name This element must be supported. This element is included in summaries. C 1..1 string Machine-processable name for this PlanDefinition
PlanDefinition.title This element must be supported. This element is included in summaries. 0..1 string Plan definition title (in Uzbek language)
PlanDefinition.title.id 0..1 string xml:id (or equivalent in JSON)
PlanDefinition.title.Slices for extension 0..* Extension Plan definition title (in Russian and Karakalpak languages)
Slice: Unordered, Open by value:url
Constraints: ext-1

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.title.Slices for extension.extension:translation This element must be supported. 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
Constraints: ext-1
PlanDefinition.title.value 0..1 string Primitive value for string
Max Length:1048576
PlanDefinition.subtitle 0..1 string Subordinate title of the plan definition
PlanDefinition.type This element is included in summaries. 0..1 CodeableConcept order-set | clinical-protocol | eca-rule | workflow-definition
Binding: PlanDefinitionType (extensible): The type of PlanDefinition.
PlanDefinition.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatusVS (0.11.1) (required)
PlanDefinition.experimental This element is included in summaries. 0..1 boolean For testing purposes, not real usage
PlanDefinition.Slices for subject[x] This element must be supported. 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.).
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.Slices for subject[x].subjectCodeableConcept CodeableConcept
PlanDefinition.Slices for subject[x].subjectReference Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition)
PlanDefinition.Slices for subject[x].subject[x]:subjectCodeableConcept This element must be supported. 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.).
PlanDefinition.Slices for subject[x].subject[x]:subjectReference This element must be supported. 0..1 Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition) Type of individual the plan definition is focused on
PlanDefinition.date This element must be supported. This element is included in summaries. 0..1 dateTime Date last changed
PlanDefinition.publisher This element must be supported. This element is included in summaries. 0..1 string Name of the publisher/steward (organization or individual)
PlanDefinition.contact This element is included in summaries. 0..* ContactDetail Contact details for the publisher
PlanDefinition.description This element must be supported. This element is included in summaries. 1..1 markdown Natural language description of the plan definition
PlanDefinition.Slices for useContext This element must be supported. This element is included in summaries. 1..* UsageContext The context that the content is intended to support
Slice: Unordered, Open by value:value

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.Slices for useContext.useContext:immunizationFocus This element must be supported. This element is included in summaries. 0..1 UsageContext Marks this PlanDefinition as an immunization schedule
PlanDefinition.Slices for useContext.useContext:immunizationFocus.id 0..1 id Unique id for inter-element referencing
PlanDefinition.Slices for useContext.useContext:immunizationFocus.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
PlanDefinition.Slices for useContext.useContext:immunizationFocus.code This element is included in summaries. 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:
{
  "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
  "code" : "focus"
}
PlanDefinition.Slices for useContext.useContext:immunizationFocus.value[x] This element is included in summaries. 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:
{
  "coding" : [
    {
      "system" : "http://snomed.info/sct",
      "code" : "33879002"
    }
  ]
}
PlanDefinition.Slices for useContext.useContext:immunizationFocus.value[x].id 0..1 id Unique id for inter-element referencing
PlanDefinition.Slices for useContext.useContext:immunizationFocus.value[x].extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
PlanDefinition.Slices for useContext.useContext:immunizationFocus.value[x].coding This element is included in summaries. 1..1 Coding Code defined by a terminology system
PlanDefinition.Slices for useContext.useContext:immunizationFocus.value[x].coding.id 0..1 id Unique id for inter-element referencing
PlanDefinition.Slices for useContext.useContext:immunizationFocus.value[x].coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
PlanDefinition.Slices for useContext.useContext:immunizationFocus.value[x].coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
PlanDefinition.Slices for useContext.useContext:immunizationFocus.value[x].coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
PlanDefinition.Slices for useContext.useContext:immunizationFocus.value[x].coding.code This element is included in summaries. C 1..1 code Symbol in syntax defined by the system
PlanDefinition.Slices for useContext.useContext:immunizationFocus.value[x].coding.display This element is included in summaries. C 0..1 string Representation defined by the system
PlanDefinition.Slices for useContext.useContext:immunizationFocus.value[x].coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
PlanDefinition.Slices for useContext.useContext:immunizationFocus.value[x].text This element is included in summaries. 0..1 string Plain text representation of the concept
PlanDefinition.Slices for useContext.useContext:scheduleCategory This element must be supported. This element is included in summaries. 0..1 UsageContext Kind of immunization schedule
PlanDefinition.Slices for useContext.useContext:scheduleCategory.id 0..1 id Unique id for inter-element referencing
PlanDefinition.Slices for useContext.useContext:scheduleCategory.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
PlanDefinition.Slices for useContext.useContext:scheduleCategory.code This element is included in summaries. 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:
{
  "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
  "code" : "topic"
}
PlanDefinition.Slices for useContext.useContext:scheduleCategory.value[x] This element is included in summaries. 1..1 CodeableConcept Value that defines the context
Binding: ImmunizationScheduleTypeVS (0.11.1) (required)
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus This element must be supported. This element is included in summaries. 0..1 UsageContext Marks this PlanDefinition as a whole blood donation schedule
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.id 0..1 id Unique id for inter-element referencing
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.code This element is included in summaries. 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:
{
  "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
  "code" : "focus"
}
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.value[x] This element is included in summaries. 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:
{
  "coding" : [
    {
      "system" : "http://snomed.info/sct",
      "code" : "25179006"
    }
  ]
}
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.value[x].id 0..1 id Unique id for inter-element referencing
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.value[x].extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.value[x].coding This element is included in summaries. 1..1 Coding Code defined by a terminology system
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.value[x].coding.id 0..1 id Unique id for inter-element referencing
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.value[x].coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.value[x].coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.value[x].coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.value[x].coding.code This element is included in summaries. C 1..1 code Symbol in syntax defined by the system
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.value[x].coding.display This element is included in summaries. C 0..1 string Representation defined by the system
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.value[x].coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
PlanDefinition.Slices for useContext.useContext:bloodDonationFocus.value[x].text This element is included in summaries. 0..1 string Plain text representation of the concept
PlanDefinition.Slices for useContext.useContext:screeningFocus This element must be supported. This element is included in summaries. 0..1 UsageContext Marks this PlanDefinition as a screening schedule
PlanDefinition.Slices for useContext.useContext:screeningFocus.id 0..1 id Unique id for inter-element referencing
PlanDefinition.Slices for useContext.useContext:screeningFocus.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
PlanDefinition.Slices for useContext.useContext:screeningFocus.code This element is included in summaries. 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:
{
  "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
  "code" : "focus"
}
PlanDefinition.Slices for useContext.useContext:screeningFocus.value[x] This element is included in summaries. 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:
{
  "coding" : [
    {
      "system" : "http://snomed.info/sct",
      "code" : "360156006"
    }
  ]
}
PlanDefinition.Slices for useContext.useContext:screeningFocus.value[x].id 0..1 id Unique id for inter-element referencing
PlanDefinition.Slices for useContext.useContext:screeningFocus.value[x].extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
PlanDefinition.Slices for useContext.useContext:screeningFocus.value[x].coding This element is included in summaries. 1..1 Coding Code defined by a terminology system
PlanDefinition.Slices for useContext.useContext:screeningFocus.value[x].coding.id 0..1 id Unique id for inter-element referencing
PlanDefinition.Slices for useContext.useContext:screeningFocus.value[x].coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
PlanDefinition.Slices for useContext.useContext:screeningFocus.value[x].coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
PlanDefinition.Slices for useContext.useContext:screeningFocus.value[x].coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
PlanDefinition.Slices for useContext.useContext:screeningFocus.value[x].coding.code This element is included in summaries. C 1..1 code Symbol in syntax defined by the system
PlanDefinition.Slices for useContext.useContext:screeningFocus.value[x].coding.display This element is included in summaries. C 0..1 string Representation defined by the system
PlanDefinition.Slices for useContext.useContext:screeningFocus.value[x].coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
PlanDefinition.Slices for useContext.useContext:screeningFocus.value[x].text This element is included in summaries. 0..1 string Plain text representation of the concept
PlanDefinition.Slices for useContext.useContext:jurisdiction This element must be supported. This element is included in summaries. 0..* UsageContext Where the schedule applies: Uzbekistan for a national schedule, or one entry per region for a regional one
PlanDefinition.Slices for useContext.useContext:jurisdiction.id 0..1 id Unique id for inter-element referencing
PlanDefinition.Slices for useContext.useContext:jurisdiction.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
PlanDefinition.Slices for useContext.useContext:jurisdiction.code This element is included in summaries. 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:
{
  "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
  "code" : "jurisdiction"
}
PlanDefinition.Slices for useContext.useContext:jurisdiction.value[x] This element is included in summaries. 1..1 CodeableConcept Value that defines the context
Binding: JurisdictionVS (0.11.1) (required)
PlanDefinition.Slices for useContext.useContext:jurisdiction.value[x].id 0..1 id Unique id for inter-element referencing
PlanDefinition.Slices for useContext.useContext:jurisdiction.value[x].extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
PlanDefinition.Slices for useContext.useContext:jurisdiction.value[x].coding This element is included in summaries. 1..1 Coding Code defined by a terminology system
PlanDefinition.Slices for useContext.useContext:jurisdiction.value[x].coding.id 0..1 id Unique id for inter-element referencing
PlanDefinition.Slices for useContext.useContext:jurisdiction.value[x].coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
PlanDefinition.Slices for useContext.useContext:jurisdiction.value[x].coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
PlanDefinition.Slices for useContext.useContext:jurisdiction.value[x].coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
PlanDefinition.Slices for useContext.useContext:jurisdiction.value[x].coding.code This element is included in summaries. C 1..1 code Symbol in syntax defined by the system
PlanDefinition.Slices for useContext.useContext:jurisdiction.value[x].coding.display This element is included in summaries. C 0..1 string Representation defined by the system
PlanDefinition.Slices for useContext.useContext:jurisdiction.value[x].coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
PlanDefinition.Slices for useContext.useContext:jurisdiction.value[x].text This element is included in summaries. 0..1 string Plain text representation of the concept
PlanDefinition.jurisdiction This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for plan definition (if applicable)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.
PlanDefinition.purpose 0..1 markdown Why this plan definition is defined
PlanDefinition.usage 0..1 markdown Describes the clinical usage of the plan
PlanDefinition.copyright 0..1 markdown Use and/or publishing restrictions
PlanDefinition.copyrightLabel 0..1 string Copyright holder and year(s)
PlanDefinition.approvalDate This element must be supported. 0..1 date When the plan definition was approved by publisher
PlanDefinition.lastReviewDate 0..1 date When the plan definition was last reviewed by the publisher
PlanDefinition.effectivePeriod This element must be supported. This element is included in summaries. 0..1 Period When the plan definition is expected to be used
PlanDefinition.topic 0..* CodeableConcept E.g. Education, Treatment, Assessment
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
PlanDefinition.author 0..* ContactDetail Who authored the content
PlanDefinition.editor 0..* ContactDetail Who edited the content
PlanDefinition.reviewer 0..* ContactDetail Who reviewed the content
PlanDefinition.endorser 0..* ContactDetail Who endorsed the content
PlanDefinition.relatedArtifact 0..* RelatedArtifact Additional documentation, citations
PlanDefinition.library 0..* canonical(Library) Logic used by the plan definition
PlanDefinition.goal C 0..* BackboneElement What the plan is trying to accomplish
PlanDefinition.goal.id 0..1 string Unique id for inter-element referencing
PlanDefinition.goal.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
PlanDefinition.goal.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
PlanDefinition.goal.category 0..1 CodeableConcept E.g. Treatment, dietary, behavioral
Binding: GoalCategory (example): Example codes for grouping goals for filtering or presentation.
PlanDefinition.goal.description 1..1 CodeableConcept Code or text describing the goal
Binding: SNOMEDCTClinicalFindings (example): Describes goals that can be achieved.
PlanDefinition.goal.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.
PlanDefinition.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.
PlanDefinition.goal.addresses 0..* CodeableConcept What does the goal address
Binding: ConditionProblemDiagnosisCodes (example): Identifies problems, conditions, issues, or concerns that goals may address.
PlanDefinition.goal.documentation 0..* RelatedArtifact Supporting documentation for the goal
PlanDefinition.goal.target 0..* BackboneElement Target outcome for the goal
PlanDefinition.goal.target.id 0..1 string Unique id for inter-element referencing
PlanDefinition.goal.target.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
PlanDefinition.goal.target.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
PlanDefinition.goal.target.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.
PlanDefinition.goal.target.detail[x] 0..1 The target value to be achieved
PlanDefinition.goal.target.detail[x].detailQuantity Quantity
PlanDefinition.goal.target.detail[x].detailRange Range
PlanDefinition.goal.target.detail[x].detailCodeableConcept CodeableConcept
PlanDefinition.goal.target.detail[x].detailString string
PlanDefinition.goal.target.detail[x].detailBoolean boolean
PlanDefinition.goal.target.detail[x].detailInteger integer
PlanDefinition.goal.target.detail[x].detailRatio Ratio
PlanDefinition.goal.target.due 0..1 Duration Reach goal within
PlanDefinition.actor 0..* BackboneElement Actors within the plan
PlanDefinition.actor.id 0..1 string Unique id for inter-element referencing
PlanDefinition.actor.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
PlanDefinition.actor.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
PlanDefinition.actor.title 0..1 string User-visible title
PlanDefinition.actor.description 0..1 markdown Describes the actor
PlanDefinition.actor.option 1..* BackboneElement Who or what can be this actor
PlanDefinition.actor.option.id 0..1 string Unique id for inter-element referencing
PlanDefinition.actor.option.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
PlanDefinition.actor.option.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
PlanDefinition.actor.option.type 0..1 code careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Binding: ActionParticipantType (required): The type of participant in the activity.
PlanDefinition.actor.option.typeCanonical 0..1 canonical(CapabilityStatement) Who or what can participate
PlanDefinition.actor.option.typeReference 0..1 Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) Who or what can participate
PlanDefinition.actor.option.role 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent
Binding: ActionParticipantRole (2.0.0) (example)
PlanDefinition.action This element must be supported. C 0..* BackboneElement Definition of action included in the plan
PlanDefinition.action.id 0..1 string Unique id for inter-element referencing
PlanDefinition.action.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
PlanDefinition.action.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
PlanDefinition.action.linkId This element must be supported. 0..1 string Unique id for the action in the PlanDefinition
PlanDefinition.action.prefix 0..1 string User-visible prefix for the action (e.g. 1. or A.)
PlanDefinition.action.title This element must be supported. 0..1 string User-visible title
PlanDefinition.action.description This element must be supported. 0..1 markdown Brief description of the action
PlanDefinition.action.textEquivalent 0..1 markdown Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
PlanDefinition.action.priority 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
PlanDefinition.action.code This element must be supported. 0..1 CodeableConcept Code representing the meaning of the action or sub-actions
Binding: ActionCodeVS (0.11.1) (example)
PlanDefinition.action.reason 0..* CodeableConcept Why the action should be performed
Binding: ActionReasonCode (example): Provides examples of reasons for actions to be performed.
PlanDefinition.action.documentation 0..* RelatedArtifact Supporting documentation for the intended performer of the action
PlanDefinition.action.goalId C 0..* id What goals this action supports
PlanDefinition.action.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.).
PlanDefinition.action.subject[x].subjectCodeableConcept CodeableConcept
PlanDefinition.action.subject[x].subjectReference Reference(Group)
PlanDefinition.action.subject[x].subjectCanonical canonical(Any)
PlanDefinition.action.trigger 0..* TriggerDefinition When the action should be triggered
PlanDefinition.action.condition This element must be supported. 0..* BackboneElement Whether or not the action is applicable
PlanDefinition.action.condition.id 0..1 string Unique id for inter-element referencing
PlanDefinition.action.condition.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
PlanDefinition.action.condition.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
PlanDefinition.action.condition.kind This element must be supported. 1..1 code applicability | start | stop
Binding: ActionConditionVS (0.11.1) (required)
PlanDefinition.action.condition.expression This element must be supported. 0..1 Expression Boolean-valued expression
PlanDefinition.action.input C 0..* BackboneElement Input data requirements
Constraints: pld-0
PlanDefinition.action.input.id 0..1 string Unique id for inter-element referencing
PlanDefinition.action.input.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
PlanDefinition.action.input.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
PlanDefinition.action.input.title 0..1 string User-visible title
PlanDefinition.action.input.requirement C 0..1 DataRequirement What data is provided
PlanDefinition.action.input.relatedData C 0..1 id What data is provided
PlanDefinition.action.output C 0..* BackboneElement Output data definition
Constraints: pld-1
PlanDefinition.action.output.id 0..1 string Unique id for inter-element referencing
PlanDefinition.action.output.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
PlanDefinition.action.output.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
PlanDefinition.action.output.title 0..1 string User-visible title
PlanDefinition.action.output.requirement C 0..1 DataRequirement What data is provided
PlanDefinition.action.output.relatedData C 0..1 string What data is provided
PlanDefinition.action.relatedAction This element must be supported. C 0..* BackboneElement Relationship to another action
PlanDefinition.action.relatedAction.id 0..1 string Unique id for inter-element referencing
PlanDefinition.action.relatedAction.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
PlanDefinition.action.relatedAction.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
PlanDefinition.action.relatedAction.targetId This element must be supported. C 1..1 id Identifier of related action
PlanDefinition.action.relatedAction.relationship This element must be supported. 1..1 code before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
Binding: ActionRelationshipTypeVS (0.11.1) (required)
PlanDefinition.action.relatedAction.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.
PlanDefinition.action.relatedAction.Slices for offset[x] This element must be supported. 0..1 Time offset for the relationship
Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.action.relatedAction.Slices for offset[x].offsetDuration Duration
PlanDefinition.action.relatedAction.Slices for offset[x].offsetRange Range
PlanDefinition.action.relatedAction.Slices for offset[x].offset[x]:offsetDuration This element must be supported. 0..1 Duration Time offset for the relationship
PlanDefinition.action.relatedAction.Slices for offset[x].offset[x]:offsetRange This element must be supported. 0..1 Range Time offset for the relationship
PlanDefinition.action.Slices for timing[x] This element must be supported. 0..1 When the action should take place
Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
PlanDefinition.action.Slices for timing[x].timingAge Age
PlanDefinition.action.Slices for timing[x].timingTiming Timing
PlanDefinition.action.Slices for timing[x].timing[x]:timingAge This element must be supported. 0..1 Age When the action should take place
PlanDefinition.action.Slices for timing[x].timing[x]:timingTiming This element must be supported. 0..1 Timing When the action should take place
PlanDefinition.action.location 0..1 CodeableReference(Location) Where it should happen
PlanDefinition.action.participant This element must be supported. 0..* BackboneElement Who should participate in the action
PlanDefinition.action.participant.id 0..1 string Unique id for inter-element referencing
PlanDefinition.action.participant.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
PlanDefinition.action.participant.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
PlanDefinition.action.participant.actorId This element must be supported. 0..1 string What actor
PlanDefinition.action.participant.type This element must be supported. 0..1 code careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Binding: ParticipantResourceTypesVS (0.11.1) (required)
PlanDefinition.action.participant.typeCanonical 0..1 canonical(CapabilityStatement) Who or what can participate
PlanDefinition.action.participant.typeReference 0..1 Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) Who or what can participate
PlanDefinition.action.participant.role 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent
Binding: ActionParticipantRole (2.0.0) (example): Defines roles played by participants for the action.
PlanDefinition.action.participant.function 0..1 CodeableConcept E.g. Author, Reviewer, Witness, etc
Binding: ActionParticipantFunction (example)
PlanDefinition.action.type 0..1 CodeableConcept create | update | remove | fire-event
Binding: ActionType (extensible): The type of action to be performed.
PlanDefinition.action.groupingBehavior 0..1 code visual-group | logical-group | sentence-group
Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.
PlanDefinition.action.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.
PlanDefinition.action.requiredBehavior 0..1 code must | could | must-unless-documented
Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.
PlanDefinition.action.precheckBehavior 0..1 code yes | no
Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.
PlanDefinition.action.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.
PlanDefinition.action.definition[x] This element must be supported. 0..1 Description of the activity to be performed
PlanDefinition.action.definition[x].definitionCanonical canonical(ActivityDefinition | MessageDefinition | ObservationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition)
PlanDefinition.action.definition[x].definitionUri uri
PlanDefinition.action.transform 0..1 canonical(StructureMap) Transform to apply the template
PlanDefinition.action.dynamicValue 0..* BackboneElement Dynamic aspects of the definition
PlanDefinition.action.dynamicValue.id 0..1 string Unique id for inter-element referencing
PlanDefinition.action.dynamicValue.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
PlanDefinition.action.dynamicValue.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
PlanDefinition.action.dynamicValue.path 0..1 string The path to the element to be set dynamically
PlanDefinition.action.dynamicValue.expression 0..1 Expression An expression that provides the dynamic value for the customization
PlanDefinition.action.action 0..* See action (PlanDefinition) A sub-action
PlanDefinition.asNeeded[x] This element is included in summaries. 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.
PlanDefinition.asNeeded[x].asNeededBoolean boolean
PlanDefinition.asNeeded[x].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.11.1 This IG
PlanDefinition.type Base extensible Plan Definition Type 📍5.0.0 FHIR Std.
PlanDefinition.status Base required Publication Status VS 📍0.11.1 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.11.1 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.11.1 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.11.1 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.11.1 This IG
PlanDefinition.action.​relatedAction.relationship Base required Types of action relationship 📍0.11.1 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.11.1 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

This structure is derived from PlanDefinition

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" ] },
  ...
}