O‘zbekiston Raqamli sog‘liqni saqlash platformasi
0.5.0 - ci-build
Uzbekistan Digital Health Platform, published by Ministry of Health of the Republic of Uzbekistan. This guide is not an authorized publication; it is the continuous build for version 0.5.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/uzinfocom-org/digital-health-ig/ and changes regularly. See the Directory of published versions
| Rasmiy URL: https://dhp.uz/fhir/core/StructureDefinition/uz-core-plan-definition | Versiya: 0.5.0 | ||||
| Draft 2026-06-05 holatiga ko‘ra | Kompyuterda qayta ishlanadigan nom: UZCorePlanDefinition | ||||
Uzbekistan Core PlanDefinition profile, used to express the national immunization schedule as computable logic
Mashina tarjimasi, inson tomonidan tekshirilishi zarur. Ushbu sahifa ingliz tilidan sun'iy intellekt yordamida avtomatik tarjima qilingan va hali muharrir tomonidan tekshirilmagan. Har qanday nomuvofiqlikda asl inglizcha versiya ustuvor hisoblanadi.
UZ Core PlanDefinition Oʻzbekistonning milliy emlash jadvalini hisoblanadigan mantiq koʻrinishida saqlaydi - har bir tavsiya etilgan doza, uning vaqti, dozalar orasidagi eng kichik intervallar va u kimga taalluqli ekanligini belgilovchi muvofiqlik qoidalari. Bu shunday resurski, tavsiya mexanizmi uni oʻqib har bir bemorning ImmunizationRecommendation resursini tuzadi. Berilgan koʻlam yoki yurisdiksiya uchun bir vaqtning oʻzida jadvalning faqat bitta versiyasi faol boʻlishi mumkin.
Quyidagi elementlar har doim mavjud boʻlishi (majburiy) yoki maʼlumot mavjud boʻlganda qoʻllab-quvvatlanishi kerak (Must Support) - hammasi ham talab qilinmaydi, lekin sizning tizimingiz har bir Must Support elementini maʼlumotga ega boʻlganda toʻldirishi va qabul qilinganda uni qayta ishlashi kerak. Bu inson tomonidan oʻqiladigan xulosa; quyidagi rasmiy koʻrinishlar aniq kardinalliklar, turlar va terminologik bogʻlanishlarni beradi.
Har bir PlanDefinition url (ushbu jadval uchun kanonik identifikator), mashina tomonidan qayta ishlanadigan name, status (draft, active, retired, unknown - asosiy resursdan majburiy sifatida meros olingan) va jadval nimani qamrab olishi haqidagi description ni olib yurishi shart.
Jadval jadvalni tekshirish qoidalarini qondirishi kerak: doza ketma-ketligida boʻshliqlar boʻlmasligi, imkonsiz vaqt oynalari boʻlmasligi va bir xil koʻlam uchun ikkita faol bir-birini qoplovchi versiya boʻlmasligi kerak.
PlanDefinition asosan bir marta yoziladi va tavsiya mexanizmi tomonidan oʻqiladi, shuning uchun quyidagi misollar qisqa. Ular server qabul qiladigan eng kichik nusxadan oʻz action larini olib yuruvchi jadvalgacha boradi. Bittasini nusxalab moslang - koʻrsatilgan har bir qiymat ushbu profilga muvofiq tekshiruvdan oʻtadi. Toʻliq maʼlumotnoma nusxasi - example PlanDefinition.
url, name va description majburiy elementlardir, status esa asosiy resursda majburiydir (draft | active | retired | unknown - required bogʻlanish). url boshqa resurslar havola qiladigan kanonik identifikator, shuning uchun u barqaror boʻlishi shart. Har bir UZ Core resursi shuningdek meta.profile da oʻzi muvofiqligini daʼvo qilayotgan profilni nomlaydi. Mana shuncha allaqachon tekshiruvdan oʻtadi:
{
"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-plan-definition",
"name": "ExamplePlanDefinition",
"status": "draft",
"description": "Example PlanDefinition demonstrating actions and relationships."
}
name - mashina tomonidan qayta ishlanadigan nom (boʻshliqlarsiz); mavjud boʻlsa, inson tomonidan oʻqiladigan title ni qoʻshing. Nashr etilgan jadval olib yurishi kerak boʻlgan publisher, date va version maydonlari uchun Metadata ga qarang.
Amalda jadval - bu action roʻyxati. Har bir doza linkId, title, description va code bilan bitta action dir. Muvofiqlik uchun condition (uning kind va FHIRPath expression), participant (kim bajaradi - actorId va type) va vaksina tafsilotini olib yuruvchi faoliyatga ishora qiluvchi definitionUri (yoki definitionCanonical) qoʻshing. Keyingi doza relatedAction yordamida targetId orqali oldingisiga ishora qiladi, eng kichik interval esa offsetDuration da:
{
"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-plan-definition",
"name": "ExamplePlanDefinition",
"title": "Example Vaccination Follow-up Plan",
"status": "draft",
"date": "2026-08-10",
"publisher": "DHP Uzbekistan",
"description": "Example PlanDefinition demonstrating actions and relationships.",
"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 va participant.type ning har biri required bogʻlanishdan foydalanadi - qiymatni bogʻlangan qiymatlar toʻplamidan oling (quyidagi Snapshot koʻrinishi har birini sanab oʻtadi). relatedAction.targetId xuddi shu jadvalda allaqachon mavjud action ning linkId siga mos kelishi shart.
API chaqiruvlari namunalari va namunaviy yuk uchun ushbu sahifaning pastidagi Quick Start boʻlimiga qarang.
Usages:
You can also check for usages in the FHIR IG Statistics
Profillar, differentsiyalar, snapshotlar va ularning tasvirlari ta’rifi.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
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 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
![]() ![]() |
SΣC | 1..1 | uri | Canonical identifier for this PlanDefinition Constraints: cnl-1 |
![]() ![]() |
SΣ | 0..* | Identifier | Additional identifier for the plan definition |
![]() ![]() |
SΣ | 0..1 | string | Business version of the plan definition |
![]() ![]() |
SΣ | 0..1 | How to compare versions Binding: VersionAlgorithmVS (0.5.0) (extensible) | |
![]() ![]() ![]() |
string | |||
![]() ![]() ![]() |
Coding | |||
![]() ![]() |
SΣC | 1..1 | string | Machine-processable name for this PlanDefinition |
![]() ![]() |
SΣ | 0..1 | string | Name for this plan definition (human friendly) |
![]() ![]() |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatusVS (0.5.0) (required) |
![]() ![]() |
S | 0..1 | Type of individual the plan definition is focused on Slice: Unordered, Closed by type:$this Binding: ParticipantResourceTypes (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). | |
![]() ![]() ![]() |
CodeableConcept | |||
![]() ![]() ![]() |
Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition) | |||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Type of individual the plan definition is focused on Binding: ParticipantResourceTypes (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). |
![]() ![]() ![]() |
S | 0..1 | Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition) | Type of individual the plan definition is focused on |
![]() ![]() |
SΣ | 0..1 | dateTime | Date last changed |
![]() ![]() |
SΣ | 0..1 | string | Name of the publisher/steward (organization or individual) |
![]() ![]() |
SΣ | 1..1 | markdown | Natural language description of the plan definition |
![]() ![]() |
SΣ | 0..* | UsageContext | The context that the content is intended to support |
![]() ![]() |
S | 0..1 | date | When the plan definition was approved by publisher |
![]() ![]() |
SΣ | 0..1 | Period | When the plan definition is expected to be used |
![]() ![]() |
SC | 0..* | BackboneElement | Definition of action included in the plan |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() |
S | 0..1 | string | Unique id for the action in the PlanDefinition |
![]() ![]() ![]() |
S | 0..1 | string | User-visible title |
![]() ![]() ![]() |
S | 0..1 | markdown | Brief description of the action |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: ActionCodeVS (0.5.0) (example) |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Whether or not the action is applicable |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() ![]() |
S | 1..1 | code | applicability | start | stop Binding: ActionConditionVS (0.5.0) (required) |
![]() ![]() ![]() ![]() |
S | 0..1 | Expression | Boolean-valued expression |
![]() ![]() ![]() |
SC | 0..* | BackboneElement | Relationship to another action |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() ![]() |
SC | 1..1 | id | Identifier of related action |
![]() ![]() ![]() ![]() |
S | 1..1 | code | before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end Binding: ActionRelationshipTypeVS (0.5.0) (required) |
![]() ![]() ![]() ![]() |
S | 0..1 | Time offset for the relationship Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() ![]() |
Duration | |||
![]() ![]() ![]() ![]() ![]() |
Range | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Duration | Time offset for the relationship |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Range | Time offset for the relationship |
![]() ![]() ![]() |
S | 0..1 | When the action should take place Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() |
Age | |||
![]() ![]() ![]() ![]() |
Timing | |||
![]() ![]() ![]() ![]() |
S | 0..1 | Age | When the action should take place |
![]() ![]() ![]() ![]() |
S | 0..1 | Timing | When the action should take place |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Who should participate in the action |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() ![]() |
S | 0..1 | string | What actor |
![]() ![]() ![]() ![]() |
S | 0..1 | code | careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson Binding: ParticipantResourceTypesVS (0.5.0) (required) |
![]() ![]() ![]() |
S | 0..1 | Description of the activity to be performed Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() |
canonical(ActivityDefinition | MessageDefinition | ObservationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition) | |||
![]() ![]() ![]() ![]() |
uri | |||
![]() ![]() ![]() ![]() |
S | 0..1 | canonical(ActivityDefinition | MessageDefinition | ObservationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition) | Description of the activity to be performed |
![]() ![]() ![]() ![]() |
S | 0..1 | uri | Description of the activity to be performed |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| PlanDefinition.versionAlgorithm[x] | Base | extensible | Version algorithm translations | 📍0.5.0 | This IG |
| PlanDefinition.status | Base | required | Publication status translations | 📍0.5.0 | This IG |
| PlanDefinition.subject[x] | Base | extensible | Participant Resource Types | 📍5.0.0 | FHIR Std. |
| PlanDefinition.subject[x]:subjectCodeableConcept | Base | extensible | Participant Resource Types | 📍5.0.0 | FHIR Std. |
| PlanDefinition.action.code | Base | example | Action code translations | 📍0.5.0 | This IG |
| PlanDefinition.action.condition.kind | Base | required | Action condition translations | 📍0.5.0 | This IG |
| PlanDefinition.action.relatedAction.relationship | Base | required | Types of action relationship | 📍0.5.0 | This IG |
| PlanDefinition.action.participant.type | Base | required | Participant resource types translations | 📍0.5.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| cnl-0 | warning | PlanDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
|
| cnl-1 | warning | PlanDefinition.url | URL should not contain | or # - these characters make processing canonical references problematic |
exists() implies matches('^[^|# ]+$')
|
| ele-1 | error | PlanDefinition.implicitRules, PlanDefinition.modifierExtension, PlanDefinition.url, PlanDefinition.identifier, PlanDefinition.version, PlanDefinition.versionAlgorithm[x], PlanDefinition.name, PlanDefinition.title, PlanDefinition.status, PlanDefinition.subject[x], PlanDefinition.subject[x]:subjectCodeableConcept, PlanDefinition.subject[x]:subjectReference, PlanDefinition.date, PlanDefinition.publisher, PlanDefinition.description, PlanDefinition.useContext, PlanDefinition.approvalDate, PlanDefinition.effectivePeriod, PlanDefinition.action, PlanDefinition.action.modifierExtension, PlanDefinition.action.linkId, PlanDefinition.action.title, PlanDefinition.action.description, PlanDefinition.action.code, PlanDefinition.action.condition, PlanDefinition.action.condition.modifierExtension, PlanDefinition.action.condition.kind, PlanDefinition.action.condition.expression, PlanDefinition.action.relatedAction, PlanDefinition.action.relatedAction.modifierExtension, PlanDefinition.action.relatedAction.targetId, PlanDefinition.action.relatedAction.relationship, PlanDefinition.action.relatedAction.offset[x], PlanDefinition.action.relatedAction.offset[x]:offsetDuration, PlanDefinition.action.relatedAction.offset[x]:offsetRange, PlanDefinition.action.timing[x], PlanDefinition.action.timing[x]:timingAge, PlanDefinition.action.timing[x]:timingTiming, PlanDefinition.action.participant, PlanDefinition.action.participant.modifierExtension, PlanDefinition.action.participant.actorId, PlanDefinition.action.participant.type, PlanDefinition.action.definition[x], PlanDefinition.action.definition[x]:definitionCanonical, PlanDefinition.action.definition[x]:definitionUri | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | PlanDefinition.modifierExtension, PlanDefinition.action.modifierExtension, PlanDefinition.action.condition.modifierExtension, PlanDefinition.action.relatedAction.modifierExtension, PlanDefinition.action.participant.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| pld-3 | warning | PlanDefinition | goalid should reference the id of a goal definition |
%context.repeat(action).where((goalId in %context.goal.id).not()).exists().not()
|
| pld-4 | warning | PlanDefinition | targetId should reference the id of an action |
%context.repeat(action).relatedAction.where((targetId in %context.repeat(action).id).not()).exists().not()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
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 | |
![]() ![]() |
S | 1..1 | uri | Canonical identifier for this PlanDefinition |
![]() ![]() |
S | 0..* | Identifier | Additional identifier for the plan definition |
![]() ![]() |
S | 0..1 | string | Business version of the plan definition |
![]() ![]() |
S | 0..1 | string, Coding | How to compare versions Binding: VersionAlgorithmVS (0.5.0) (extensible) |
![]() ![]() |
S | 1..1 | string | Machine-processable name for this PlanDefinition |
![]() ![]() |
S | 0..1 | string | Name for this plan definition (human friendly) |
![]() ![]() |
S | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatusVS (0.5.0) (required) |
![]() ![]() |
S | 0..1 | Type of individual the plan definition is focused on Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() |
CodeableConcept | |||
![]() ![]() ![]() |
Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition) | |||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Type of individual the plan definition is focused on |
![]() ![]() ![]() |
S | 0..1 | Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition) | Type of individual the plan definition is focused on |
![]() ![]() |
S | 0..1 | dateTime | Date last changed |
![]() ![]() |
S | 0..1 | string | Name of the publisher/steward (organization or individual) |
![]() ![]() |
S | 1..1 | markdown | Natural language description of the plan definition |
![]() ![]() |
S | 0..* | UsageContext | The context that the content is intended to support |
![]() ![]() |
S | 0..1 | date | When the plan definition was approved by publisher |
![]() ![]() |
S | 0..1 | Period | When the plan definition is expected to be used |
![]() ![]() |
S | 0..* | BackboneElement | Definition of action included in the plan |
![]() ![]() ![]() |
S | 0..1 | string | Unique id for the action in the PlanDefinition |
![]() ![]() ![]() |
S | 0..1 | string | User-visible title |
![]() ![]() ![]() |
S | 0..1 | markdown | Brief description of the action |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: ActionCodeVS (0.5.0) (example) |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Whether or not the action is applicable |
![]() ![]() ![]() ![]() |
S | 1..1 | code | applicability | start | stop Binding: ActionConditionVS (0.5.0) (required) |
![]() ![]() ![]() ![]() |
S | 0..1 | Expression | Boolean-valued expression |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Relationship to another action |
![]() ![]() ![]() ![]() |
S | 1..1 | id | Identifier of related action |
![]() ![]() ![]() ![]() |
S | 1..1 | code | before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end Binding: ActionRelationshipTypeVS (0.5.0) (required) |
![]() ![]() ![]() ![]() |
S | 0..1 | Duration, Range | Time offset for the relationship Slice: Unordered, Open by type:$this |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Duration | Time offset for the relationship |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Range | Time offset for the relationship |
![]() ![]() ![]() |
S | 0..1 | When the action should take place Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() |
Age | |||
![]() ![]() ![]() ![]() |
Timing | |||
![]() ![]() ![]() ![]() |
S | 0..1 | Age | When the action should take place |
![]() ![]() ![]() ![]() |
S | 0..1 | Timing | When the action should take place |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Who should participate in the action |
![]() ![]() ![]() ![]() |
S | 0..1 | string | What actor |
![]() ![]() ![]() ![]() |
S | 0..1 | code | careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson Binding: ParticipantResourceTypesVS (0.5.0) (required) |
![]() ![]() ![]() |
S | 0..1 | canonical(ActivityDefinition | MessageDefinition | ObservationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition), uri | Description of the activity to be performed Slice: Unordered, Open by type:$this |
![]() ![]() ![]() ![]() |
S | 0..1 | canonical(ActivityDefinition | MessageDefinition | ObservationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition) | Description of the activity to be performed |
![]() ![]() ![]() ![]() |
S | 0..1 | uri | Description of the activity to be performed |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| PlanDefinition.versionAlgorithm[x] | Base | extensible | Version algorithm translations | 📍0.5.0 | This IG |
| PlanDefinition.status | Base | required | Publication status translations | 📍0.5.0 | This IG |
| PlanDefinition.action.code | Base | example | Action code translations | 📍0.5.0 | This IG |
| PlanDefinition.action.condition.kind | Base | required | Action condition translations | 📍0.5.0 | This IG |
| PlanDefinition.action.relatedAction.relationship | Base | required | Types of action relationship | 📍0.5.0 | This IG |
| PlanDefinition.action.participant.type | Base | required | Participant resource types translations | 📍0.5.0 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
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 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
![]() ![]() |
SΣC | 1..1 | uri | Canonical identifier for this PlanDefinition Constraints: cnl-1 | ||||
![]() ![]() |
SΣ | 0..* | Identifier | Additional identifier for the plan definition | ||||
![]() ![]() |
SΣ | 0..1 | string | Business version of the plan definition | ||||
![]() ![]() |
SΣ | 0..1 | How to compare versions Binding: VersionAlgorithmVS (0.5.0) (extensible) | |||||
![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() |
Coding | |||||||
![]() ![]() |
SΣC | 1..1 | string | Machine-processable name for this PlanDefinition | ||||
![]() ![]() |
SΣ | 0..1 | string | Name for this plan definition (human friendly) | ||||
![]() ![]() |
0..1 | string | Subordinate title of the plan definition | |||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | order-set | clinical-protocol | eca-rule | workflow-definition Binding: PlanDefinitionType (extensible): The type of PlanDefinition. | ||||
![]() ![]() |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatusVS (0.5.0) (required) | ||||
![]() ![]() |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
![]() ![]() |
S | 0..1 | Type of individual the plan definition is focused on Slice: Unordered, Closed by type:$this Binding: ParticipantResourceTypes (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). | |||||
![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() |
Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition) | |||||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Type of individual the plan definition is focused on Binding: ParticipantResourceTypes (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). | ||||
![]() ![]() ![]() |
S | 0..1 | Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition) | Type of individual the plan definition is focused on | ||||
![]() ![]() |
SΣ | 0..1 | dateTime | Date last changed | ||||
![]() ![]() |
SΣ | 0..1 | string | Name of the publisher/steward (organization or individual) | ||||
![]() ![]() |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
![]() ![]() |
SΣ | 1..1 | markdown | Natural language description of the plan definition | ||||
![]() ![]() |
SΣ | 0..* | UsageContext | The context that the content is intended to support | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Intended jurisdiction for plan definition (if applicable) Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
![]() ![]() |
0..1 | markdown | Why this plan definition is defined | |||||
![]() ![]() |
0..1 | markdown | Describes the clinical usage of the plan | |||||
![]() ![]() |
0..1 | markdown | Use and/or publishing restrictions | |||||
![]() ![]() |
0..1 | string | Copyright holder and year(s) | |||||
![]() ![]() |
S | 0..1 | date | When the plan definition was approved by publisher | ||||
![]() ![]() |
0..1 | date | When the plan definition was last reviewed by the publisher | |||||
![]() ![]() |
SΣ | 0..1 | Period | When the plan definition is expected to be used | ||||
![]() ![]() |
0..* | CodeableConcept | E.g. Education, Treatment, Assessment Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering. | |||||
![]() ![]() |
0..* | ContactDetail | Who authored the content | |||||
![]() ![]() |
0..* | ContactDetail | Who edited the content | |||||
![]() ![]() |
0..* | ContactDetail | Who reviewed the content | |||||
![]() ![]() |
0..* | ContactDetail | Who endorsed the content | |||||
![]() ![]() |
0..* | RelatedArtifact | Additional documentation, citations | |||||
![]() ![]() |
0..* | canonical(Library) | Logic used by the plan definition | |||||
![]() ![]() |
C | 0..* | BackboneElement | What the plan is trying to accomplish | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | E.g. Treatment, dietary, behavioral Binding: GoalCategory (example): Example codes for grouping goals for filtering or presentation. | |||||
![]() ![]() ![]() |
1..1 | CodeableConcept | Code or text describing the goal Binding: SNOMEDCTClinicalFindings (example): Describes goals that can be achieved. | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: GoalPriority (preferred): Indicates the level of importance associated with reaching or sustaining a goal. | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | When goal pursuit begins Binding: GoalStartEvent (example): Identifies the types of events that might trigger the start of a goal. | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | What does the goal address Binding: ConditionProblemDiagnosisCodes (example): Identifies problems, conditions, issues, or concerns that goals may address. | |||||
![]() ![]() ![]() |
0..* | RelatedArtifact | Supporting documentation for the goal | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Target outcome for the goal | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() |
0..1 | The target value to be achieved | ||||||
![]() ![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() ![]() ![]() |
Ratio | |||||||
![]() ![]() ![]() ![]() |
0..1 | Duration | Reach goal within | |||||
![]() ![]() |
0..* | BackboneElement | Actors within the plan | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
0..1 | string | User-visible title | |||||
![]() ![]() ![]() |
0..1 | markdown | Describes the actor | |||||
![]() ![]() ![]() |
1..* | BackboneElement | Who or what can be this actor | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | code | careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson Binding: ActionParticipantType (required): The type of participant in the activity. | |||||
![]() ![]() ![]() ![]() |
0..1 | canonical(CapabilityStatement) | Who or what can participate | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Who or what can participate | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (2.0.0) (example) | |||||
![]() ![]() |
SC | 0..* | BackboneElement | Definition of action included in the plan | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
S | 0..1 | string | Unique id for the action in the PlanDefinition | ||||
![]() ![]() ![]() |
0..1 | string | User-visible prefix for the action (e.g. 1. or A.) | |||||
![]() ![]() ![]() |
S | 0..1 | string | User-visible title | ||||
![]() ![]() ![]() |
S | 0..1 | markdown | Brief description of the action | ||||
![]() ![]() ![]() |
0..1 | markdown | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system | |||||
![]() ![]() ![]() |
0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: ActionCodeVS (0.5.0) (example) | ||||
![]() ![]() ![]() |
0..* | CodeableConcept | Why the action should be performed Binding: ActionReasonCode (example): Provides examples of reasons for actions to be performed. | |||||
![]() ![]() ![]() |
0..* | RelatedArtifact | Supporting documentation for the intended performer of the action | |||||
![]() ![]() ![]() |
C | 0..* | id | What goals this action supports | ||||
![]() ![]() ![]() |
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.). | ||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Reference(Group) | |||||||
![]() ![]() ![]() ![]() |
canonical(Any) | |||||||
![]() ![]() ![]() |
0..* | TriggerDefinition | When the action should be triggered | |||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | Whether or not the action is applicable | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | code | applicability | start | stop Binding: ActionConditionVS (0.5.0) (required) | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | Expression | Boolean-valued expression | ||||
![]() ![]() ![]() |
C | 0..* | BackboneElement | Input data requirements Constraints: pld-0 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | User-visible title | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | DataRequirement | What data is provided | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | id | What data is provided | ||||
![]() ![]() ![]() |
C | 0..* | BackboneElement | Output data definition Constraints: pld-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | User-visible title | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | DataRequirement | What data is provided | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | string | What data is provided | ||||
![]() ![]() ![]() |
SC | 0..* | BackboneElement | Relationship to another action | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
SC | 1..1 | id | Identifier of related action | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | code | before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end Binding: ActionRelationshipTypeVS (0.5.0) (required) | ||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | Time offset for the relationship Slice: Unordered, Closed by type:$this | |||||
![]() ![]() ![]() ![]() ![]() |
Duration | |||||||
![]() ![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Duration | Time offset for the relationship | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Range | Time offset for the relationship | ||||
![]() ![]() ![]() |
S | 0..1 | When the action should take place Slice: Unordered, Closed by type:$this | |||||
![]() ![]() ![]() ![]() |
Age | |||||||
![]() ![]() ![]() ![]() |
Timing | |||||||
![]() ![]() ![]() ![]() |
S | 0..1 | Age | When the action should take place | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | Timing | When the action should take place | ||||
![]() ![]() ![]() |
0..1 | CodeableReference(Location) | Where it should happen | |||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | Who should participate in the action | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | string | What actor | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | code | careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson Binding: ParticipantResourceTypesVS (0.5.0) (required) | ||||
![]() ![]() ![]() ![]() |
0..1 | canonical(CapabilityStatement) | Who or what can participate | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Who or what can participate | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (2.0.0) (example): Defines roles played by participants for the action. | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | E.g. Author, Reviewer, Witness, etc Binding: ActionParticipantFunction (example) | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed. | |||||
![]() ![]() ![]() |
0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group. | |||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required. | |||||
![]() ![]() ![]() |
0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group. | |||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
S | 0..1 | Description of the activity to be performed Slice: Unordered, Closed by type:$this | |||||
![]() ![]() ![]() ![]() |
canonical(ActivityDefinition | MessageDefinition | ObservationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition) | |||||||
![]() ![]() ![]() ![]() |
uri | |||||||
![]() ![]() ![]() ![]() |
S | 0..1 | canonical(ActivityDefinition | MessageDefinition | ObservationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition) | Description of the activity to be performed | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | uri | Description of the activity to be performed | ||||
![]() ![]() ![]() |
0..1 | canonical(StructureMap) | Transform to apply the template | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Dynamic aspects of the definition | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | The path to the element to be set dynamically | |||||
![]() ![]() ![]() ![]() |
0..1 | Expression | An expression that provides the dynamic value for the customization | |||||
![]() ![]() ![]() |
0..* | See action (PlanDefinition) | A sub-action | |||||
![]() ![]() |
Σ | 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. | |||||
![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() |
CodeableConcept | |||||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| PlanDefinition.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| PlanDefinition.versionAlgorithm[x] | Base | extensible | Version algorithm translations | 📍0.5.0 | This IG |
| PlanDefinition.type | Base | extensible | Plan Definition Type | 📍5.0.0 | FHIR Std. |
| PlanDefinition.status | Base | required | Publication status translations | 📍0.5.0 | This IG |
| PlanDefinition.subject[x] | Base | extensible | Participant Resource Types | 📍5.0.0 | FHIR Std. |
| PlanDefinition.subject[x]:subjectCodeableConcept | Base | extensible | Participant Resource Types | 📍5.0.0 | FHIR Std. |
| PlanDefinition.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.1 |
| PlanDefinition.action.priority | Base | required | RequestPriority | 📍5.0.0 | FHIR Std. |
| PlanDefinition.action.code | Base | example | Action code translations | 📍0.5.0 | This IG |
| PlanDefinition.action.reason | Base | example | Action Reason Code | 📍5.0.0 | FHIR Std. |
| PlanDefinition.action.subject[x] | Base | extensible | Participant Resource Types | 📍5.0.0 | FHIR Std. |
| PlanDefinition.action.condition.kind | Base | required | Action condition translations | 📍0.5.0 | This IG |
| PlanDefinition.action.relatedAction.relationship | Base | required | Types of action relationship | 📍0.5.0 | This IG |
| PlanDefinition.action.relatedAction.endRelationship | Base | required | Action Relationship Type | 📍5.0.0 | FHIR Std. |
| PlanDefinition.action.participant.type | Base | required | Participant resource types translations | 📍0.5.0 | This IG |
| PlanDefinition.action.participant.role | Base | example | Action Participant Role | 📍2.0.0 | THO v7.1 |
| 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. |
| Id | Grade | Path(s) | Description | Expression |
| cnl-0 | warning | PlanDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
|
| cnl-1 | warning | PlanDefinition.url | URL should not contain | or # - these characters make processing canonical references problematic |
exists() implies matches('^[^|# ]+$')
|
| ele-1 | error | PlanDefinition.meta, PlanDefinition.implicitRules, PlanDefinition.language, PlanDefinition.text, PlanDefinition.extension, PlanDefinition.modifierExtension, PlanDefinition.url, PlanDefinition.identifier, PlanDefinition.version, PlanDefinition.versionAlgorithm[x], PlanDefinition.name, PlanDefinition.title, PlanDefinition.subtitle, PlanDefinition.type, PlanDefinition.status, PlanDefinition.experimental, PlanDefinition.subject[x], PlanDefinition.subject[x]:subjectCodeableConcept, PlanDefinition.subject[x]:subjectReference, PlanDefinition.date, PlanDefinition.publisher, PlanDefinition.contact, PlanDefinition.description, PlanDefinition.useContext, PlanDefinition.jurisdiction, PlanDefinition.purpose, PlanDefinition.usage, PlanDefinition.copyright, PlanDefinition.copyrightLabel, PlanDefinition.approvalDate, PlanDefinition.lastReviewDate, PlanDefinition.effectivePeriod, PlanDefinition.topic, PlanDefinition.author, PlanDefinition.editor, PlanDefinition.reviewer, PlanDefinition.endorser, PlanDefinition.relatedArtifact, PlanDefinition.library, PlanDefinition.goal, PlanDefinition.goal.extension, PlanDefinition.goal.modifierExtension, PlanDefinition.goal.category, PlanDefinition.goal.description, PlanDefinition.goal.priority, PlanDefinition.goal.start, PlanDefinition.goal.addresses, PlanDefinition.goal.documentation, PlanDefinition.goal.target, PlanDefinition.goal.target.extension, PlanDefinition.goal.target.modifierExtension, PlanDefinition.goal.target.measure, PlanDefinition.goal.target.detail[x], PlanDefinition.goal.target.due, PlanDefinition.actor, PlanDefinition.actor.extension, PlanDefinition.actor.modifierExtension, PlanDefinition.actor.title, PlanDefinition.actor.description, PlanDefinition.actor.option, PlanDefinition.actor.option.extension, PlanDefinition.actor.option.modifierExtension, PlanDefinition.actor.option.type, PlanDefinition.actor.option.typeCanonical, PlanDefinition.actor.option.typeReference, PlanDefinition.actor.option.role, PlanDefinition.action, PlanDefinition.action.extension, PlanDefinition.action.modifierExtension, PlanDefinition.action.linkId, PlanDefinition.action.prefix, PlanDefinition.action.title, PlanDefinition.action.description, PlanDefinition.action.textEquivalent, PlanDefinition.action.priority, PlanDefinition.action.code, PlanDefinition.action.reason, PlanDefinition.action.documentation, PlanDefinition.action.goalId, PlanDefinition.action.subject[x], PlanDefinition.action.trigger, PlanDefinition.action.condition, PlanDefinition.action.condition.extension, PlanDefinition.action.condition.modifierExtension, PlanDefinition.action.condition.kind, PlanDefinition.action.condition.expression, PlanDefinition.action.input, PlanDefinition.action.input.extension, PlanDefinition.action.input.modifierExtension, PlanDefinition.action.input.title, PlanDefinition.action.input.requirement, PlanDefinition.action.input.relatedData, PlanDefinition.action.output, PlanDefinition.action.output.extension, PlanDefinition.action.output.modifierExtension, PlanDefinition.action.output.title, PlanDefinition.action.output.requirement, PlanDefinition.action.output.relatedData, PlanDefinition.action.relatedAction, PlanDefinition.action.relatedAction.extension, PlanDefinition.action.relatedAction.modifierExtension, PlanDefinition.action.relatedAction.targetId, PlanDefinition.action.relatedAction.relationship, PlanDefinition.action.relatedAction.endRelationship, PlanDefinition.action.relatedAction.offset[x], PlanDefinition.action.relatedAction.offset[x]:offsetDuration, PlanDefinition.action.relatedAction.offset[x]:offsetRange, PlanDefinition.action.timing[x], PlanDefinition.action.timing[x]:timingAge, PlanDefinition.action.timing[x]:timingTiming, PlanDefinition.action.location, PlanDefinition.action.participant, PlanDefinition.action.participant.extension, PlanDefinition.action.participant.modifierExtension, PlanDefinition.action.participant.actorId, PlanDefinition.action.participant.type, PlanDefinition.action.participant.typeCanonical, PlanDefinition.action.participant.typeReference, PlanDefinition.action.participant.role, PlanDefinition.action.participant.function, PlanDefinition.action.type, PlanDefinition.action.groupingBehavior, PlanDefinition.action.selectionBehavior, PlanDefinition.action.requiredBehavior, PlanDefinition.action.precheckBehavior, PlanDefinition.action.cardinalityBehavior, PlanDefinition.action.definition[x], PlanDefinition.action.definition[x]:definitionCanonical, PlanDefinition.action.definition[x]:definitionUri, PlanDefinition.action.transform, PlanDefinition.action.dynamicValue, PlanDefinition.action.dynamicValue.extension, PlanDefinition.action.dynamicValue.modifierExtension, PlanDefinition.action.dynamicValue.path, PlanDefinition.action.dynamicValue.expression, PlanDefinition.action.action, PlanDefinition.asNeeded[x] | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | PlanDefinition.extension, PlanDefinition.modifierExtension, PlanDefinition.goal.extension, PlanDefinition.goal.modifierExtension, PlanDefinition.goal.target.extension, PlanDefinition.goal.target.modifierExtension, PlanDefinition.actor.extension, PlanDefinition.actor.modifierExtension, PlanDefinition.actor.option.extension, PlanDefinition.actor.option.modifierExtension, PlanDefinition.action.extension, PlanDefinition.action.modifierExtension, PlanDefinition.action.condition.extension, PlanDefinition.action.condition.modifierExtension, PlanDefinition.action.input.extension, PlanDefinition.action.input.modifierExtension, PlanDefinition.action.output.extension, PlanDefinition.action.output.modifierExtension, PlanDefinition.action.relatedAction.extension, PlanDefinition.action.relatedAction.modifierExtension, PlanDefinition.action.participant.extension, PlanDefinition.action.participant.modifierExtension, PlanDefinition.action.dynamicValue.extension, PlanDefinition.action.dynamicValue.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| pld-0 | error | PlanDefinition.action.input | Input data elements must have a requirement or a relatedData, but not both |
requirement.exists() xor relatedData.exists()
|
| pld-1 | error | PlanDefinition.action.output | Output data element must have a requirement or a relatedData, but not both |
requirement.exists() xor relatedData.exists()
|
| pld-3 | warning | PlanDefinition | goalid should reference the id of a goal definition |
%context.repeat(action).where((goalId in %context.goal.id).not()).exists().not()
|
| pld-4 | warning | PlanDefinition | targetId should reference the id of an action |
%context.repeat(action).relatedAction.where((targetId in %context.repeat(action).id).not()).exists().not()
|
Summary
Mandatory: 3 elements
Must-Support: 39 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Asosiy elementlar ko'rinishi
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
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 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
![]() ![]() |
SΣC | 1..1 | uri | Canonical identifier for this PlanDefinition Constraints: cnl-1 |
![]() ![]() |
SΣ | 0..* | Identifier | Additional identifier for the plan definition |
![]() ![]() |
SΣ | 0..1 | string | Business version of the plan definition |
![]() ![]() |
SΣ | 0..1 | How to compare versions Binding: VersionAlgorithmVS (0.5.0) (extensible) | |
![]() ![]() ![]() |
string | |||
![]() ![]() ![]() |
Coding | |||
![]() ![]() |
SΣC | 1..1 | string | Machine-processable name for this PlanDefinition |
![]() ![]() |
SΣ | 0..1 | string | Name for this plan definition (human friendly) |
![]() ![]() |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatusVS (0.5.0) (required) |
![]() ![]() |
S | 0..1 | Type of individual the plan definition is focused on Slice: Unordered, Closed by type:$this Binding: ParticipantResourceTypes (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). | |
![]() ![]() ![]() |
CodeableConcept | |||
![]() ![]() ![]() |
Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition) | |||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Type of individual the plan definition is focused on Binding: ParticipantResourceTypes (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). |
![]() ![]() ![]() |
S | 0..1 | Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition) | Type of individual the plan definition is focused on |
![]() ![]() |
SΣ | 0..1 | dateTime | Date last changed |
![]() ![]() |
SΣ | 0..1 | string | Name of the publisher/steward (organization or individual) |
![]() ![]() |
SΣ | 1..1 | markdown | Natural language description of the plan definition |
![]() ![]() |
SΣ | 0..* | UsageContext | The context that the content is intended to support |
![]() ![]() |
S | 0..1 | date | When the plan definition was approved by publisher |
![]() ![]() |
SΣ | 0..1 | Period | When the plan definition is expected to be used |
![]() ![]() |
SC | 0..* | BackboneElement | Definition of action included in the plan |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() |
S | 0..1 | string | Unique id for the action in the PlanDefinition |
![]() ![]() ![]() |
S | 0..1 | string | User-visible title |
![]() ![]() ![]() |
S | 0..1 | markdown | Brief description of the action |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: ActionCodeVS (0.5.0) (example) |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Whether or not the action is applicable |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() ![]() |
S | 1..1 | code | applicability | start | stop Binding: ActionConditionVS (0.5.0) (required) |
![]() ![]() ![]() ![]() |
S | 0..1 | Expression | Boolean-valued expression |
![]() ![]() ![]() |
SC | 0..* | BackboneElement | Relationship to another action |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() ![]() |
SC | 1..1 | id | Identifier of related action |
![]() ![]() ![]() ![]() |
S | 1..1 | code | before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end Binding: ActionRelationshipTypeVS (0.5.0) (required) |
![]() ![]() ![]() ![]() |
S | 0..1 | Time offset for the relationship Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() ![]() |
Duration | |||
![]() ![]() ![]() ![]() ![]() |
Range | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Duration | Time offset for the relationship |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Range | Time offset for the relationship |
![]() ![]() ![]() |
S | 0..1 | When the action should take place Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() |
Age | |||
![]() ![]() ![]() ![]() |
Timing | |||
![]() ![]() ![]() ![]() |
S | 0..1 | Age | When the action should take place |
![]() ![]() ![]() ![]() |
S | 0..1 | Timing | When the action should take place |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Who should participate in the action |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() ![]() |
S | 0..1 | string | What actor |
![]() ![]() ![]() ![]() |
S | 0..1 | code | careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson Binding: ParticipantResourceTypesVS (0.5.0) (required) |
![]() ![]() ![]() |
S | 0..1 | Description of the activity to be performed Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() |
canonical(ActivityDefinition | MessageDefinition | ObservationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition) | |||
![]() ![]() ![]() ![]() |
uri | |||
![]() ![]() ![]() ![]() |
S | 0..1 | canonical(ActivityDefinition | MessageDefinition | ObservationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition) | Description of the activity to be performed |
![]() ![]() ![]() ![]() |
S | 0..1 | uri | Description of the activity to be performed |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| PlanDefinition.versionAlgorithm[x] | Base | extensible | Version algorithm translations | 📍0.5.0 | This IG |
| PlanDefinition.status | Base | required | Publication status translations | 📍0.5.0 | This IG |
| PlanDefinition.subject[x] | Base | extensible | Participant Resource Types | 📍5.0.0 | FHIR Std. |
| PlanDefinition.subject[x]:subjectCodeableConcept | Base | extensible | Participant Resource Types | 📍5.0.0 | FHIR Std. |
| PlanDefinition.action.code | Base | example | Action code translations | 📍0.5.0 | This IG |
| PlanDefinition.action.condition.kind | Base | required | Action condition translations | 📍0.5.0 | This IG |
| PlanDefinition.action.relatedAction.relationship | Base | required | Types of action relationship | 📍0.5.0 | This IG |
| PlanDefinition.action.participant.type | Base | required | Participant resource types translations | 📍0.5.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| cnl-0 | warning | PlanDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
|
| cnl-1 | warning | PlanDefinition.url | URL should not contain | or # - these characters make processing canonical references problematic |
exists() implies matches('^[^|# ]+$')
|
| ele-1 | error | PlanDefinition.implicitRules, PlanDefinition.modifierExtension, PlanDefinition.url, PlanDefinition.identifier, PlanDefinition.version, PlanDefinition.versionAlgorithm[x], PlanDefinition.name, PlanDefinition.title, PlanDefinition.status, PlanDefinition.subject[x], PlanDefinition.subject[x]:subjectCodeableConcept, PlanDefinition.subject[x]:subjectReference, PlanDefinition.date, PlanDefinition.publisher, PlanDefinition.description, PlanDefinition.useContext, PlanDefinition.approvalDate, PlanDefinition.effectivePeriod, PlanDefinition.action, PlanDefinition.action.modifierExtension, PlanDefinition.action.linkId, PlanDefinition.action.title, PlanDefinition.action.description, PlanDefinition.action.code, PlanDefinition.action.condition, PlanDefinition.action.condition.modifierExtension, PlanDefinition.action.condition.kind, PlanDefinition.action.condition.expression, PlanDefinition.action.relatedAction, PlanDefinition.action.relatedAction.modifierExtension, PlanDefinition.action.relatedAction.targetId, PlanDefinition.action.relatedAction.relationship, PlanDefinition.action.relatedAction.offset[x], PlanDefinition.action.relatedAction.offset[x]:offsetDuration, PlanDefinition.action.relatedAction.offset[x]:offsetRange, PlanDefinition.action.timing[x], PlanDefinition.action.timing[x]:timingAge, PlanDefinition.action.timing[x]:timingTiming, PlanDefinition.action.participant, PlanDefinition.action.participant.modifierExtension, PlanDefinition.action.participant.actorId, PlanDefinition.action.participant.type, PlanDefinition.action.definition[x], PlanDefinition.action.definition[x]:definitionCanonical, PlanDefinition.action.definition[x]:definitionUri | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | PlanDefinition.modifierExtension, PlanDefinition.action.modifierExtension, PlanDefinition.action.condition.modifierExtension, PlanDefinition.action.relatedAction.modifierExtension, PlanDefinition.action.participant.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| pld-3 | warning | PlanDefinition | goalid should reference the id of a goal definition |
%context.repeat(action).where((goalId in %context.goal.id).not()).exists().not()
|
| pld-4 | warning | PlanDefinition | targetId should reference the id of an action |
%context.repeat(action).relatedAction.where((targetId in %context.repeat(action).id).not()).exists().not()
|
Differensial ko‘rinish
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
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 | |
![]() ![]() |
S | 1..1 | uri | Canonical identifier for this PlanDefinition |
![]() ![]() |
S | 0..* | Identifier | Additional identifier for the plan definition |
![]() ![]() |
S | 0..1 | string | Business version of the plan definition |
![]() ![]() |
S | 0..1 | string, Coding | How to compare versions Binding: VersionAlgorithmVS (0.5.0) (extensible) |
![]() ![]() |
S | 1..1 | string | Machine-processable name for this PlanDefinition |
![]() ![]() |
S | 0..1 | string | Name for this plan definition (human friendly) |
![]() ![]() |
S | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatusVS (0.5.0) (required) |
![]() ![]() |
S | 0..1 | Type of individual the plan definition is focused on Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() |
CodeableConcept | |||
![]() ![]() ![]() |
Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition) | |||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Type of individual the plan definition is focused on |
![]() ![]() ![]() |
S | 0..1 | Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition) | Type of individual the plan definition is focused on |
![]() ![]() |
S | 0..1 | dateTime | Date last changed |
![]() ![]() |
S | 0..1 | string | Name of the publisher/steward (organization or individual) |
![]() ![]() |
S | 1..1 | markdown | Natural language description of the plan definition |
![]() ![]() |
S | 0..* | UsageContext | The context that the content is intended to support |
![]() ![]() |
S | 0..1 | date | When the plan definition was approved by publisher |
![]() ![]() |
S | 0..1 | Period | When the plan definition is expected to be used |
![]() ![]() |
S | 0..* | BackboneElement | Definition of action included in the plan |
![]() ![]() ![]() |
S | 0..1 | string | Unique id for the action in the PlanDefinition |
![]() ![]() ![]() |
S | 0..1 | string | User-visible title |
![]() ![]() ![]() |
S | 0..1 | markdown | Brief description of the action |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: ActionCodeVS (0.5.0) (example) |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Whether or not the action is applicable |
![]() ![]() ![]() ![]() |
S | 1..1 | code | applicability | start | stop Binding: ActionConditionVS (0.5.0) (required) |
![]() ![]() ![]() ![]() |
S | 0..1 | Expression | Boolean-valued expression |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Relationship to another action |
![]() ![]() ![]() ![]() |
S | 1..1 | id | Identifier of related action |
![]() ![]() ![]() ![]() |
S | 1..1 | code | before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end Binding: ActionRelationshipTypeVS (0.5.0) (required) |
![]() ![]() ![]() ![]() |
S | 0..1 | Duration, Range | Time offset for the relationship Slice: Unordered, Open by type:$this |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Duration | Time offset for the relationship |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Range | Time offset for the relationship |
![]() ![]() ![]() |
S | 0..1 | When the action should take place Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() |
Age | |||
![]() ![]() ![]() ![]() |
Timing | |||
![]() ![]() ![]() ![]() |
S | 0..1 | Age | When the action should take place |
![]() ![]() ![]() ![]() |
S | 0..1 | Timing | When the action should take place |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Who should participate in the action |
![]() ![]() ![]() ![]() |
S | 0..1 | string | What actor |
![]() ![]() ![]() ![]() |
S | 0..1 | code | careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson Binding: ParticipantResourceTypesVS (0.5.0) (required) |
![]() ![]() ![]() |
S | 0..1 | canonical(ActivityDefinition | MessageDefinition | ObservationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition), uri | Description of the activity to be performed Slice: Unordered, Open by type:$this |
![]() ![]() ![]() ![]() |
S | 0..1 | canonical(ActivityDefinition | MessageDefinition | ObservationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition) | Description of the activity to be performed |
![]() ![]() ![]() ![]() |
S | 0..1 | uri | Description of the activity to be performed |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| PlanDefinition.versionAlgorithm[x] | Base | extensible | Version algorithm translations | 📍0.5.0 | This IG |
| PlanDefinition.status | Base | required | Publication status translations | 📍0.5.0 | This IG |
| PlanDefinition.action.code | Base | example | Action code translations | 📍0.5.0 | This IG |
| PlanDefinition.action.condition.kind | Base | required | Action condition translations | 📍0.5.0 | This IG |
| PlanDefinition.action.relatedAction.relationship | Base | required | Types of action relationship | 📍0.5.0 | This IG |
| PlanDefinition.action.participant.type | Base | required | Participant resource types translations | 📍0.5.0 | This IG |
Snapshot ko‘rinishiView
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
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 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
![]() ![]() |
SΣC | 1..1 | uri | Canonical identifier for this PlanDefinition Constraints: cnl-1 | ||||
![]() ![]() |
SΣ | 0..* | Identifier | Additional identifier for the plan definition | ||||
![]() ![]() |
SΣ | 0..1 | string | Business version of the plan definition | ||||
![]() ![]() |
SΣ | 0..1 | How to compare versions Binding: VersionAlgorithmVS (0.5.0) (extensible) | |||||
![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() |
Coding | |||||||
![]() ![]() |
SΣC | 1..1 | string | Machine-processable name for this PlanDefinition | ||||
![]() ![]() |
SΣ | 0..1 | string | Name for this plan definition (human friendly) | ||||
![]() ![]() |
0..1 | string | Subordinate title of the plan definition | |||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | order-set | clinical-protocol | eca-rule | workflow-definition Binding: PlanDefinitionType (extensible): The type of PlanDefinition. | ||||
![]() ![]() |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatusVS (0.5.0) (required) | ||||
![]() ![]() |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
![]() ![]() |
S | 0..1 | Type of individual the plan definition is focused on Slice: Unordered, Closed by type:$this Binding: ParticipantResourceTypes (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). | |||||
![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() |
Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition) | |||||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Type of individual the plan definition is focused on Binding: ParticipantResourceTypes (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). | ||||
![]() ![]() ![]() |
S | 0..1 | Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition) | Type of individual the plan definition is focused on | ||||
![]() ![]() |
SΣ | 0..1 | dateTime | Date last changed | ||||
![]() ![]() |
SΣ | 0..1 | string | Name of the publisher/steward (organization or individual) | ||||
![]() ![]() |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
![]() ![]() |
SΣ | 1..1 | markdown | Natural language description of the plan definition | ||||
![]() ![]() |
SΣ | 0..* | UsageContext | The context that the content is intended to support | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Intended jurisdiction for plan definition (if applicable) Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
![]() ![]() |
0..1 | markdown | Why this plan definition is defined | |||||
![]() ![]() |
0..1 | markdown | Describes the clinical usage of the plan | |||||
![]() ![]() |
0..1 | markdown | Use and/or publishing restrictions | |||||
![]() ![]() |
0..1 | string | Copyright holder and year(s) | |||||
![]() ![]() |
S | 0..1 | date | When the plan definition was approved by publisher | ||||
![]() ![]() |
0..1 | date | When the plan definition was last reviewed by the publisher | |||||
![]() ![]() |
SΣ | 0..1 | Period | When the plan definition is expected to be used | ||||
![]() ![]() |
0..* | CodeableConcept | E.g. Education, Treatment, Assessment Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering. | |||||
![]() ![]() |
0..* | ContactDetail | Who authored the content | |||||
![]() ![]() |
0..* | ContactDetail | Who edited the content | |||||
![]() ![]() |
0..* | ContactDetail | Who reviewed the content | |||||
![]() ![]() |
0..* | ContactDetail | Who endorsed the content | |||||
![]() ![]() |
0..* | RelatedArtifact | Additional documentation, citations | |||||
![]() ![]() |
0..* | canonical(Library) | Logic used by the plan definition | |||||
![]() ![]() |
C | 0..* | BackboneElement | What the plan is trying to accomplish | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | E.g. Treatment, dietary, behavioral Binding: GoalCategory (example): Example codes for grouping goals for filtering or presentation. | |||||
![]() ![]() ![]() |
1..1 | CodeableConcept | Code or text describing the goal Binding: SNOMEDCTClinicalFindings (example): Describes goals that can be achieved. | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: GoalPriority (preferred): Indicates the level of importance associated with reaching or sustaining a goal. | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | When goal pursuit begins Binding: GoalStartEvent (example): Identifies the types of events that might trigger the start of a goal. | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | What does the goal address Binding: ConditionProblemDiagnosisCodes (example): Identifies problems, conditions, issues, or concerns that goals may address. | |||||
![]() ![]() ![]() |
0..* | RelatedArtifact | Supporting documentation for the goal | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Target outcome for the goal | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() |
0..1 | The target value to be achieved | ||||||
![]() ![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() ![]() ![]() |
Ratio | |||||||
![]() ![]() ![]() ![]() |
0..1 | Duration | Reach goal within | |||||
![]() ![]() |
0..* | BackboneElement | Actors within the plan | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
0..1 | string | User-visible title | |||||
![]() ![]() ![]() |
0..1 | markdown | Describes the actor | |||||
![]() ![]() ![]() |
1..* | BackboneElement | Who or what can be this actor | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | code | careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson Binding: ActionParticipantType (required): The type of participant in the activity. | |||||
![]() ![]() ![]() ![]() |
0..1 | canonical(CapabilityStatement) | Who or what can participate | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Who or what can participate | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (2.0.0) (example) | |||||
![]() ![]() |
SC | 0..* | BackboneElement | Definition of action included in the plan | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
S | 0..1 | string | Unique id for the action in the PlanDefinition | ||||
![]() ![]() ![]() |
0..1 | string | User-visible prefix for the action (e.g. 1. or A.) | |||||
![]() ![]() ![]() |
S | 0..1 | string | User-visible title | ||||
![]() ![]() ![]() |
S | 0..1 | markdown | Brief description of the action | ||||
![]() ![]() ![]() |
0..1 | markdown | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system | |||||
![]() ![]() ![]() |
0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: ActionCodeVS (0.5.0) (example) | ||||
![]() ![]() ![]() |
0..* | CodeableConcept | Why the action should be performed Binding: ActionReasonCode (example): Provides examples of reasons for actions to be performed. | |||||
![]() ![]() ![]() |
0..* | RelatedArtifact | Supporting documentation for the intended performer of the action | |||||
![]() ![]() ![]() |
C | 0..* | id | What goals this action supports | ||||
![]() ![]() ![]() |
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.). | ||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Reference(Group) | |||||||
![]() ![]() ![]() ![]() |
canonical(Any) | |||||||
![]() ![]() ![]() |
0..* | TriggerDefinition | When the action should be triggered | |||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | Whether or not the action is applicable | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | code | applicability | start | stop Binding: ActionConditionVS (0.5.0) (required) | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | Expression | Boolean-valued expression | ||||
![]() ![]() ![]() |
C | 0..* | BackboneElement | Input data requirements Constraints: pld-0 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | User-visible title | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | DataRequirement | What data is provided | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | id | What data is provided | ||||
![]() ![]() ![]() |
C | 0..* | BackboneElement | Output data definition Constraints: pld-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | User-visible title | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | DataRequirement | What data is provided | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | string | What data is provided | ||||
![]() ![]() ![]() |
SC | 0..* | BackboneElement | Relationship to another action | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
SC | 1..1 | id | Identifier of related action | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | code | before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end Binding: ActionRelationshipTypeVS (0.5.0) (required) | ||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | Time offset for the relationship Slice: Unordered, Closed by type:$this | |||||
![]() ![]() ![]() ![]() ![]() |
Duration | |||||||
![]() ![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Duration | Time offset for the relationship | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Range | Time offset for the relationship | ||||
![]() ![]() ![]() |
S | 0..1 | When the action should take place Slice: Unordered, Closed by type:$this | |||||
![]() ![]() ![]() ![]() |
Age | |||||||
![]() ![]() ![]() ![]() |
Timing | |||||||
![]() ![]() ![]() ![]() |
S | 0..1 | Age | When the action should take place | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | Timing | When the action should take place | ||||
![]() ![]() ![]() |
0..1 | CodeableReference(Location) | Where it should happen | |||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | Who should participate in the action | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | string | What actor | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | code | careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson Binding: ParticipantResourceTypesVS (0.5.0) (required) | ||||
![]() ![]() ![]() ![]() |
0..1 | canonical(CapabilityStatement) | Who or what can participate | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Who or what can participate | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (2.0.0) (example): Defines roles played by participants for the action. | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | E.g. Author, Reviewer, Witness, etc Binding: ActionParticipantFunction (example) | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed. | |||||
![]() ![]() ![]() |
0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group. | |||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required. | |||||
![]() ![]() ![]() |
0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group. | |||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
S | 0..1 | Description of the activity to be performed Slice: Unordered, Closed by type:$this | |||||
![]() ![]() ![]() ![]() |
canonical(ActivityDefinition | MessageDefinition | ObservationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition) | |||||||
![]() ![]() ![]() ![]() |
uri | |||||||
![]() ![]() ![]() ![]() |
S | 0..1 | canonical(ActivityDefinition | MessageDefinition | ObservationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition) | Description of the activity to be performed | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | uri | Description of the activity to be performed | ||||
![]() ![]() ![]() |
0..1 | canonical(StructureMap) | Transform to apply the template | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Dynamic aspects of the definition | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | The path to the element to be set dynamically | |||||
![]() ![]() ![]() ![]() |
0..1 | Expression | An expression that provides the dynamic value for the customization | |||||
![]() ![]() ![]() |
0..* | See action (PlanDefinition) | A sub-action | |||||
![]() ![]() |
Σ | 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. | |||||
![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() |
CodeableConcept | |||||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| PlanDefinition.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| PlanDefinition.versionAlgorithm[x] | Base | extensible | Version algorithm translations | 📍0.5.0 | This IG |
| PlanDefinition.type | Base | extensible | Plan Definition Type | 📍5.0.0 | FHIR Std. |
| PlanDefinition.status | Base | required | Publication status translations | 📍0.5.0 | This IG |
| PlanDefinition.subject[x] | Base | extensible | Participant Resource Types | 📍5.0.0 | FHIR Std. |
| PlanDefinition.subject[x]:subjectCodeableConcept | Base | extensible | Participant Resource Types | 📍5.0.0 | FHIR Std. |
| PlanDefinition.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.1 |
| PlanDefinition.action.priority | Base | required | RequestPriority | 📍5.0.0 | FHIR Std. |
| PlanDefinition.action.code | Base | example | Action code translations | 📍0.5.0 | This IG |
| PlanDefinition.action.reason | Base | example | Action Reason Code | 📍5.0.0 | FHIR Std. |
| PlanDefinition.action.subject[x] | Base | extensible | Participant Resource Types | 📍5.0.0 | FHIR Std. |
| PlanDefinition.action.condition.kind | Base | required | Action condition translations | 📍0.5.0 | This IG |
| PlanDefinition.action.relatedAction.relationship | Base | required | Types of action relationship | 📍0.5.0 | This IG |
| PlanDefinition.action.relatedAction.endRelationship | Base | required | Action Relationship Type | 📍5.0.0 | FHIR Std. |
| PlanDefinition.action.participant.type | Base | required | Participant resource types translations | 📍0.5.0 | This IG |
| PlanDefinition.action.participant.role | Base | example | Action Participant Role | 📍2.0.0 | THO v7.1 |
| 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. |
| Id | Grade | Path(s) | Description | Expression |
| cnl-0 | warning | PlanDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
|
| cnl-1 | warning | PlanDefinition.url | URL should not contain | or # - these characters make processing canonical references problematic |
exists() implies matches('^[^|# ]+$')
|
| ele-1 | error | PlanDefinition.meta, PlanDefinition.implicitRules, PlanDefinition.language, PlanDefinition.text, PlanDefinition.extension, PlanDefinition.modifierExtension, PlanDefinition.url, PlanDefinition.identifier, PlanDefinition.version, PlanDefinition.versionAlgorithm[x], PlanDefinition.name, PlanDefinition.title, PlanDefinition.subtitle, PlanDefinition.type, PlanDefinition.status, PlanDefinition.experimental, PlanDefinition.subject[x], PlanDefinition.subject[x]:subjectCodeableConcept, PlanDefinition.subject[x]:subjectReference, PlanDefinition.date, PlanDefinition.publisher, PlanDefinition.contact, PlanDefinition.description, PlanDefinition.useContext, PlanDefinition.jurisdiction, PlanDefinition.purpose, PlanDefinition.usage, PlanDefinition.copyright, PlanDefinition.copyrightLabel, PlanDefinition.approvalDate, PlanDefinition.lastReviewDate, PlanDefinition.effectivePeriod, PlanDefinition.topic, PlanDefinition.author, PlanDefinition.editor, PlanDefinition.reviewer, PlanDefinition.endorser, PlanDefinition.relatedArtifact, PlanDefinition.library, PlanDefinition.goal, PlanDefinition.goal.extension, PlanDefinition.goal.modifierExtension, PlanDefinition.goal.category, PlanDefinition.goal.description, PlanDefinition.goal.priority, PlanDefinition.goal.start, PlanDefinition.goal.addresses, PlanDefinition.goal.documentation, PlanDefinition.goal.target, PlanDefinition.goal.target.extension, PlanDefinition.goal.target.modifierExtension, PlanDefinition.goal.target.measure, PlanDefinition.goal.target.detail[x], PlanDefinition.goal.target.due, PlanDefinition.actor, PlanDefinition.actor.extension, PlanDefinition.actor.modifierExtension, PlanDefinition.actor.title, PlanDefinition.actor.description, PlanDefinition.actor.option, PlanDefinition.actor.option.extension, PlanDefinition.actor.option.modifierExtension, PlanDefinition.actor.option.type, PlanDefinition.actor.option.typeCanonical, PlanDefinition.actor.option.typeReference, PlanDefinition.actor.option.role, PlanDefinition.action, PlanDefinition.action.extension, PlanDefinition.action.modifierExtension, PlanDefinition.action.linkId, PlanDefinition.action.prefix, PlanDefinition.action.title, PlanDefinition.action.description, PlanDefinition.action.textEquivalent, PlanDefinition.action.priority, PlanDefinition.action.code, PlanDefinition.action.reason, PlanDefinition.action.documentation, PlanDefinition.action.goalId, PlanDefinition.action.subject[x], PlanDefinition.action.trigger, PlanDefinition.action.condition, PlanDefinition.action.condition.extension, PlanDefinition.action.condition.modifierExtension, PlanDefinition.action.condition.kind, PlanDefinition.action.condition.expression, PlanDefinition.action.input, PlanDefinition.action.input.extension, PlanDefinition.action.input.modifierExtension, PlanDefinition.action.input.title, PlanDefinition.action.input.requirement, PlanDefinition.action.input.relatedData, PlanDefinition.action.output, PlanDefinition.action.output.extension, PlanDefinition.action.output.modifierExtension, PlanDefinition.action.output.title, PlanDefinition.action.output.requirement, PlanDefinition.action.output.relatedData, PlanDefinition.action.relatedAction, PlanDefinition.action.relatedAction.extension, PlanDefinition.action.relatedAction.modifierExtension, PlanDefinition.action.relatedAction.targetId, PlanDefinition.action.relatedAction.relationship, PlanDefinition.action.relatedAction.endRelationship, PlanDefinition.action.relatedAction.offset[x], PlanDefinition.action.relatedAction.offset[x]:offsetDuration, PlanDefinition.action.relatedAction.offset[x]:offsetRange, PlanDefinition.action.timing[x], PlanDefinition.action.timing[x]:timingAge, PlanDefinition.action.timing[x]:timingTiming, PlanDefinition.action.location, PlanDefinition.action.participant, PlanDefinition.action.participant.extension, PlanDefinition.action.participant.modifierExtension, PlanDefinition.action.participant.actorId, PlanDefinition.action.participant.type, PlanDefinition.action.participant.typeCanonical, PlanDefinition.action.participant.typeReference, PlanDefinition.action.participant.role, PlanDefinition.action.participant.function, PlanDefinition.action.type, PlanDefinition.action.groupingBehavior, PlanDefinition.action.selectionBehavior, PlanDefinition.action.requiredBehavior, PlanDefinition.action.precheckBehavior, PlanDefinition.action.cardinalityBehavior, PlanDefinition.action.definition[x], PlanDefinition.action.definition[x]:definitionCanonical, PlanDefinition.action.definition[x]:definitionUri, PlanDefinition.action.transform, PlanDefinition.action.dynamicValue, PlanDefinition.action.dynamicValue.extension, PlanDefinition.action.dynamicValue.modifierExtension, PlanDefinition.action.dynamicValue.path, PlanDefinition.action.dynamicValue.expression, PlanDefinition.action.action, PlanDefinition.asNeeded[x] | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | PlanDefinition.extension, PlanDefinition.modifierExtension, PlanDefinition.goal.extension, PlanDefinition.goal.modifierExtension, PlanDefinition.goal.target.extension, PlanDefinition.goal.target.modifierExtension, PlanDefinition.actor.extension, PlanDefinition.actor.modifierExtension, PlanDefinition.actor.option.extension, PlanDefinition.actor.option.modifierExtension, PlanDefinition.action.extension, PlanDefinition.action.modifierExtension, PlanDefinition.action.condition.extension, PlanDefinition.action.condition.modifierExtension, PlanDefinition.action.input.extension, PlanDefinition.action.input.modifierExtension, PlanDefinition.action.output.extension, PlanDefinition.action.output.modifierExtension, PlanDefinition.action.relatedAction.extension, PlanDefinition.action.relatedAction.modifierExtension, PlanDefinition.action.participant.extension, PlanDefinition.action.participant.modifierExtension, PlanDefinition.action.dynamicValue.extension, PlanDefinition.action.dynamicValue.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| pld-0 | error | PlanDefinition.action.input | Input data elements must have a requirement or a relatedData, but not both |
requirement.exists() xor relatedData.exists()
|
| pld-1 | error | PlanDefinition.action.output | Output data element must have a requirement or a relatedData, but not both |
requirement.exists() xor relatedData.exists()
|
| pld-3 | warning | PlanDefinition | goalid should reference the id of a goal definition |
%context.repeat(action).where((goalId in %context.goal.id).not()).exists().not()
|
| pld-4 | warning | PlanDefinition | targetId should reference the id of an action |
%context.repeat(action).relatedAction.where((targetId in %context.repeat(action).id).not()).exists().not()
|
Summary
Mandatory: 3 elements
Must-Support: 39 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Profilning boshqa ko‘rinishlari: CSV, Excel, Schematron
Mashina tarjimasi, inson tomonidan tekshirilishi zarur. Ushbu sahifa ingliz tilidan sun'iy intellekt yordamida avtomatik tarjima qilingan va hali muharrir tomonidan tekshirilmagan. Har qanday nomuvofiqlikda asl inglizcha versiya ustuvor hisoblanadi.
Ushbu profil uchun keng tarqalgan API o'zaro ta'sirlari. So'rovlar JWT kirish tokenini talab qiladi - Xavfsizlik va autentifikatsiya bo'limiga qarang. [base] - bu FHIR server bazaviy URL manzili; | token tizimini uning qiymatidan ajratadi va %7C ko'rinishida URL-kodlangan bo'lishi kerak. Ushbu o'zaro ta'sirlar standart FHIR R5 qidiruv parametrlaridan foydalanadi; ushbu resurs uchun yakunlanayotgani sayin CapabilityStatement hujjatiga qarang.
Jadvalni server identifikatori bo'yicha o'qish
GET [base]/PlanDefinition/[id]
Foydali qidiruvlar
# 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, jurisdiction, or use-context value
GET [base]/PlanDefinition?date=ge2026-01-01
GET [base]/PlanDefinition?jurisdiction=urn:iso:std:iso:3166%7CUZ
GET [base]/PlanDefinition?context-type-value=focus$http://snomed.info/sct%7C14189004
Jadval yaratish
POST [base]/PlanDefinition
{
"resourceType": "PlanDefinition",
"meta": { "profile": [ "https://dhp.uz/fhir/core/StructureDefinition/uz-core-plan-definition" ] },
...
}
Faollashtirishdan oldin jadval validatsiyadan o'tishini (doza-ketma-ketligida bo'shliqlar yo'qligi, imkonsiz vaqt oynalari yo'qligi) va shu doiraga oid boshqa hech qanday versiya allaqachon faol emasligini tasdiqlang.
Jadvalni yangilash (masalan, yangi versiyani chiqarish yoki eskisini iste'moldan chiqarish)
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" ] },
...
}