Extensions for Using Data Elements from FHIR R5 in FHIR R4
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR R4
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR R4 - 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_R4 | ||
This cross-version profile allows R5 PlanDefinition content to be represented via FHIR R4 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 | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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()
|
| dom-5 | error | PlanDefinition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | PlanDefinition | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | PlanDefinition.implicitRules, PlanDefinition.extension, PlanDefinition.extension:versionAlgorithm, PlanDefinition.extension:subject, PlanDefinition.extension:copyrightLabel, PlanDefinition.extension:actor, PlanDefinition.extension:asNeeded, PlanDefinition.modifierExtension, PlanDefinition.status | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | PlanDefinition.extension, PlanDefinition.extension:versionAlgorithm, PlanDefinition.extension:subject, PlanDefinition.extension:copyrightLabel, PlanDefinition.extension:actor, PlanDefinition.extension:asNeeded, PlanDefinition.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| pdf-0 | warning | PlanDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
This structure is derived from PlanDefinition
| Name | Flags | Card. | Type | Description & Constraints Filter:   | ||||
|---|---|---|---|---|---|---|---|---|
  PlanDefinition |
C | 0..* | PlanDefinition(4.0.1) | The definition of a plan for a series of actions, independent of any specific patient or context Constraints: pdf-0 | ||||
  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: CommonLanguages  (preferred): 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 Constraints: ext-1 | |||||
   extension:versionAlgorithm |
0..1 | Coding | R5: How to compare versions (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: version-algorithm (??) (extensible) Constraints: ext-1 | |||||
| extension:subject |
0..1 | canonical(Cross-version Profile for R5.EvidenceVariable for use in FHIR R4(0.1.0) | EvidenceVariable) | R5: subject additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.subject Constraints: ext-1 | |||||
| extension:copyrightLabel |
0..1 | string | R5: Copyright holder and year(s) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel Constraints: ext-1 | |||||
| extension:actor |
0..* | (Complex) | R5: Actors within the plan (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.actor Constraints: ext-1 | |||||
 extension:asNeeded |
0..1 | boolean, CodeableConcept | R5: Preconditions for service (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.asNeeded Constraints: ext-1 | |||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| url |
Σ | 0..1 | uri | Canonical identifier for this plan definition, represented as a URI (globally unique) | ||||
| identifier |
Σ | 0..* | Identifier | Additional identifier for the plan definition | ||||
| version |
Σ | 0..1 | string | Business version of the plan definition | ||||
| name |
ΣC | 0..1 | string | Name for this plan definition (computer friendly) | ||||
| title |
Σ | 0..1 | string | Name for this plan definition (human friendly) | ||||
| subtitle |
0..1 | string | Subordinate title of the plan definition | |||||
| type |
Σ | 0..1 | CodeableConcept | order-set | clinical-protocol | eca-rule | workflow-definition Binding: PlanDefinitionType (extensible): The type of PlanDefinition. | ||||
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
 subject[x] |
0..1 | Type of individual the plan definition is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). | ||||||
 subject[x]All Types |
Content/Rules for all Types | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
 Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
 extension:alternateReference |
0..1 | Reference(Resource) | R5: subject additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| subjectCodeableConcept |
CodeableConcept | |||||||
  subjectReference |
Reference(Group) | |||||||
| date |
Σ | 0..1 | dateTime | Date last changed | ||||
| publisher |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description |
Σ | 0..1 | markdown | Natural language description of the plan definition | ||||
| useContext |
Σ | 0..* | UsageContext | The context that 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. | ||||
| purpose |
0..1 | markdown | Why this plan definition is defined | |||||
| usage |
0..1 | string | Describes the clinical usage of the plan | |||||
| copyright |
0..1 | markdown | Use and/or publishing restrictions | |||||
| 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 | ||||
| topic |
0..* | CodeableConcept | E.g. Education, Treatment, Assessment Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering. | |||||
| author |
0..* | ContactDetail | Who authored the content | |||||
| editor |
0..* | ContactDetail | Who edited the content | |||||
| reviewer |
0..* | ContactDetail | Who reviewed the content | |||||
| endorser |
0..* | ContactDetail | Who endorsed the content | |||||
| relatedArtifact |
0..* | RelatedArtifact | Additional documentation, citations | |||||
| library |
0..* | canonical(Library) | Logic used by the plan definition | |||||
| goal |
0..* | BackboneElement | What the plan is trying to accomplish | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| category |
0..1 | CodeableConcept | E.g. Treatment, dietary, behavioral Binding: GoalCategory (example): Example codes for grouping goals for filtering or presentation. | |||||
| description |
1..1 | CodeableConcept | Code or text describing the goal Binding: SNOMEDCTClinicalFindings (example): Describes goals that can be achieved. | |||||
| priority |
0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: GoalPriority (preferred): Indicates the level of importance associated with reaching or sustaining a goal. | |||||
| start |
0..1 | CodeableConcept | When goal pursuit begins Binding: GoalStartEvent (example): Identifies the types of events that might trigger the start of a goal. | |||||
| addresses |
0..* | CodeableConcept | What does the goal address Binding: Condition/Problem/DiagnosisCodes (example): Identifies problems, conditions, issues, or concerns that goals may address. | |||||
| documentation |
0..* | RelatedArtifact | Supporting documentation for the goal | |||||
 target |
0..* | BackboneElement | Target outcome for the goal | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| measure |
0..1 | CodeableConcept | The parameter whose value is to be tracked Binding: LOINCCodes (example): Identifies types of parameters that can be tracked to determine goal achievement. | |||||
| detail[x] |
0..1 | The target value to be achieved | ||||||
| detailQuantity |
Quantity | |||||||
| detailRange |
Range | |||||||
| detailCodeableConcept |
CodeableConcept | |||||||
| due |
0..1 | Duration | Reach goal within | |||||
| action |
0..* | BackboneElement | Action defined by the plan | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| 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 Constraints: ext-1 | |||||
| extension:subject |
0..1 | canonical() | R5: subject additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.subject Constraints: ext-1 | |||||
| extension:location |
0..1 | (Complex) | R5: Where it should happen (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.location Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| prefix |
0..1 | string | User-visible prefix for the action (e.g. 1. or A.) | |||||
| title |
0..1 | string | User-visible title | |||||
| description |
0..1 | string | Brief 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 | |||||
| priority |
0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |||||
| 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 | |||||
| subject[x] |
0..1 | Type of individual the action is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). | ||||||
| subjectCodeableConcept |
CodeableConcept | |||||||
| subjectReference |
Reference(Group) | |||||||
| trigger |
0..* | TriggerDefinition | When the action should be triggered | |||||
| condition |
0..* | BackboneElement | Whether or not the action is applicable | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| kind |
1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions. | |||||
| expression |
0..1 | Expression | Boolean-valued expression | |||||
| input |
0..* | DataRequirement | Input data requirements | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:title |
0..1 | string | R5: User-visible title (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.input.title Constraints: ext-1 | |||||
| extension:requirement |
0..1 | DataRequirement | R5: What data is provided (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.input.requirement Constraints: ext-1 | |||||
| extension:relatedData |
0..1 | id | R5: What data is provided (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.input.relatedData Constraints: ext-1 | |||||
| type |
Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types. | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | The profile of the required data | ||||
| subject[x] |
Σ | 0..1 | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: SubjectType (extensible): The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.). | |||||
| subjectCodeableConcept |
CodeableConcept | |||||||
| subjectReference |
Reference(Group) | |||||||
| mustSupport |
Σ | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module | ||||
| codeFilter |
ΣC | 0..* | Element | What codes are expected Constraints: drq-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| path |
Σ | 0..1 | string | A code-valued attribute to filter on | ||||
| searchParam |
Σ | 0..1 | string | A coded (token) parameter to search on | ||||
| valueSet |
Σ | 0..1 | canonical(ValueSet) | Valueset for the filter | ||||
| code |
Σ | 0..* | Coding | What code is expected | ||||
| dateFilter |
ΣC | 0..* | Element | What dates/date ranges are expected Constraints: drq-2 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| path |
Σ | 0..1 | string | A date-valued attribute to filter on | ||||
| searchParam |
Σ | 0..1 | string | A date valued parameter to search on | ||||
| value[x] |
Σ | 0..1 | The value of the filter, as a Period, DateTime, or Duration value | |||||
| valueDateTime |
dateTime | |||||||
| valuePeriod |
Period | |||||||
| valueDuration |
Duration | |||||||
| limit |
Σ | 0..1 | positiveInt | Number of results | ||||
| sort |
Σ | 0..* | Element | Order of the results | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| path |
Σ | 1..1 | string | The name of the attribute to perform the sort | ||||
| direction |
Σ | 1..1 | code | ascending | descending Binding: SortDirection (required): The possible sort directions, ascending or descending. | ||||
| output |
0..* | DataRequirement | Output data definition | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:title |
0..1 | string | R5: User-visible title (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.output.title Constraints: ext-1 | |||||
| extension:requirement |
0..1 | DataRequirement | R5: What data is provided (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.output.requirement Constraints: ext-1 | |||||
| extension:relatedData |
0..1 | string | R5: What data is provided (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.output.relatedData Constraints: ext-1 | |||||
| type |
Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types. | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | The profile of the required data | ||||
| subject[x] |
Σ | 0..1 | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: SubjectType (extensible): The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.). | |||||
| subjectCodeableConcept |
CodeableConcept | |||||||
| subjectReference |
Reference(Group) | |||||||
| mustSupport |
Σ | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module | ||||
| codeFilter |
ΣC | 0..* | Element | What codes are expected Constraints: drq-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| path |
Σ | 0..1 | string | A code-valued attribute to filter on | ||||
| searchParam |
Σ | 0..1 | string | A coded (token) parameter to search on | ||||
| valueSet |
Σ | 0..1 | canonical(ValueSet) | Valueset for the filter | ||||
| code |
Σ | 0..* | Coding | What code is expected | ||||
| dateFilter |
ΣC | 0..* | Element | What dates/date ranges are expected Constraints: drq-2 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| path |
Σ | 0..1 | string | A date-valued attribute to filter on | ||||
| searchParam |
Σ | 0..1 | string | A date valued parameter to search on | ||||
| value[x] |
Σ | 0..1 | The value of the filter, as a Period, DateTime, or Duration value | |||||
| valueDateTime |
dateTime | |||||||
| valuePeriod |
Period | |||||||
| valueDuration |
Duration | |||||||
| limit |
Σ | 0..1 | positiveInt | Number of results | ||||
| sort |
Σ | 0..* | Element | Order of the results | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| path |
Σ | 1..1 | string | The name of the attribute to perform the sort | ||||
| direction |
Σ | 1..1 | code | ascending | descending Binding: SortDirection (required): The possible sort directions, ascending or descending. | ||||
| relatedAction |
0..* | BackboneElement | Relationship to another action | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 | |||||||
| timingAge |
Age | |||||||
| timingPeriod |
Period | |||||||
| timingDuration |
Duration | |||||||
| timingRange |
Range | |||||||
| timingTiming |
Timing | |||||||
| participant |
0..* | BackboneElement | Who should participate in the action | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:actorId |
0..1 | string | R5: What actor (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.participant.actorId Constraints: ext-1 | |||||
| extension:typeCanonical |
0..1 | canonical(Cross-version Profile for R5.CapabilityStatement for use in FHIR R4(0.1.0) | CapabilityStatement) | R5: Who or what can participate (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.participant.typeCanonical Constraints: ext-1 | |||||
| extension:typeReference |
0..1 | Reference(Cross-version Profile for R5.CareTeam for use in FHIR R4(0.1.0) | CareTeam | Cross-version Profile for R5.Device for use in FHIR R4(0.1.0) | Device | Cross-version Profile for R5.DeviceDefinition for use in FHIR R4(0.1.0) | DeviceDefinition | Cross-version Profile for R5.Endpoint for use in FHIR R4(0.1.0) | Endpoint | Cross-version Profile for R5.Group for use in FHIR R4(0.1.0) | Group | Cross-version Profile for R5.HealthcareService for use in FHIR R4(0.1.0) | HealthcareService | Cross-version Profile for R5.Location for use in FHIR R4(0.1.0) | Location | Cross-version Profile for R5.Organization for use in FHIR R4(0.1.0) | Organization | Cross-version Profile for R5.Patient for use in FHIR R4(0.1.0) | Patient | Cross-version Profile for R5.Practitioner for use in FHIR R4(0.1.0) | Practitioner | Cross-version Profile for R5.PractitionerRole for use in FHIR R4(0.1.0) | PractitionerRole | Cross-version Profile for R5.RelatedPerson for use in FHIR R4(0.1.0) | RelatedPerson) | R5: Who or what can participate (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.participant.typeReference Constraints: ext-1 | |||||
| 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: R5ActionParticipantFunctionForR4 (0.1.0) (example) Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| type |
1..1 | code | patient | practitioner | related-person | device 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 Constraints: ext-1 | |||||
| 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: R5ActionParticipantTypeForR4 (0.1.0) (required): The type of participant in the activity. Constraints: ext-1 | |||||
| value |
0..1 | string | Primitive value for code | |||||
| role |
0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example): Defines roles played by participants for the action. | |||||
| type |
0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed. | |||||
| groupingBehavior |
0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group. | |||||
| selectionBehavior |
0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group. | |||||
| requiredBehavior |
0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required. | |||||
| precheckBehavior |
0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group. | |||||
| cardinalityBehavior |
0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated. | |||||
| definition[x] |
0..1 | Description of the activity to be performed | ||||||
| definitionCanonical |
canonical(ActivityDefinition | PlanDefinition | Questionnaire) | |||||||
| definitionUri |
uri | |||||||
| transform |
0..1 | canonical(StructureMap) | Transform to apply the template | |||||
| dynamicValue |
0..* | BackboneElement | Dynamic aspects of the definition | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| path |
0..1 | string | The path to the element to be set dynamically | |||||
| expression |
0..1 | Expression | An expression that provides the dynamic value for the customization | |||||
| action |
0..* | See action (PlanDefinition) | A sub-action | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| PlanDefinition.language | Base | preferred |
Common Languages
|
📍4.0.1 | tx.fhir.org |
| PlanDefinition.type | Base | extensible | PlanDefinitionType | 📍4.0.1 | FHIR Std. |
| PlanDefinition.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| PlanDefinition.subject[x] | Base | extensible | Subject type | 📍4.0.1 | FHIR Std. |
| PlanDefinition.jurisdiction | Base | extensible | Jurisdiction | 📍4.0.1 | FHIR Std. |
| PlanDefinition.topic | Base | example | DefinitionTopic | 📍4.0.1 | FHIR Std. |
| PlanDefinition.goal.category | Base | example | Goal category | 📍4.0.1 | FHIR Std. |
| PlanDefinition.goal.description | Base | example | SNOMED CT Clinical Findings | 📍4.0.1 | FHIR Std. |
| PlanDefinition.goal.priority | Base | preferred | Goal priority | 📍4.0.1 | FHIR Std. |
| PlanDefinition.goal.start | Base | example | Goal start event | 📍4.0.1 | FHIR Std. |
| PlanDefinition.goal.addresses | Base | example | Condition/Problem/Diagnosis Codes | 📍4.0.1 | FHIR Std. |
| PlanDefinition.goal.target.measure | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.subject[x] | Base | extensible | Subject type | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.input.type | Base | required | FHIRAllTypes | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.input.subject[x] | Base | extensible | Subject type | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.input.sort.direction | Base | required | SortDirection | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.output.type | Base | required | FHIRAllTypes | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.output.subject[x] | Base | extensible | Subject type | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.output.sort.direction | Base | required | SortDirection | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.participant.type | Base | required |
ActionParticipantType
|
📍4.0.1 | tx.fhir.org |
| PlanDefinition.action.participant.role | Base | example | Action participant role | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.type | Base | extensible | ActionType | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.groupingBehavior | Base | required | ActionGroupingBehavior | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.selectionBehavior | Base | required | ActionSelectionBehavior | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.requiredBehavior | Base | required | ActionRequiredBehavior | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.precheckBehavior | Base | required | ActionPrecheckBehavior | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.cardinalityBehavior | Base | required | ActionCardinalityBehavior | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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()
|
| dom-5 | error | PlanDefinition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | PlanDefinition | A resource should have narrative for robust management |
text.`div`.exists()
|
| drq-1 | error | PlanDefinition.action.input.codeFilter, PlanDefinition.action.output.codeFilter | Either a path or a searchParam must be provided, but not both |
path.exists() xor searchParam.exists()
|
| drq-2 | error | PlanDefinition.action.input.dateFilter, PlanDefinition.action.output.dateFilter | Either a path or a searchParam must be provided, but not both |
path.exists() xor searchParam.exists()
|
| ele-1 | error | PlanDefinition.meta, PlanDefinition.implicitRules, PlanDefinition.language, PlanDefinition.text, PlanDefinition.extension, PlanDefinition.extension:versionAlgorithm, PlanDefinition.extension:subject, PlanDefinition.extension:copyrightLabel, PlanDefinition.extension:actor, PlanDefinition.extension:asNeeded, PlanDefinition.modifierExtension, PlanDefinition.url, PlanDefinition.identifier, PlanDefinition.version, PlanDefinition.name, PlanDefinition.title, PlanDefinition.subtitle, PlanDefinition.type, PlanDefinition.status, PlanDefinition.experimental, PlanDefinition.subject[x], PlanDefinition.subject[x].extension, PlanDefinition.subject[x].extension:alternateReference, PlanDefinition.date, PlanDefinition.publisher, PlanDefinition.contact, PlanDefinition.description, PlanDefinition.useContext, PlanDefinition.jurisdiction, PlanDefinition.purpose, PlanDefinition.usage, PlanDefinition.copyright, 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.extension:detail, PlanDefinition.goal.target.modifierExtension, PlanDefinition.goal.target.measure, PlanDefinition.goal.target.detail[x], PlanDefinition.goal.target.due, PlanDefinition.action, PlanDefinition.action.extension, PlanDefinition.action.extension:linkId, PlanDefinition.action.extension:subject, PlanDefinition.action.extension:location, PlanDefinition.action.modifierExtension, 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.extension:title, PlanDefinition.action.input.extension:requirement, PlanDefinition.action.input.extension:relatedData, PlanDefinition.action.input.type, PlanDefinition.action.input.profile, PlanDefinition.action.input.subject[x], PlanDefinition.action.input.mustSupport, PlanDefinition.action.input.codeFilter, PlanDefinition.action.input.codeFilter.extension, PlanDefinition.action.input.codeFilter.path, PlanDefinition.action.input.codeFilter.searchParam, PlanDefinition.action.input.codeFilter.valueSet, PlanDefinition.action.input.codeFilter.code, PlanDefinition.action.input.dateFilter, PlanDefinition.action.input.dateFilter.extension, PlanDefinition.action.input.dateFilter.path, PlanDefinition.action.input.dateFilter.searchParam, PlanDefinition.action.input.dateFilter.value[x], PlanDefinition.action.input.limit, PlanDefinition.action.input.sort, PlanDefinition.action.input.sort.extension, PlanDefinition.action.input.sort.path, PlanDefinition.action.input.sort.direction, PlanDefinition.action.output, PlanDefinition.action.output.extension, PlanDefinition.action.output.extension:title, PlanDefinition.action.output.extension:requirement, PlanDefinition.action.output.extension:relatedData, PlanDefinition.action.output.type, PlanDefinition.action.output.profile, PlanDefinition.action.output.subject[x], PlanDefinition.action.output.mustSupport, PlanDefinition.action.output.codeFilter, PlanDefinition.action.output.codeFilter.extension, PlanDefinition.action.output.codeFilter.path, PlanDefinition.action.output.codeFilter.searchParam, PlanDefinition.action.output.codeFilter.valueSet, PlanDefinition.action.output.codeFilter.code, PlanDefinition.action.output.dateFilter, PlanDefinition.action.output.dateFilter.extension, PlanDefinition.action.output.dateFilter.path, PlanDefinition.action.output.dateFilter.searchParam, PlanDefinition.action.output.dateFilter.value[x], PlanDefinition.action.output.limit, PlanDefinition.action.output.sort, PlanDefinition.action.output.sort.extension, PlanDefinition.action.output.sort.path, PlanDefinition.action.output.sort.direction, PlanDefinition.action.relatedAction, PlanDefinition.action.relatedAction.extension, PlanDefinition.action.relatedAction.modifierExtension, PlanDefinition.action.relatedAction.actionId, PlanDefinition.action.relatedAction.relationship, PlanDefinition.action.relatedAction.offset[x], PlanDefinition.action.timing[x], PlanDefinition.action.participant, PlanDefinition.action.participant.extension, PlanDefinition.action.participant.extension:actorId, PlanDefinition.action.participant.extension:typeCanonical, PlanDefinition.action.participant.extension:typeReference, PlanDefinition.action.participant.extension:function, PlanDefinition.action.participant.modifierExtension, PlanDefinition.action.participant.type, PlanDefinition.action.participant.type.extension, PlanDefinition.action.participant.type.extension:type, PlanDefinition.action.participant.role, PlanDefinition.action.type, PlanDefinition.action.groupingBehavior, PlanDefinition.action.selectionBehavior, PlanDefinition.action.requiredBehavior, PlanDefinition.action.precheckBehavior, PlanDefinition.action.cardinalityBehavior, PlanDefinition.action.definition[x], 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 | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | PlanDefinition.extension, PlanDefinition.extension:versionAlgorithm, PlanDefinition.extension:subject, PlanDefinition.extension:copyrightLabel, PlanDefinition.extension:actor, PlanDefinition.extension:asNeeded, PlanDefinition.modifierExtension, PlanDefinition.subject[x].extension, PlanDefinition.subject[x].extension:alternateReference, PlanDefinition.goal.extension, PlanDefinition.goal.modifierExtension, PlanDefinition.goal.target.extension, PlanDefinition.goal.target.extension:detail, PlanDefinition.goal.target.modifierExtension, PlanDefinition.action.extension, PlanDefinition.action.extension:linkId, PlanDefinition.action.extension:subject, PlanDefinition.action.extension:location, PlanDefinition.action.modifierExtension, PlanDefinition.action.condition.extension, PlanDefinition.action.condition.modifierExtension, PlanDefinition.action.input.extension, PlanDefinition.action.input.extension:title, PlanDefinition.action.input.extension:requirement, PlanDefinition.action.input.extension:relatedData, PlanDefinition.action.input.codeFilter.extension, PlanDefinition.action.input.dateFilter.extension, PlanDefinition.action.input.sort.extension, PlanDefinition.action.output.extension, PlanDefinition.action.output.extension:title, PlanDefinition.action.output.extension:requirement, PlanDefinition.action.output.extension:relatedData, PlanDefinition.action.output.codeFilter.extension, PlanDefinition.action.output.dateFilter.extension, PlanDefinition.action.output.sort.extension, PlanDefinition.action.relatedAction.extension, PlanDefinition.action.relatedAction.modifierExtension, PlanDefinition.action.participant.extension, PlanDefinition.action.participant.extension:actorId, PlanDefinition.action.participant.extension:typeCanonical, PlanDefinition.action.participant.extension:typeReference, PlanDefinition.action.participant.extension:function, PlanDefinition.action.participant.modifierExtension, PlanDefinition.action.participant.type.extension, PlanDefinition.action.participant.type.extension:type, PlanDefinition.action.dynamicValue.extension, PlanDefinition.action.dynamicValue.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| pdf-0 | warning | PlanDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
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 | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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()
|
| dom-5 | error | PlanDefinition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | PlanDefinition | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | PlanDefinition.implicitRules, PlanDefinition.extension, PlanDefinition.extension:versionAlgorithm, PlanDefinition.extension:subject, PlanDefinition.extension:copyrightLabel, PlanDefinition.extension:actor, PlanDefinition.extension:asNeeded, PlanDefinition.modifierExtension, PlanDefinition.status | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | PlanDefinition.extension, PlanDefinition.extension:versionAlgorithm, PlanDefinition.extension:subject, PlanDefinition.extension:copyrightLabel, PlanDefinition.extension:actor, PlanDefinition.extension:asNeeded, PlanDefinition.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| pdf-0 | warning | PlanDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
Differential View
This structure is derived from PlanDefinition
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| PlanDefinition |
C | 0..* | PlanDefinition(4.0.1) | The definition of a plan for a series of actions, independent of any specific patient or context Constraints: pdf-0 | ||||
| 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: CommonLanguages (preferred): 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 Constraints: ext-1 | |||||
| extension:versionAlgorithm |
0..1 | Coding | R5: How to compare versions (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: version-algorithm (??) (extensible) Constraints: ext-1 | |||||
| extension:subject |
0..1 | canonical(Cross-version Profile for R5.EvidenceVariable for use in FHIR R4(0.1.0) | EvidenceVariable) | R5: subject additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.subject Constraints: ext-1 | |||||
| extension:copyrightLabel |
0..1 | string | R5: Copyright holder and year(s) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel Constraints: ext-1 | |||||
| extension:actor |
0..* | (Complex) | R5: Actors within the plan (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.actor Constraints: ext-1 | |||||
| extension:asNeeded |
0..1 | boolean, CodeableConcept | R5: Preconditions for service (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.asNeeded Constraints: ext-1 | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| url |
Σ | 0..1 | uri | Canonical identifier for this plan definition, represented as a URI (globally unique) | ||||
| identifier |
Σ | 0..* | Identifier | Additional identifier for the plan definition | ||||
| version |
Σ | 0..1 | string | Business version of the plan definition | ||||
| name |
ΣC | 0..1 | string | Name for this plan definition (computer friendly) | ||||
| title |
Σ | 0..1 | string | Name for this plan definition (human friendly) | ||||
| subtitle |
0..1 | string | Subordinate title of the plan definition | |||||
| type |
Σ | 0..1 | CodeableConcept | order-set | clinical-protocol | eca-rule | workflow-definition Binding: PlanDefinitionType (extensible): The type of PlanDefinition. | ||||
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
| subject[x] |
0..1 | Type of individual the plan definition is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). | ||||||
| subject[x]All Types |
Content/Rules for all Types | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:alternateReference |
0..1 | Reference(Resource) | R5: subject additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| subjectCodeableConcept |
CodeableConcept | |||||||
| subjectReference |
Reference(Group) | |||||||
| date |
Σ | 0..1 | dateTime | Date last changed | ||||
| publisher |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description |
Σ | 0..1 | markdown | Natural language description of the plan definition | ||||
| useContext |
Σ | 0..* | UsageContext | The context that 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. | ||||
| purpose |
0..1 | markdown | Why this plan definition is defined | |||||
| usage |
0..1 | string | Describes the clinical usage of the plan | |||||
| copyright |
0..1 | markdown | Use and/or publishing restrictions | |||||
| 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 | ||||
| topic |
0..* | CodeableConcept | E.g. Education, Treatment, Assessment Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering. | |||||
| author |
0..* | ContactDetail | Who authored the content | |||||
| editor |
0..* | ContactDetail | Who edited the content | |||||
| reviewer |
0..* | ContactDetail | Who reviewed the content | |||||
| endorser |
0..* | ContactDetail | Who endorsed the content | |||||
| relatedArtifact |
0..* | RelatedArtifact | Additional documentation, citations | |||||
| library |
0..* | canonical(Library) | Logic used by the plan definition | |||||
| goal |
0..* | BackboneElement | What the plan is trying to accomplish | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| category |
0..1 | CodeableConcept | E.g. Treatment, dietary, behavioral Binding: GoalCategory (example): Example codes for grouping goals for filtering or presentation. | |||||
| description |
1..1 | CodeableConcept | Code or text describing the goal Binding: SNOMEDCTClinicalFindings (example): Describes goals that can be achieved. | |||||
| priority |
0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: GoalPriority (preferred): Indicates the level of importance associated with reaching or sustaining a goal. | |||||
| start |
0..1 | CodeableConcept | When goal pursuit begins Binding: GoalStartEvent (example): Identifies the types of events that might trigger the start of a goal. | |||||
| addresses |
0..* | CodeableConcept | What does the goal address Binding: Condition/Problem/DiagnosisCodes (example): Identifies problems, conditions, issues, or concerns that goals may address. | |||||
| documentation |
0..* | RelatedArtifact | Supporting documentation for the goal | |||||
| target |
0..* | BackboneElement | Target outcome for the goal | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| measure |
0..1 | CodeableConcept | The parameter whose value is to be tracked Binding: LOINCCodes (example): Identifies types of parameters that can be tracked to determine goal achievement. | |||||
| detail[x] |
0..1 | The target value to be achieved | ||||||
| detailQuantity |
Quantity | |||||||
| detailRange |
Range | |||||||
| detailCodeableConcept |
CodeableConcept | |||||||
| due |
0..1 | Duration | Reach goal within | |||||
| action |
0..* | BackboneElement | Action defined by the plan | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| 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 Constraints: ext-1 | |||||
| extension:subject |
0..1 | canonical() | R5: subject additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.subject Constraints: ext-1 | |||||
| extension:location |
0..1 | (Complex) | R5: Where it should happen (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.location Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| prefix |
0..1 | string | User-visible prefix for the action (e.g. 1. or A.) | |||||
| title |
0..1 | string | User-visible title | |||||
| description |
0..1 | string | Brief 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 | |||||
| priority |
0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |||||
| 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 | |||||
| subject[x] |
0..1 | Type of individual the action is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). | ||||||
| subjectCodeableConcept |
CodeableConcept | |||||||
| subjectReference |
Reference(Group) | |||||||
| trigger |
0..* | TriggerDefinition | When the action should be triggered | |||||
| condition |
0..* | BackboneElement | Whether or not the action is applicable | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| kind |
1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions. | |||||
| expression |
0..1 | Expression | Boolean-valued expression | |||||
| input |
0..* | DataRequirement | Input data requirements | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:title |
0..1 | string | R5: User-visible title (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.input.title Constraints: ext-1 | |||||
| extension:requirement |
0..1 | DataRequirement | R5: What data is provided (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.input.requirement Constraints: ext-1 | |||||
| extension:relatedData |
0..1 | id | R5: What data is provided (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.input.relatedData Constraints: ext-1 | |||||
| type |
Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types. | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | The profile of the required data | ||||
| subject[x] |
Σ | 0..1 | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: SubjectType (extensible): The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.). | |||||
| subjectCodeableConcept |
CodeableConcept | |||||||
| subjectReference |
Reference(Group) | |||||||
| mustSupport |
Σ | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module | ||||
| codeFilter |
ΣC | 0..* | Element | What codes are expected Constraints: drq-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| path |
Σ | 0..1 | string | A code-valued attribute to filter on | ||||
| searchParam |
Σ | 0..1 | string | A coded (token) parameter to search on | ||||
| valueSet |
Σ | 0..1 | canonical(ValueSet) | Valueset for the filter | ||||
| code |
Σ | 0..* | Coding | What code is expected | ||||
| dateFilter |
ΣC | 0..* | Element | What dates/date ranges are expected Constraints: drq-2 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| path |
Σ | 0..1 | string | A date-valued attribute to filter on | ||||
| searchParam |
Σ | 0..1 | string | A date valued parameter to search on | ||||
| value[x] |
Σ | 0..1 | The value of the filter, as a Period, DateTime, or Duration value | |||||
| valueDateTime |
dateTime | |||||||
| valuePeriod |
Period | |||||||
| valueDuration |
Duration | |||||||
| limit |
Σ | 0..1 | positiveInt | Number of results | ||||
| sort |
Σ | 0..* | Element | Order of the results | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| path |
Σ | 1..1 | string | The name of the attribute to perform the sort | ||||
| direction |
Σ | 1..1 | code | ascending | descending Binding: SortDirection (required): The possible sort directions, ascending or descending. | ||||
| output |
0..* | DataRequirement | Output data definition | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:title |
0..1 | string | R5: User-visible title (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.output.title Constraints: ext-1 | |||||
| extension:requirement |
0..1 | DataRequirement | R5: What data is provided (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.output.requirement Constraints: ext-1 | |||||
| extension:relatedData |
0..1 | string | R5: What data is provided (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.output.relatedData Constraints: ext-1 | |||||
| type |
Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types. | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | The profile of the required data | ||||
| subject[x] |
Σ | 0..1 | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: SubjectType (extensible): The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.). | |||||
| subjectCodeableConcept |
CodeableConcept | |||||||
| subjectReference |
Reference(Group) | |||||||
| mustSupport |
Σ | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module | ||||
| codeFilter |
ΣC | 0..* | Element | What codes are expected Constraints: drq-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| path |
Σ | 0..1 | string | A code-valued attribute to filter on | ||||
| searchParam |
Σ | 0..1 | string | A coded (token) parameter to search on | ||||
| valueSet |
Σ | 0..1 | canonical(ValueSet) | Valueset for the filter | ||||
| code |
Σ | 0..* | Coding | What code is expected | ||||
| dateFilter |
ΣC | 0..* | Element | What dates/date ranges are expected Constraints: drq-2 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| path |
Σ | 0..1 | string | A date-valued attribute to filter on | ||||
| searchParam |
Σ | 0..1 | string | A date valued parameter to search on | ||||
| value[x] |
Σ | 0..1 | The value of the filter, as a Period, DateTime, or Duration value | |||||
| valueDateTime |
dateTime | |||||||
| valuePeriod |
Period | |||||||
| valueDuration |
Duration | |||||||
| limit |
Σ | 0..1 | positiveInt | Number of results | ||||
| sort |
Σ | 0..* | Element | Order of the results | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| path |
Σ | 1..1 | string | The name of the attribute to perform the sort | ||||
| direction |
Σ | 1..1 | code | ascending | descending Binding: SortDirection (required): The possible sort directions, ascending or descending. | ||||
| relatedAction |
0..* | BackboneElement | Relationship to another action | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 | |||||||
| timingAge |
Age | |||||||
| timingPeriod |
Period | |||||||
| timingDuration |
Duration | |||||||
| timingRange |
Range | |||||||
| timingTiming |
Timing | |||||||
| participant |
0..* | BackboneElement | Who should participate in the action | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:actorId |
0..1 | string | R5: What actor (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.participant.actorId Constraints: ext-1 | |||||
| extension:typeCanonical |
0..1 | canonical(Cross-version Profile for R5.CapabilityStatement for use in FHIR R4(0.1.0) | CapabilityStatement) | R5: Who or what can participate (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.participant.typeCanonical Constraints: ext-1 | |||||
| extension:typeReference |
0..1 | Reference(Cross-version Profile for R5.CareTeam for use in FHIR R4(0.1.0) | CareTeam | Cross-version Profile for R5.Device for use in FHIR R4(0.1.0) | Device | Cross-version Profile for R5.DeviceDefinition for use in FHIR R4(0.1.0) | DeviceDefinition | Cross-version Profile for R5.Endpoint for use in FHIR R4(0.1.0) | Endpoint | Cross-version Profile for R5.Group for use in FHIR R4(0.1.0) | Group | Cross-version Profile for R5.HealthcareService for use in FHIR R4(0.1.0) | HealthcareService | Cross-version Profile for R5.Location for use in FHIR R4(0.1.0) | Location | Cross-version Profile for R5.Organization for use in FHIR R4(0.1.0) | Organization | Cross-version Profile for R5.Patient for use in FHIR R4(0.1.0) | Patient | Cross-version Profile for R5.Practitioner for use in FHIR R4(0.1.0) | Practitioner | Cross-version Profile for R5.PractitionerRole for use in FHIR R4(0.1.0) | PractitionerRole | Cross-version Profile for R5.RelatedPerson for use in FHIR R4(0.1.0) | RelatedPerson) | R5: Who or what can participate (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PlanDefinition.action.participant.typeReference Constraints: ext-1 | |||||
| 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: R5ActionParticipantFunctionForR4 (0.1.0) (example) Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| type |
1..1 | code | patient | practitioner | related-person | device 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 Constraints: ext-1 | |||||
| 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: R5ActionParticipantTypeForR4 (0.1.0) (required): The type of participant in the activity. Constraints: ext-1 | |||||
| value |
0..1 | string | Primitive value for code | |||||
| role |
0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example): Defines roles played by participants for the action. | |||||
| type |
0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed. | |||||
| groupingBehavior |
0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group. | |||||
| selectionBehavior |
0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group. | |||||
| requiredBehavior |
0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required. | |||||
| precheckBehavior |
0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group. | |||||
| cardinalityBehavior |
0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated. | |||||
| definition[x] |
0..1 | Description of the activity to be performed | ||||||
| definitionCanonical |
canonical(ActivityDefinition | PlanDefinition | Questionnaire) | |||||||
| definitionUri |
uri | |||||||
| transform |
0..1 | canonical(StructureMap) | Transform to apply the template | |||||
| dynamicValue |
0..* | BackboneElement | Dynamic aspects of the definition | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| path |
0..1 | string | The path to the element to be set dynamically | |||||
| expression |
0..1 | Expression | An expression that provides the dynamic value for the customization | |||||
| action |
0..* | See action (PlanDefinition) | A sub-action | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| PlanDefinition.language | Base | preferred |
Common Languages
|
📍4.0.1 | tx.fhir.org |
| PlanDefinition.type | Base | extensible | PlanDefinitionType | 📍4.0.1 | FHIR Std. |
| PlanDefinition.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| PlanDefinition.subject[x] | Base | extensible | Subject type | 📍4.0.1 | FHIR Std. |
| PlanDefinition.jurisdiction | Base | extensible | Jurisdiction | 📍4.0.1 | FHIR Std. |
| PlanDefinition.topic | Base | example | DefinitionTopic | 📍4.0.1 | FHIR Std. |
| PlanDefinition.goal.category | Base | example | Goal category | 📍4.0.1 | FHIR Std. |
| PlanDefinition.goal.description | Base | example | SNOMED CT Clinical Findings | 📍4.0.1 | FHIR Std. |
| PlanDefinition.goal.priority | Base | preferred | Goal priority | 📍4.0.1 | FHIR Std. |
| PlanDefinition.goal.start | Base | example | Goal start event | 📍4.0.1 | FHIR Std. |
| PlanDefinition.goal.addresses | Base | example | Condition/Problem/Diagnosis Codes | 📍4.0.1 | FHIR Std. |
| PlanDefinition.goal.target.measure | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.subject[x] | Base | extensible | Subject type | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.input.type | Base | required | FHIRAllTypes | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.input.subject[x] | Base | extensible | Subject type | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.input.sort.direction | Base | required | SortDirection | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.output.type | Base | required | FHIRAllTypes | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.output.subject[x] | Base | extensible | Subject type | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.output.sort.direction | Base | required | SortDirection | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.participant.type | Base | required |
ActionParticipantType
|
📍4.0.1 | tx.fhir.org |
| PlanDefinition.action.participant.role | Base | example | Action participant role | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.type | Base | extensible | ActionType | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.groupingBehavior | Base | required | ActionGroupingBehavior | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.selectionBehavior | Base | required | ActionSelectionBehavior | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.requiredBehavior | Base | required | ActionRequiredBehavior | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.precheckBehavior | Base | required | ActionPrecheckBehavior | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.cardinalityBehavior | Base | required | ActionCardinalityBehavior | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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()
|
| dom-5 | error | PlanDefinition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | PlanDefinition | A resource should have narrative for robust management |
text.`div`.exists()
|
| drq-1 | error | PlanDefinition.action.input.codeFilter, PlanDefinition.action.output.codeFilter | Either a path or a searchParam must be provided, but not both |
path.exists() xor searchParam.exists()
|
| drq-2 | error | PlanDefinition.action.input.dateFilter, PlanDefinition.action.output.dateFilter | Either a path or a searchParam must be provided, but not both |
path.exists() xor searchParam.exists()
|
| ele-1 | error | PlanDefinition.meta, PlanDefinition.implicitRules, PlanDefinition.language, PlanDefinition.text, PlanDefinition.extension, PlanDefinition.extension:versionAlgorithm, PlanDefinition.extension:subject, PlanDefinition.extension:copyrightLabel, PlanDefinition.extension:actor, PlanDefinition.extension:asNeeded, PlanDefinition.modifierExtension, PlanDefinition.url, PlanDefinition.identifier, PlanDefinition.version, PlanDefinition.name, PlanDefinition.title, PlanDefinition.subtitle, PlanDefinition.type, PlanDefinition.status, PlanDefinition.experimental, PlanDefinition.subject[x], PlanDefinition.subject[x].extension, PlanDefinition.subject[x].extension:alternateReference, PlanDefinition.date, PlanDefinition.publisher, PlanDefinition.contact, PlanDefinition.description, PlanDefinition.useContext, PlanDefinition.jurisdiction, PlanDefinition.purpose, PlanDefinition.usage, PlanDefinition.copyright, 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.extension:detail, PlanDefinition.goal.target.modifierExtension, PlanDefinition.goal.target.measure, PlanDefinition.goal.target.detail[x], PlanDefinition.goal.target.due, PlanDefinition.action, PlanDefinition.action.extension, PlanDefinition.action.extension:linkId, PlanDefinition.action.extension:subject, PlanDefinition.action.extension:location, PlanDefinition.action.modifierExtension, 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.extension:title, PlanDefinition.action.input.extension:requirement, PlanDefinition.action.input.extension:relatedData, PlanDefinition.action.input.type, PlanDefinition.action.input.profile, PlanDefinition.action.input.subject[x], PlanDefinition.action.input.mustSupport, PlanDefinition.action.input.codeFilter, PlanDefinition.action.input.codeFilter.extension, PlanDefinition.action.input.codeFilter.path, PlanDefinition.action.input.codeFilter.searchParam, PlanDefinition.action.input.codeFilter.valueSet, PlanDefinition.action.input.codeFilter.code, PlanDefinition.action.input.dateFilter, PlanDefinition.action.input.dateFilter.extension, PlanDefinition.action.input.dateFilter.path, PlanDefinition.action.input.dateFilter.searchParam, PlanDefinition.action.input.dateFilter.value[x], PlanDefinition.action.input.limit, PlanDefinition.action.input.sort, PlanDefinition.action.input.sort.extension, PlanDefinition.action.input.sort.path, PlanDefinition.action.input.sort.direction, PlanDefinition.action.output, PlanDefinition.action.output.extension, PlanDefinition.action.output.extension:title, PlanDefinition.action.output.extension:requirement, PlanDefinition.action.output.extension:relatedData, PlanDefinition.action.output.type, PlanDefinition.action.output.profile, PlanDefinition.action.output.subject[x], PlanDefinition.action.output.mustSupport, PlanDefinition.action.output.codeFilter, PlanDefinition.action.output.codeFilter.extension, PlanDefinition.action.output.codeFilter.path, PlanDefinition.action.output.codeFilter.searchParam, PlanDefinition.action.output.codeFilter.valueSet, PlanDefinition.action.output.codeFilter.code, PlanDefinition.action.output.dateFilter, PlanDefinition.action.output.dateFilter.extension, PlanDefinition.action.output.dateFilter.path, PlanDefinition.action.output.dateFilter.searchParam, PlanDefinition.action.output.dateFilter.value[x], PlanDefinition.action.output.limit, PlanDefinition.action.output.sort, PlanDefinition.action.output.sort.extension, PlanDefinition.action.output.sort.path, PlanDefinition.action.output.sort.direction, PlanDefinition.action.relatedAction, PlanDefinition.action.relatedAction.extension, PlanDefinition.action.relatedAction.modifierExtension, PlanDefinition.action.relatedAction.actionId, PlanDefinition.action.relatedAction.relationship, PlanDefinition.action.relatedAction.offset[x], PlanDefinition.action.timing[x], PlanDefinition.action.participant, PlanDefinition.action.participant.extension, PlanDefinition.action.participant.extension:actorId, PlanDefinition.action.participant.extension:typeCanonical, PlanDefinition.action.participant.extension:typeReference, PlanDefinition.action.participant.extension:function, PlanDefinition.action.participant.modifierExtension, PlanDefinition.action.participant.type, PlanDefinition.action.participant.type.extension, PlanDefinition.action.participant.type.extension:type, PlanDefinition.action.participant.role, PlanDefinition.action.type, PlanDefinition.action.groupingBehavior, PlanDefinition.action.selectionBehavior, PlanDefinition.action.requiredBehavior, PlanDefinition.action.precheckBehavior, PlanDefinition.action.cardinalityBehavior, PlanDefinition.action.definition[x], 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 | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | PlanDefinition.extension, PlanDefinition.extension:versionAlgorithm, PlanDefinition.extension:subject, PlanDefinition.extension:copyrightLabel, PlanDefinition.extension:actor, PlanDefinition.extension:asNeeded, PlanDefinition.modifierExtension, PlanDefinition.subject[x].extension, PlanDefinition.subject[x].extension:alternateReference, PlanDefinition.goal.extension, PlanDefinition.goal.modifierExtension, PlanDefinition.goal.target.extension, PlanDefinition.goal.target.extension:detail, PlanDefinition.goal.target.modifierExtension, PlanDefinition.action.extension, PlanDefinition.action.extension:linkId, PlanDefinition.action.extension:subject, PlanDefinition.action.extension:location, PlanDefinition.action.modifierExtension, PlanDefinition.action.condition.extension, PlanDefinition.action.condition.modifierExtension, PlanDefinition.action.input.extension, PlanDefinition.action.input.extension:title, PlanDefinition.action.input.extension:requirement, PlanDefinition.action.input.extension:relatedData, PlanDefinition.action.input.codeFilter.extension, PlanDefinition.action.input.dateFilter.extension, PlanDefinition.action.input.sort.extension, PlanDefinition.action.output.extension, PlanDefinition.action.output.extension:title, PlanDefinition.action.output.extension:requirement, PlanDefinition.action.output.extension:relatedData, PlanDefinition.action.output.codeFilter.extension, PlanDefinition.action.output.dateFilter.extension, PlanDefinition.action.output.sort.extension, PlanDefinition.action.relatedAction.extension, PlanDefinition.action.relatedAction.modifierExtension, PlanDefinition.action.participant.extension, PlanDefinition.action.participant.extension:actorId, PlanDefinition.action.participant.extension:typeCanonical, PlanDefinition.action.participant.extension:typeReference, PlanDefinition.action.participant.extension:function, PlanDefinition.action.participant.modifierExtension, PlanDefinition.action.participant.type.extension, PlanDefinition.action.participant.type.extension:type, PlanDefinition.action.dynamicValue.extension, PlanDefinition.action.dynamicValue.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| pdf-0 | warning | PlanDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
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.r4#0.1.0 based on FHIR 4.0.1. Generated 2026-03-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change
Slices for extension