Extensions for Using Data Elements from FHIR R5 in FHIR STU3
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR STU3
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR STU3 - Downloaded Version null See the Directory of published versions
| Official URL: http://hl7.org/fhir/5.0/StructureDefinition/profile-PlanDefinition | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 0 | Computable Name: Profile_R5_PlanDefinition_R3 | ||
This cross-version profile allows R5 PlanDefinition content to be represented via FHIR STU3 PlanDefinition resources.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Path | Status | Usage | ValueSet | Version | Source |
| PlanDefinition.status | Base | required | PublicationStatus | 📍3.0.2 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-1 | error | PlanDefinition | If the resource is contained in another resource, it SHALL NOT contain any narrative |
contained.text.empty()
|
| dom-2 | error | PlanDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | PlanDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource |
contained.where(('#'+id in %resource.descendants().reference).not()).empty()
|
| dom-4 | error | PlanDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from PlanDefinition
| Name | Flags | Card. | Type | Description & Constraints Filter:   | ||||
|---|---|---|---|---|---|---|---|---|
  PlanDefinition |
0..* | PlanDefinition | The definition of a plan for a series of actions, independent of any specific patient or context | |||||
  id |
Σ | 0..1 | id | Logical id of this artifact | ||||
 meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: Common Languages  (extensible): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
   extension:versionAlgorithm |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm]] | R5: How to compare versions (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm | |||||
| extension:subtitle |
0..1 | string | R5: Subordinate title of the plan definition (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.subtitle | |||||
| extension:subject |
0..1 | CodeableConcept, Reference(Cross-version Profile for R5.Group for use in FHIR STU3(0.1.0) | Group | Cross-version Profile for R5.MedicinalProductDefinition for use in FHIR STU3(0.1.0) | Basic | Cross-version Profile for R5.SubstanceDefinition for use in FHIR STU3(0.1.0) | Basic | Cross-version Profile for R5.AdministrableProductDefinition for use in FHIR STU3(0.1.0) | Basic | Cross-version Profile for R5.ManufacturedItemDefinition for use in FHIR STU3(0.1.0) | Basic | Cross-version Profile for R5.PackagedProductDefinition for use in FHIR STU3(0.1.0) | Basic), uri | R5: Type of individual the plan definition is focused on (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.subject Binding: R5ParticipantResourceTypesForR3 (0.1.0) (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). | |||||
| extension:copyrightLabel |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel]] | R5: Copyright holder and year(s) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel | |||||
| extension:actor |
0..* | (Complex) | R5: Actors within the plan (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.actor | |||||
 extension:asNeeded |
0..1 | boolean, CodeableConcept | R5: Preconditions for service (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.asNeeded | |||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url |
Σ | 0..1 | uri | Logical URI to reference this plan definition (globally unique) | ||||
| identifier |
Σ | 0..* | Identifier | Additional identifier for the plan definition | ||||
| version |
Σ | 0..1 | string | Business version of the plan definition | ||||
| name |
Σ | 0..1 | string | Name for this plan definition (computer friendly) | ||||
| title |
Σ | 0..1 | string | Name for this plan definition (human friendly) | ||||
| type |
Σ | 0..1 | CodeableConcept | order-set | protocol | eca-rule Binding: PlanDefinitionType (extensible): The type of PlanDefinition | ||||
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of a Value Set or Concept Map. | ||||
| experimental |
?!Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
| date |
Σ | 0..1 | dateTime | Date this was last changed | ||||
| publisher |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| description |
Σ | 0..1 | markdown | Natural language description of the plan definition | ||||
| purpose |
0..1 | markdown | Why this plan definition is defined | |||||
| usage |
0..1 | string | Describes the clinical usage of the asset | |||||
| approvalDate |
0..1 | date | When the plan definition was approved by publisher | |||||
| lastReviewDate |
0..1 | date | When the plan definition was last reviewed | |||||
| effectivePeriod |
Σ | 0..1 | Period | When the plan definition is expected to be used | ||||
| useContext |
Σ | 0..* | UsageContext | Context the content is intended to support | ||||
| jurisdiction |
Σ | 0..* | CodeableConcept | Intended jurisdiction for plan definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use | ||||
| topic |
0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering | |||||
| contributor |
0..* | Contributor | A content contributor | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:author |
0..* | (Complex) | R5: Who authored the content additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.author | |||||
| extension:editor |
0..* | (Complex) | R5: Who edited the content additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.editor | |||||
| extension:reviewer |
0..* | (Complex) | R5: Who reviewed the content additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.reviewer | |||||
| extension:endorser |
0..* | (Complex) | R5: Who endorsed the content additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.endorser | |||||
| type |
Σ | 1..1 | code | author | editor | reviewer | endorser Binding: ContributorType (required): The type of contributor | ||||
| name |
Σ | 1..1 | string | Who contributed the content | ||||
 contact |
Σ | 0..* | ContactDetail | Contact details of the contributor | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:contact |
0..* | (Complex) | R5: contact additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.contact | |||||
| name |
Σ | 0..1 | string | Name of an individual to contact | ||||
| telecom |
Σ | 0..* | ContactPoint | Contact details for individual or organization | ||||
| copyright |
0..1 | markdown | Use and/or publishing restrictions | |||||
| relatedArtifact |
0..* | RelatedArtifact | Related artifacts for the asset | |||||
 library |
0..* | Reference(Library) | Logic used by the plan definition | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:library |
0..* | uri | R5: library additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.library | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| goal |
0..* | BackboneElement | What the plan is trying to accomplish | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| category |
0..1 | CodeableConcept | E.g. Treatment, dietary, behavioral, etc Binding: GoalCategory (example): Example codes for grouping goals for filtering or presentation | |||||
| description |
1..1 | CodeableConcept | Code or text describing the goal Binding: SNOMED CT Clinical Findings (example): Describes goals that can be achieved | |||||
| priority |
0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: GoalPriority (preferred): Indicates the level of importance associated with reaching or sustaining a goal | |||||
| start |
0..1 | CodeableConcept | When goal pursuit begins Binding: GoalStartEvent (example): Identifies the types of events that might trigger the start of a goal | |||||
| addresses |
0..* | CodeableConcept | What does the goal address Binding: Condition/Problem/Diagnosis Codes (example): Identifies problems, conditions, issues, or concerns that goals may address | |||||
| documentation |
0..* | RelatedArtifact | Supporting documentation for the goal | |||||
 target |
0..* | BackboneElement | Target outcome for the goal | |||||
 id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:detail |
0..1 | string, boolean, integer, Ratio | R5: detail additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.goal.target.detail | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| measure |
0..1 | CodeableConcept | The parameter whose value is to be tracked Binding: LOINC Codes (example): Identifies types of parameters that can be tracked to determine goal achievement | |||||
 detail[x] |
0..1 | The target value to be achieved | ||||||
| detailQuantity |
Quantity | |||||||
| detailRange |
Range | |||||||
| detailCodeableConcept |
CodeableConcept | |||||||
| due |
0..1 | Duration | Reach goal within | |||||
| action |
0..* | BackboneElement | Action defined by the plan | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:linkId |
0..1 | string | R5: Unique id for the action in the PlanDefinition (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.linkId | |||||
| extension:priority |
0..1 | code | R5: routine | urgent | asap | stat (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.priority Binding: MedicationRequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |||||
| extension:subject |
0..1 | CodeableConcept, Reference(Cross-version Profile for R5.Group for use in FHIR STU3(0.1.0) | Group), uri | R5: Type of individual the action is focused on (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.subject Binding: R5ParticipantResourceTypesForR3 (0.1.0) (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). | |||||
| extension:timing |
0..1 | Age | R5: timing additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.timing | |||||
| extension:location |
0..1 | (Complex) | R5: Where it should happen (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.location | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| label |
0..1 | string | User-visible label for the action (e.g. 1. or A.) | |||||
| title |
0..1 | string | User-visible title | |||||
| description |
0..1 | string | Short description of the action | |||||
| textEquivalent |
0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system | |||||
| code |
0..* | CodeableConcept | Code representing the meaning of the action or sub-actions | |||||
| reason |
0..* | CodeableConcept | Why the action should be performed | |||||
| documentation |
0..* | RelatedArtifact | Supporting documentation for the intended performer of the action | |||||
| goalId |
0..* | id | What goals this action supports | |||||
| triggerDefinition |
0..* | TriggerDefinition | When the action should be triggered | |||||
| condition |
0..* | BackboneElement | Whether or not the action is applicable | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| kind |
1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions | |||||
| description |
0..1 | string | Natural language description of the condition | |||||
| language |
0..1 | string | Language of the expression | |||||
| expression |
0..1 | string | Boolean-valued expression | |||||
| input |
0..* | DataRequirement | Input data requirements | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:title |
0..1 | string | R5: User-visible title (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.input.title | |||||
| extension:requirement |
0..1 | (Complex) | R5: What data is provided (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.input.requirement | |||||
| extension:relatedData |
0..1 | id | R5: What data is provided (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.input.relatedData | |||||
| type |
Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): Either an abstract type, a resource or a data type. | ||||
| profile |
Σ | 0..* | uri | The profile of the required data | ||||
| mustSupport |
Σ | 0..* | string | Indicates that specific structure elements are referenced by the knowledge module | ||||
| codeFilter |
Σ | 0..* | Element | What codes are expected | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| path |
Σ | 1..1 | string | The code-valued attribute of the filter | ||||
| valueSet[x] |
Σ | 0..1 | Valueset for the filter | |||||
| valueSetString |
string | |||||||
| valueSetReference |
Reference(ValueSet) | |||||||
| valueCode |
Σ | 0..* | code | What code is expected | ||||
| valueCoding |
Σ | 0..* | Coding | What Coding is expected | ||||
| valueCodeableConcept |
Σ | 0..* | CodeableConcept | What CodeableConcept is expected | ||||
| dateFilter |
Σ | 0..* | Element | What dates/date ranges are expected | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| path |
Σ | 1..1 | string | The date-valued attribute of the filter | ||||
| value[x] |
Σ | 0..1 | The value of the filter, as a Period, DateTime, or Duration value | |||||
| valueDateTime |
dateTime | |||||||
| valuePeriod |
Period | |||||||
| valueDuration |
Duration | |||||||
| output |
0..* | DataRequirement | Output data definition | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:title |
0..1 | string | R5: User-visible title (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.output.title | |||||
| extension:requirement |
0..1 | (Complex) | R5: What data is provided (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.output.requirement | |||||
| extension:relatedData |
0..1 | string | R5: What data is provided (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.output.relatedData | |||||
| type |
Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): Either an abstract type, a resource or a data type. | ||||
| profile |
Σ | 0..* | uri | The profile of the required data | ||||
| mustSupport |
Σ | 0..* | string | Indicates that specific structure elements are referenced by the knowledge module | ||||
| codeFilter |
Σ | 0..* | Element | What codes are expected | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| path |
Σ | 1..1 | string | The code-valued attribute of the filter | ||||
| valueSet[x] |
Σ | 0..1 | Valueset for the filter | |||||
| valueSetString |
string | |||||||
| valueSetReference |
Reference(ValueSet) | |||||||
| valueCode |
Σ | 0..* | code | What code is expected | ||||
| valueCoding |
Σ | 0..* | Coding | What Coding is expected | ||||
| valueCodeableConcept |
Σ | 0..* | CodeableConcept | What CodeableConcept is expected | ||||
| dateFilter |
Σ | 0..* | Element | What dates/date ranges are expected | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| path |
Σ | 1..1 | string | The date-valued attribute of the filter | ||||
| value[x] |
Σ | 0..1 | The value of the filter, as a Period, DateTime, or Duration value | |||||
| valueDateTime |
dateTime | |||||||
| valuePeriod |
Period | |||||||
| valueDuration |
Duration | |||||||
| relatedAction |
0..* | BackboneElement | Relationship to another action | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| actionId |
1..1 | id | What action is this related to | |||||
| relationship |
1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions | |||||
| offset[x] |
0..1 | Time offset for the relationship | ||||||
| offsetDuration |
Duration | |||||||
| offsetRange |
Range | |||||||
| timing[x] |
0..1 | When the action should take place | ||||||
| timingDateTime |
dateTime | |||||||
| timingPeriod |
Period | |||||||
| timingDuration |
Duration | |||||||
| timingRange |
Range | |||||||
| timingTiming |
Timing | |||||||
| participant |
0..* | BackboneElement | Who should participate in the action | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:actorId |
0..1 | string | R5: What actor (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.participant.actorId | |||||
| extension:typeCanonical |
0..1 | uri | R5: Who or what can participate (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.participant.typeCanonical | |||||
| extension:typeReference |
0..1 | Reference(Cross-version Profile for R5.CareTeam for use in FHIR STU3(0.1.0) | CareTeam | Cross-version Profile for R5.Device for use in FHIR STU3(0.1.0) | Device | Cross-version Profile for R5.DeviceDefinition for use in FHIR STU3(0.1.0) | Basic | Cross-version Profile for R5.Endpoint for use in FHIR STU3(0.1.0) | Endpoint | Cross-version Profile for R5.Group for use in FHIR STU3(0.1.0) | Group | Cross-version Profile for R5.HealthcareService for use in FHIR STU3(0.1.0) | HealthcareService | Cross-version Profile for R5.Location for use in FHIR STU3(0.1.0) | Location | Cross-version Profile for R5.Organization for use in FHIR STU3(0.1.0) | Organization | Cross-version Profile for R5.Patient for use in FHIR STU3(0.1.0) | Patient | Cross-version Profile for R5.Practitioner for use in FHIR STU3(0.1.0) | Practitioner | Cross-version Profile for R5.PractitionerRole for use in FHIR STU3(0.1.0) | PractitionerRole | Cross-version Profile for R5.RelatedPerson for use in FHIR STU3(0.1.0) | RelatedPerson) | R5: Who or what can participate (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.participant.typeReference | |||||
| extension:function |
0..1 | CodeableConcept | R5: E.g. Author, Reviewer, Witness, etc (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.participant.function Binding: R5ActionParticipantFunctionForR3 (0.1.0) (example) | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| type |
1..1 | code | patient | practitioner | related-person Binding: ActionParticipantType (required): The type of participant for the action | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:type |
0..1 | code | R5: careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.participant.type Binding: R5ActionParticipantTypeForR3 (0.1.0) (required): The type of participant in the activity. | |||||
| value |
0..1 | code | Primitive value for code | |||||
| role |
0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent, etc Binding: ActionParticipantRole (example): Defines roles played by participants for the action | |||||
| type |
0..1 | Coding | create | update | remove | fire-event Binding: ActionType (required): The type of action to be performed | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:type |
0..1 | CodeableConcept | R5: type additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.type Binding: ActionType (extensible): The type of action to be performed. | |||||
| system |
Σ | 0..1 | uri | Identity of the terminology system | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| groupingBehavior |
0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group | |||||
| selectionBehavior |
0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group | |||||
| requiredBehavior |
0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines requiredness behavior for selecting an action or an action group | |||||
| precheckBehavior |
0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group | |||||
| cardinalityBehavior |
0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated | |||||
| definition |
0..1 | Reference(ActivityDefinition | PlanDefinition) | Description of the activity to be performed | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:definition |
0..1 | uri | R5: definition additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.definition | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| transform |
0..1 | Reference(StructureMap) | Transform to apply the template | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:transform |
0..1 | uri | R5: transform additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.transform | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| dynamicValue |
0..* | BackboneElement | Dynamic aspects of the definition | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| description |
0..1 | string | Natural language description of the dynamic value | |||||
| path |
0..1 | string | The path to the element to be set dynamically | |||||
| language |
0..1 | string | Language of the expression | |||||
| expression |
0..1 | string | An expression that provides the dynamic value for the customization | |||||
 action |
0..* | See action (PlanDefinition) | A sub-action | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| PlanDefinition.language | Base | extensible |
Common Languages
|
📍3.0.2 | tx.fhir.org |
| PlanDefinition.type | Base | extensible | PlanDefinitionType | 📍3.0.2 | FHIR Std. |
| PlanDefinition.status | Base | required | PublicationStatus | 📍3.0.2 | FHIR Std. |
| PlanDefinition.jurisdiction | Base | extensible | Jurisdiction ValueSet | 📍3.0.2 | FHIR Std. |
| PlanDefinition.topic | Base | example | DefinitionTopic | 📍3.0.2 | FHIR Std. |
| PlanDefinition.contributor.type | Base | required | ContributorType | 📍3.0.2 | FHIR Std. |
| PlanDefinition.goal.category | Base | example | GoalCategory | 📍3.0.2 | FHIR Std. |
| PlanDefinition.goal.description | Base | example | SNOMED CT Clinical Findings | 📍3.0.2 | FHIR Std. |
| PlanDefinition.goal.priority | Base | preferred | GoalPriority | 📍3.0.2 | FHIR Std. |
| PlanDefinition.goal.start | Base | example | GoalStartEvent | 📍3.0.2 | FHIR Std. |
| PlanDefinition.goal.addresses | Base | example | Condition/Problem/Diagnosis Codes | 📍3.0.2 | FHIR Std. |
| PlanDefinition.goal.target.measure | Base | example | LOINC Codes | 📍3.0.2 | FHIR Std. |
| PlanDefinition.action.condition.kind | Base | required | ActionConditionKind | 📍3.0.2 | FHIR Std. |
| PlanDefinition.action.input.type | Base | required | FHIRAllTypes | 📍3.0.2 | FHIR Std. |
| PlanDefinition.action.output.type | Base | required | FHIRAllTypes | 📍3.0.2 | FHIR Std. |
| PlanDefinition.action.relatedAction.relationship | Base | required | ActionRelationshipType | 📍3.0.2 | FHIR Std. |
| PlanDefinition.action.participant.type | Base | required |
ActionParticipantType
|
📍3.0.2 | tx.fhir.org |
| PlanDefinition.action.participant.role | Base | example | ActionParticipantRole | 📍3.0.2 | FHIR Std. |
| PlanDefinition.action.type | Base | required | ActionType | 📍3.0.2 | FHIR Std. |
| PlanDefinition.action.groupingBehavior | Base | required | ActionGroupingBehavior | 📍3.0.2 | FHIR Std. |
| PlanDefinition.action.selectionBehavior | Base | required | ActionSelectionBehavior | 📍3.0.2 | FHIR Std. |
| PlanDefinition.action.requiredBehavior | Base | required | ActionRequiredBehavior | 📍3.0.2 | FHIR Std. |
| PlanDefinition.action.precheckBehavior | Base | required | ActionPrecheckBehavior | 📍3.0.2 | FHIR Std. |
| PlanDefinition.action.cardinalityBehavior | Base | required | ActionCardinalityBehavior | 📍3.0.2 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-1 | error | PlanDefinition | If the resource is contained in another resource, it SHALL NOT contain any narrative |
contained.text.empty()
|
| dom-2 | error | PlanDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | PlanDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource |
contained.where(('#'+id in %resource.descendants().reference).not()).empty()
|
| dom-4 | error | PlanDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from PlanDefinition
Summary
Extensions
This structure refers to these extensions:
Maturity: 0
Key Elements View
| Path | Status | Usage | ValueSet | Version | Source |
| PlanDefinition.status | Base | required | PublicationStatus | 📍3.0.2 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-1 | error | PlanDefinition | If the resource is contained in another resource, it SHALL NOT contain any narrative |
contained.text.empty()
|
| dom-2 | error | PlanDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | PlanDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource |
contained.where(('#'+id in %resource.descendants().reference).not()).empty()
|
| dom-4 | error | PlanDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from PlanDefinition
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| PlanDefinition |
0..* | PlanDefinition | The definition of a plan for a series of actions, independent of any specific patient or context | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: Common Languages (extensible): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:versionAlgorithm |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm]] | R5: How to compare versions (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm | |||||
| extension:subtitle |
0..1 | string | R5: Subordinate title of the plan definition (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.subtitle | |||||
| extension:subject |
0..1 | CodeableConcept, Reference(Cross-version Profile for R5.Group for use in FHIR STU3(0.1.0) | Group | Cross-version Profile for R5.MedicinalProductDefinition for use in FHIR STU3(0.1.0) | Basic | Cross-version Profile for R5.SubstanceDefinition for use in FHIR STU3(0.1.0) | Basic | Cross-version Profile for R5.AdministrableProductDefinition for use in FHIR STU3(0.1.0) | Basic | Cross-version Profile for R5.ManufacturedItemDefinition for use in FHIR STU3(0.1.0) | Basic | Cross-version Profile for R5.PackagedProductDefinition for use in FHIR STU3(0.1.0) | Basic), uri | R5: Type of individual the plan definition is focused on (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.subject Binding: R5ParticipantResourceTypesForR3 (0.1.0) (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). | |||||
| extension:copyrightLabel |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel]] | R5: Copyright holder and year(s) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel | |||||
| extension:actor |
0..* | (Complex) | R5: Actors within the plan (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.actor | |||||
| extension:asNeeded |
0..1 | boolean, CodeableConcept | R5: Preconditions for service (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.asNeeded | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url |
Σ | 0..1 | uri | Logical URI to reference this plan definition (globally unique) | ||||
| identifier |
Σ | 0..* | Identifier | Additional identifier for the plan definition | ||||
| version |
Σ | 0..1 | string | Business version of the plan definition | ||||
| name |
Σ | 0..1 | string | Name for this plan definition (computer friendly) | ||||
| title |
Σ | 0..1 | string | Name for this plan definition (human friendly) | ||||
| type |
Σ | 0..1 | CodeableConcept | order-set | protocol | eca-rule Binding: PlanDefinitionType (extensible): The type of PlanDefinition | ||||
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of a Value Set or Concept Map. | ||||
| experimental |
?!Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
| date |
Σ | 0..1 | dateTime | Date this was last changed | ||||
| publisher |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| description |
Σ | 0..1 | markdown | Natural language description of the plan definition | ||||
| purpose |
0..1 | markdown | Why this plan definition is defined | |||||
| usage |
0..1 | string | Describes the clinical usage of the asset | |||||
| approvalDate |
0..1 | date | When the plan definition was approved by publisher | |||||
| lastReviewDate |
0..1 | date | When the plan definition was last reviewed | |||||
| effectivePeriod |
Σ | 0..1 | Period | When the plan definition is expected to be used | ||||
| useContext |
Σ | 0..* | UsageContext | Context the content is intended to support | ||||
| jurisdiction |
Σ | 0..* | CodeableConcept | Intended jurisdiction for plan definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use | ||||
| topic |
0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering | |||||
| contributor |
0..* | Contributor | A content contributor | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:author |
0..* | (Complex) | R5: Who authored the content additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.author | |||||
| extension:editor |
0..* | (Complex) | R5: Who edited the content additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.editor | |||||
| extension:reviewer |
0..* | (Complex) | R5: Who reviewed the content additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.reviewer | |||||
| extension:endorser |
0..* | (Complex) | R5: Who endorsed the content additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.endorser | |||||
| type |
Σ | 1..1 | code | author | editor | reviewer | endorser Binding: ContributorType (required): The type of contributor | ||||
| name |
Σ | 1..1 | string | Who contributed the content | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details of the contributor | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:contact |
0..* | (Complex) | R5: contact additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.contact | |||||
| name |
Σ | 0..1 | string | Name of an individual to contact | ||||
| telecom |
Σ | 0..* | ContactPoint | Contact details for individual or organization | ||||
| copyright |
0..1 | markdown | Use and/or publishing restrictions | |||||
| relatedArtifact |
0..* | RelatedArtifact | Related artifacts for the asset | |||||
| library |
0..* | Reference(Library) | Logic used by the plan definition | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:library |
0..* | uri | R5: library additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.library | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| goal |
0..* | BackboneElement | What the plan is trying to accomplish | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| category |
0..1 | CodeableConcept | E.g. Treatment, dietary, behavioral, etc Binding: GoalCategory (example): Example codes for grouping goals for filtering or presentation | |||||
| description |
1..1 | CodeableConcept | Code or text describing the goal Binding: SNOMED CT Clinical Findings (example): Describes goals that can be achieved | |||||
| priority |
0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: GoalPriority (preferred): Indicates the level of importance associated with reaching or sustaining a goal | |||||
| start |
0..1 | CodeableConcept | When goal pursuit begins Binding: GoalStartEvent (example): Identifies the types of events that might trigger the start of a goal | |||||
| addresses |
0..* | CodeableConcept | What does the goal address Binding: Condition/Problem/Diagnosis Codes (example): Identifies problems, conditions, issues, or concerns that goals may address | |||||
| documentation |
0..* | RelatedArtifact | Supporting documentation for the goal | |||||
| target |
0..* | BackboneElement | Target outcome for the goal | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:detail |
0..1 | string, boolean, integer, Ratio | R5: detail additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.goal.target.detail | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| measure |
0..1 | CodeableConcept | The parameter whose value is to be tracked Binding: LOINC Codes (example): Identifies types of parameters that can be tracked to determine goal achievement | |||||
| detail[x] |
0..1 | The target value to be achieved | ||||||
| detailQuantity |
Quantity | |||||||
| detailRange |
Range | |||||||
| detailCodeableConcept |
CodeableConcept | |||||||
| due |
0..1 | Duration | Reach goal within | |||||
| action |
0..* | BackboneElement | Action defined by the plan | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:linkId |
0..1 | string | R5: Unique id for the action in the PlanDefinition (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.linkId | |||||
| extension:priority |
0..1 | code | R5: routine | urgent | asap | stat (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.priority Binding: MedicationRequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |||||
| extension:subject |
0..1 | CodeableConcept, Reference(Cross-version Profile for R5.Group for use in FHIR STU3(0.1.0) | Group), uri | R5: Type of individual the action is focused on (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.subject Binding: R5ParticipantResourceTypesForR3 (0.1.0) (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). | |||||
| extension:timing |
0..1 | Age | R5: timing additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.timing | |||||
| extension:location |
0..1 | (Complex) | R5: Where it should happen (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.location | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| label |
0..1 | string | User-visible label for the action (e.g. 1. or A.) | |||||
| title |
0..1 | string | User-visible title | |||||
| description |
0..1 | string | Short description of the action | |||||
| textEquivalent |
0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system | |||||
| code |
0..* | CodeableConcept | Code representing the meaning of the action or sub-actions | |||||
| reason |
0..* | CodeableConcept | Why the action should be performed | |||||
| documentation |
0..* | RelatedArtifact | Supporting documentation for the intended performer of the action | |||||
| goalId |
0..* | id | What goals this action supports | |||||
| triggerDefinition |
0..* | TriggerDefinition | When the action should be triggered | |||||
| condition |
0..* | BackboneElement | Whether or not the action is applicable | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| kind |
1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions | |||||
| description |
0..1 | string | Natural language description of the condition | |||||
| language |
0..1 | string | Language of the expression | |||||
| expression |
0..1 | string | Boolean-valued expression | |||||
| input |
0..* | DataRequirement | Input data requirements | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:title |
0..1 | string | R5: User-visible title (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.input.title | |||||
| extension:requirement |
0..1 | (Complex) | R5: What data is provided (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.input.requirement | |||||
| extension:relatedData |
0..1 | id | R5: What data is provided (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.input.relatedData | |||||
| type |
Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): Either an abstract type, a resource or a data type. | ||||
| profile |
Σ | 0..* | uri | The profile of the required data | ||||
| mustSupport |
Σ | 0..* | string | Indicates that specific structure elements are referenced by the knowledge module | ||||
| codeFilter |
Σ | 0..* | Element | What codes are expected | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| path |
Σ | 1..1 | string | The code-valued attribute of the filter | ||||
| valueSet[x] |
Σ | 0..1 | Valueset for the filter | |||||
| valueSetString |
string | |||||||
| valueSetReference |
Reference(ValueSet) | |||||||
| valueCode |
Σ | 0..* | code | What code is expected | ||||
| valueCoding |
Σ | 0..* | Coding | What Coding is expected | ||||
| valueCodeableConcept |
Σ | 0..* | CodeableConcept | What CodeableConcept is expected | ||||
| dateFilter |
Σ | 0..* | Element | What dates/date ranges are expected | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| path |
Σ | 1..1 | string | The date-valued attribute of the filter | ||||
| value[x] |
Σ | 0..1 | The value of the filter, as a Period, DateTime, or Duration value | |||||
| valueDateTime |
dateTime | |||||||
| valuePeriod |
Period | |||||||
| valueDuration |
Duration | |||||||
| output |
0..* | DataRequirement | Output data definition | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:title |
0..1 | string | R5: User-visible title (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.output.title | |||||
| extension:requirement |
0..1 | (Complex) | R5: What data is provided (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.output.requirement | |||||
| extension:relatedData |
0..1 | string | R5: What data is provided (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.output.relatedData | |||||
| type |
Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): Either an abstract type, a resource or a data type. | ||||
| profile |
Σ | 0..* | uri | The profile of the required data | ||||
| mustSupport |
Σ | 0..* | string | Indicates that specific structure elements are referenced by the knowledge module | ||||
| codeFilter |
Σ | 0..* | Element | What codes are expected | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| path |
Σ | 1..1 | string | The code-valued attribute of the filter | ||||
| valueSet[x] |
Σ | 0..1 | Valueset for the filter | |||||
| valueSetString |
string | |||||||
| valueSetReference |
Reference(ValueSet) | |||||||
| valueCode |
Σ | 0..* | code | What code is expected | ||||
| valueCoding |
Σ | 0..* | Coding | What Coding is expected | ||||
| valueCodeableConcept |
Σ | 0..* | CodeableConcept | What CodeableConcept is expected | ||||
| dateFilter |
Σ | 0..* | Element | What dates/date ranges are expected | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| path |
Σ | 1..1 | string | The date-valued attribute of the filter | ||||
| value[x] |
Σ | 0..1 | The value of the filter, as a Period, DateTime, or Duration value | |||||
| valueDateTime |
dateTime | |||||||
| valuePeriod |
Period | |||||||
| valueDuration |
Duration | |||||||
| relatedAction |
0..* | BackboneElement | Relationship to another action | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| actionId |
1..1 | id | What action is this related to | |||||
| relationship |
1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions | |||||
| offset[x] |
0..1 | Time offset for the relationship | ||||||
| offsetDuration |
Duration | |||||||
| offsetRange |
Range | |||||||
| timing[x] |
0..1 | When the action should take place | ||||||
| timingDateTime |
dateTime | |||||||
| timingPeriod |
Period | |||||||
| timingDuration |
Duration | |||||||
| timingRange |
Range | |||||||
| timingTiming |
Timing | |||||||
| participant |
0..* | BackboneElement | Who should participate in the action | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:actorId |
0..1 | string | R5: What actor (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.participant.actorId | |||||
| extension:typeCanonical |
0..1 | uri | R5: Who or what can participate (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.participant.typeCanonical | |||||
| extension:typeReference |
0..1 | Reference(Cross-version Profile for R5.CareTeam for use in FHIR STU3(0.1.0) | CareTeam | Cross-version Profile for R5.Device for use in FHIR STU3(0.1.0) | Device | Cross-version Profile for R5.DeviceDefinition for use in FHIR STU3(0.1.0) | Basic | Cross-version Profile for R5.Endpoint for use in FHIR STU3(0.1.0) | Endpoint | Cross-version Profile for R5.Group for use in FHIR STU3(0.1.0) | Group | Cross-version Profile for R5.HealthcareService for use in FHIR STU3(0.1.0) | HealthcareService | Cross-version Profile for R5.Location for use in FHIR STU3(0.1.0) | Location | Cross-version Profile for R5.Organization for use in FHIR STU3(0.1.0) | Organization | Cross-version Profile for R5.Patient for use in FHIR STU3(0.1.0) | Patient | Cross-version Profile for R5.Practitioner for use in FHIR STU3(0.1.0) | Practitioner | Cross-version Profile for R5.PractitionerRole for use in FHIR STU3(0.1.0) | PractitionerRole | Cross-version Profile for R5.RelatedPerson for use in FHIR STU3(0.1.0) | RelatedPerson) | R5: Who or what can participate (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.participant.typeReference | |||||
| extension:function |
0..1 | CodeableConcept | R5: E.g. Author, Reviewer, Witness, etc (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.participant.function Binding: R5ActionParticipantFunctionForR3 (0.1.0) (example) | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| type |
1..1 | code | patient | practitioner | related-person Binding: ActionParticipantType (required): The type of participant for the action | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:type |
0..1 | code | R5: careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.participant.type Binding: R5ActionParticipantTypeForR3 (0.1.0) (required): The type of participant in the activity. | |||||
| value |
0..1 | code | Primitive value for code | |||||
| role |
0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent, etc Binding: ActionParticipantRole (example): Defines roles played by participants for the action | |||||
| type |
0..1 | Coding | create | update | remove | fire-event Binding: ActionType (required): The type of action to be performed | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:type |
0..1 | CodeableConcept | R5: type additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.type Binding: ActionType (extensible): The type of action to be performed. | |||||
| system |
Σ | 0..1 | uri | Identity of the terminology system | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| groupingBehavior |
0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group | |||||
| selectionBehavior |
0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group | |||||
| requiredBehavior |
0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines requiredness behavior for selecting an action or an action group | |||||
| precheckBehavior |
0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group | |||||
| cardinalityBehavior |
0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated | |||||
| definition |
0..1 | Reference(ActivityDefinition | PlanDefinition) | Description of the activity to be performed | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:definition |
0..1 | uri | R5: definition additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.definition | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| transform |
0..1 | Reference(StructureMap) | Transform to apply the template | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:transform |
0..1 | uri | R5: transform additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.transform | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| dynamicValue |
0..* | BackboneElement | Dynamic aspects of the definition | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| description |
0..1 | string | Natural language description of the dynamic value | |||||
| path |
0..1 | string | The path to the element to be set dynamically | |||||
| language |
0..1 | string | Language of the expression | |||||
| expression |
0..1 | string | An expression that provides the dynamic value for the customization | |||||
| action |
0..* | See action (PlanDefinition) | A sub-action | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| PlanDefinition.language | Base | extensible |
Common Languages
|
📍3.0.2 | tx.fhir.org |
| PlanDefinition.type | Base | extensible | PlanDefinitionType | 📍3.0.2 | FHIR Std. |
| PlanDefinition.status | Base | required | PublicationStatus | 📍3.0.2 | FHIR Std. |
| PlanDefinition.jurisdiction | Base | extensible | Jurisdiction ValueSet | 📍3.0.2 | FHIR Std. |
| PlanDefinition.topic | Base | example | DefinitionTopic | 📍3.0.2 | FHIR Std. |
| PlanDefinition.contributor.type | Base | required | ContributorType | 📍3.0.2 | FHIR Std. |
| PlanDefinition.goal.category | Base | example | GoalCategory | 📍3.0.2 | FHIR Std. |
| PlanDefinition.goal.description | Base | example | SNOMED CT Clinical Findings | 📍3.0.2 | FHIR Std. |
| PlanDefinition.goal.priority | Base | preferred | GoalPriority | 📍3.0.2 | FHIR Std. |
| PlanDefinition.goal.start | Base | example | GoalStartEvent | 📍3.0.2 | FHIR Std. |
| PlanDefinition.goal.addresses | Base | example | Condition/Problem/Diagnosis Codes | 📍3.0.2 | FHIR Std. |
| PlanDefinition.goal.target.measure | Base | example | LOINC Codes | 📍3.0.2 | FHIR Std. |
| PlanDefinition.action.condition.kind | Base | required | ActionConditionKind | 📍3.0.2 | FHIR Std. |
| PlanDefinition.action.input.type | Base | required | FHIRAllTypes | 📍3.0.2 | FHIR Std. |
| PlanDefinition.action.output.type | Base | required | FHIRAllTypes | 📍3.0.2 | FHIR Std. |
| PlanDefinition.action.relatedAction.relationship | Base | required | ActionRelationshipType | 📍3.0.2 | FHIR Std. |
| PlanDefinition.action.participant.type | Base | required |
ActionParticipantType
|
📍3.0.2 | tx.fhir.org |
| PlanDefinition.action.participant.role | Base | example | ActionParticipantRole | 📍3.0.2 | FHIR Std. |
| PlanDefinition.action.type | Base | required | ActionType | 📍3.0.2 | FHIR Std. |
| PlanDefinition.action.groupingBehavior | Base | required | ActionGroupingBehavior | 📍3.0.2 | FHIR Std. |
| PlanDefinition.action.selectionBehavior | Base | required | ActionSelectionBehavior | 📍3.0.2 | FHIR Std. |
| PlanDefinition.action.requiredBehavior | Base | required | ActionRequiredBehavior | 📍3.0.2 | FHIR Std. |
| PlanDefinition.action.precheckBehavior | Base | required | ActionPrecheckBehavior | 📍3.0.2 | FHIR Std. |
| PlanDefinition.action.cardinalityBehavior | Base | required | ActionCardinalityBehavior | 📍3.0.2 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-1 | error | PlanDefinition | If the resource is contained in another resource, it SHALL NOT contain any narrative |
contained.text.empty()
|
| dom-2 | error | PlanDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | PlanDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource |
contained.where(('#'+id in %resource.descendants().reference).not()).empty()
|
| dom-4 | error | PlanDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from PlanDefinition
Summary
Extensions
This structure refers to these extensions:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ FHIR Infrastructure. Package hl7.fhir.uv.xver-r5.r3#0.1.0 based on FHIR 3.0.2. Generated 2026-03-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change