This is the set of resources that conform to either of the profiles SoaPlanDefinition (http://hl7.org/fhir/uv/ebm/StructureDefinition/soa-plandefinition) and SoaPlanDefinition (http://hl7.org/fhir/uv/ebm/StructureDefinition/soa-plandefinition). E.g. what you have to deal with if you get resources conforming to one of them
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
PlanDefinition | C | 0..* | The definition of a plan for a series of actions, independent of any specific patient or context cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation pld-3: goalid should reference the id of a goal definition pld-4: targetId should reference the id of an action | |
meta | Σ | 0..1 | Meta | Metadata about the resource ele-1: All FHIR elements must have a @value or children |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
language | 0..1 | code | Language of the resource content Binding: ?? (required): IETF language tag for a human language ele-1: All FHIR elements must have a @value or children | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation ele-1: All FHIR elements must have a @value or children | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
url | ΣC | 0..1 | uri | Canonical identifier for this plan definition, represented as a URI (globally unique) cnl-1: URL should not contain | or # - these characters make processing canonical references problematic ele-1: All FHIR elements must have a @value or children |
identifier | Σ | 0..* | Identifier | Additional identifier for the plan definition ele-1: All FHIR elements must have a @value or children |
version | Σ | 0..1 | string | Business version of the plan definition ele-1: All FHIR elements must have a @value or children |
versionAlgorithm[x] | Σ | 0..1 | How to compare versions Binding: ?? (extensible) ele-1: All FHIR elements must have a @value or children | |
versionAlgorithmString | string | |||
versionAlgorithmCoding | Coding | |||
name | Σ | 0..1 | string | Name for this plan definition (computer friendly) ele-1: All FHIR elements must have a @value or children |
title | Σ | 0..1 | string | Name for this plan definition (human friendly) ele-1: All FHIR elements must have a @value or children |
subtitle | 0..1 | string | Subordinate title of the plan definition ele-1: All FHIR elements must have a @value or children | |
type | Σ | 0..1 | CodeableConcept | order-set | clinical-protocol | eca-rule | workflow-definition Binding: ?? (extensible): The type of PlanDefinition. ele-1: All FHIR elements must have a @value or children |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: ?? (required): The lifecycle status of an artifact. ele-1: All FHIR elements must have a @value or children |
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage ele-1: All FHIR elements must have a @value or children |
subject[x] | 0..1 | Type of individual the plan definition is focused on Binding: ?? (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). ele-1: All FHIR elements must have a @value or children | ||
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition) | |||
subjectCanonical | canonical(EvidenceVariable) | |||
date | Σ | 0..1 | dateTime | Date last changed ele-1: All FHIR elements must have a @value or children |
publisher | Σ | 0..1 | string | Name of the publisher/steward (organization or individual) ele-1: All FHIR elements must have a @value or children |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher ele-1: All FHIR elements must have a @value or children |
description | Σ | 0..1 | markdown | Natural language description of the plan definition ele-1: All FHIR elements must have a @value or children |
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support ele-1: All FHIR elements must have a @value or children |
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for plan definition (if applicable) Binding: ?? (extensible): Countries and regions within which this artifact is targeted for use. ele-1: All FHIR elements must have a @value or children |
purpose | 0..1 | markdown | Why this plan definition is defined ele-1: All FHIR elements must have a @value or children | |
usage | 0..1 | markdown | Describes the clinical usage of the plan ele-1: All FHIR elements must have a @value or children | |
copyright | 0..1 | markdown | Use and/or publishing restrictions ele-1: All FHIR elements must have a @value or children | |
copyrightLabel | 0..1 | string | Copyright holder and year(s) ele-1: All FHIR elements must have a @value or children | |
approvalDate | 0..1 | date | When the plan definition was approved by publisher ele-1: All FHIR elements must have a @value or children | |
lastReviewDate | 0..1 | date | When the plan definition was last reviewed by the publisher ele-1: All FHIR elements must have a @value or children | |
effectivePeriod | Σ | 0..1 | Period | When the plan definition is expected to be used ele-1: All FHIR elements must have a @value or children |
author | 0..* | ContactDetail | Who authored the content ele-1: All FHIR elements must have a @value or children | |
editor | 0..* | ContactDetail | Who edited the content ele-1: All FHIR elements must have a @value or children | |
reviewer | 0..* | ContactDetail | Who reviewed the content ele-1: All FHIR elements must have a @value or children | |
endorser | 0..* | ContactDetail | Who endorsed the content ele-1: All FHIR elements must have a @value or children | |
relatedArtifact | 0..* | RelatedArtifact | Additional documentation, citations ele-1: All FHIR elements must have a @value or children | |
library | 0..* | canonical(Library) | Logic used by the plan definition ele-1: All FHIR elements must have a @value or children | |
goal | 0..* | BackboneElement | What the plan is trying to accomplish ele-1: All FHIR elements must have a @value or children | |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
category | 0..1 | CodeableConcept | E.g. Treatment, dietary, behavioral Binding: ?? (example): Example codes for grouping goals for filtering or presentation. ele-1: All FHIR elements must have a @value or children | |
description | 1..1 | CodeableConcept | Code or text describing the goal Binding: ?? (example): Describes goals that can be achieved. ele-1: All FHIR elements must have a @value or children | |
priority | 0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: ?? (preferred): Indicates the level of importance associated with reaching or sustaining a goal. ele-1: All FHIR elements must have a @value or children | |
start | 0..1 | CodeableConcept | When goal pursuit begins Binding: ?? (example): Identifies the types of events that might trigger the start of a goal. ele-1: All FHIR elements must have a @value or children | |
addresses | 0..* | CodeableConcept | What does the goal address Binding: ?? (example): Identifies problems, conditions, issues, or concerns that goals may address. ele-1: All FHIR elements must have a @value or children | |
documentation | 0..* | RelatedArtifact | Supporting documentation for the goal ele-1: All FHIR elements must have a @value or children | |
target | 0..* | BackboneElement | Target outcome for the goal ele-1: All FHIR elements must have a @value or children | |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
measure | 0..1 | CodeableConcept | The parameter whose value is to be tracked Binding: ?? (example): Identifies types of parameters that can be tracked to determine goal achievement. ele-1: All FHIR elements must have a @value or children | |
detail[x] | 0..1 | The target value to be achieved ele-1: All FHIR elements must have a @value or children | ||
detailQuantity | Quantity | |||
detailRange | Range | |||
detailCodeableConcept | CodeableConcept | |||
detailString | string | |||
detailBoolean | boolean | |||
detailInteger | integer | |||
detailRatio | Ratio | |||
due | 0..1 | Duration | Reach goal within ele-1: All FHIR elements must have a @value or children | |
actor | 0..* | BackboneElement | Actors within the plan ele-1: All FHIR elements must have a @value or children | |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
title | 0..1 | string | User-visible title ele-1: All FHIR elements must have a @value or children | |
description | 0..1 | markdown | Describes the actor ele-1: All FHIR elements must have a @value or children | |
option | 1..* | BackboneElement | Who or what can be this actor ele-1: All FHIR elements must have a @value or children | |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
type | 0..1 | code | careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson Binding: ?? (required): The type of participant in the activity. ele-1: All FHIR elements must have a @value or children | |
typeCanonical | 0..1 | canonical(CapabilityStatement) | Who or what can participate ele-1: All FHIR elements must have a @value or children | |
typeReference | 0..1 | Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Who or what can participate ele-1: All FHIR elements must have a @value or children | |
role | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ?? (example) ele-1: All FHIR elements must have a @value or children | |
action | 0..* | BackboneElement | Action defined by the plan ele-1: All FHIR elements must have a @value or children | |
extension | 0..* | Extension | Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
linkId | 0..1 | string | Unique id for the action in the PlanDefinition ele-1: All FHIR elements must have a @value or children | |
prefix | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.) ele-1: All FHIR elements must have a @value or children | |
title | 0..1 | string | User-visible title ele-1: All FHIR elements must have a @value or children | |
description | 0..1 | markdown | Brief description of the action ele-1: All FHIR elements must have a @value or children | |
textEquivalent | 0..1 | markdown | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system ele-1: All FHIR elements must have a @value or children | |
priority | 0..1 | code | routine | urgent | asap | stat Binding: ?? (required): Identifies the level of importance to be assigned to actioning the request. ele-1: All FHIR elements must have a @value or children | |
code | 0..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: ?? (example): Provides examples of actions to be performed. ele-1: All FHIR elements must have a @value or children | |
reason | 0..* | CodeableConcept | Why the action should be performed Binding: ?? (example): Provides examples of reasons for actions to be performed. ele-1: All FHIR elements must have a @value or children | |
documentation | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action ele-1: All FHIR elements must have a @value or children | |
goalId | 0..* | id | What goals this action supports ele-1: All FHIR elements must have a @value or children | |
subject[x] | 0..1 | Type of individual the action is focused on Binding: ?? (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). ele-1: All FHIR elements must have a @value or children | ||
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(Group) | |||
subjectCanonical | canonical(Any) | |||
trigger | 0..* | TriggerDefinition | When the action should be triggered ele-1: All FHIR elements must have a @value or children | |
condition | 0..* | BackboneElement | Whether or not the action is applicable ele-1: All FHIR elements must have a @value or children | |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
kind | 1..1 | code | applicability | start | stop Binding: ?? (required): Defines the kinds of conditions that can appear on actions. ele-1: All FHIR elements must have a @value or children | |
expression | 0..1 | Expression | Boolean-valued expression ele-1: All FHIR elements must have a @value or children | |
input | C | 0..* | BackboneElement | Input data requirements ele-1: All FHIR elements must have a @value or children pld-0: Input data elements must have a requirement or a relatedData, but not both |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
title | 0..1 | string | User-visible title ele-1: All FHIR elements must have a @value or children | |
requirement | 0..1 | DataRequirement | What data is provided ele-1: All FHIR elements must have a @value or children | |
relatedData | 0..1 | id | What data is provided ele-1: All FHIR elements must have a @value or children | |
output | C | 0..* | BackboneElement | Output data definition ele-1: All FHIR elements must have a @value or children pld-1: Output data element must have a requirement or a relatedData, but not both |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
title | 0..1 | string | User-visible title ele-1: All FHIR elements must have a @value or children | |
requirement | 0..1 | DataRequirement | What data is provided ele-1: All FHIR elements must have a @value or children | |
relatedData | 0..1 | string | What data is provided ele-1: All FHIR elements must have a @value or children | |
relatedAction | 0..* | BackboneElement | Relationship to another action ele-1: All FHIR elements must have a @value or children | |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
targetId | 1..1 | id | What action is this related to ele-1: All FHIR elements must have a @value or children | |
relationship | 1..1 | code | before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end Binding: ?? (required): Defines the types of relationships between actions. ele-1: All FHIR elements must have a @value or children | |
endRelationship | 0..1 | code | before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end Binding: ?? (required): Defines the types of relationships between actions. ele-1: All FHIR elements must have a @value or children | |
offset[x] | 0..1 | Time offset for the relationship ele-1: All FHIR elements must have a @value or children | ||
offsetDuration | Duration | |||
offsetRange | Range | |||
timing[x] | 0..1 | When the action should take place ele-1: All FHIR elements must have a @value or children | ||
timingAge | Age | |||
timingDuration | Duration | |||
timingRange | Range | |||
timingTiming | Timing | |||
location | 0..1 | CodeableReference(Location) | Where it should happen ele-1: All FHIR elements must have a @value or children | |
participant | 0..* | BackboneElement | Who should participate in the action ele-1: All FHIR elements must have a @value or children | |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
actorId | 0..1 | string | What actor ele-1: All FHIR elements must have a @value or children | |
type | 0..1 | code | careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson Binding: ?? (required): The type of participant in the activity. ele-1: All FHIR elements must have a @value or children | |
typeCanonical | 0..1 | canonical(CapabilityStatement) | Who or what can participate ele-1: All FHIR elements must have a @value or children | |
typeReference | 0..1 | Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Who or what can participate ele-1: All FHIR elements must have a @value or children | |
role | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ?? (example): Defines roles played by participants for the action. ele-1: All FHIR elements must have a @value or children | |
function | 0..1 | CodeableConcept | E.g. Author, Reviewer, Witness, etc Binding: ?? (example) ele-1: All FHIR elements must have a @value or children | |
type | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ?? (extensible): The type of action to be performed. ele-1: All FHIR elements must have a @value or children | |
groupingBehavior | 0..1 | code | visual-group | logical-group | sentence-group Binding: ?? (required): Defines organization behavior of a group. ele-1: All FHIR elements must have a @value or children | |
selectionBehavior | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ?? (required): Defines selection behavior of a group. ele-1: All FHIR elements must have a @value or children | |
requiredBehavior | 0..1 | code | must | could | must-unless-documented Binding: ?? (required): Defines expectations around whether an action or action group is required. ele-1: All FHIR elements must have a @value or children | |
precheckBehavior | 0..1 | code | yes | no Binding: ?? (required): Defines selection frequency behavior for an action or group. ele-1: All FHIR elements must have a @value or children | |
cardinalityBehavior | 0..1 | code | single | multiple Binding: ?? (required): Defines behavior for an action or a group for how many times that item may be repeated. ele-1: All FHIR elements must have a @value or children | |
definition[x] | 0..1 | Description of the activity to be performed ele-1: All FHIR elements must have a @value or children | ||
definitionCanonical | canonical(ActivityDefinition | MessageDefinition | ObservationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition) | |||
definitionUri | uri | |||
transform | 0..1 | canonical(StructureMap) | Transform to apply the template ele-1: All FHIR elements must have a @value or children | |
dynamicValue | 0..* | BackboneElement | Dynamic aspects of the definition ele-1: All FHIR elements must have a @value or children | |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
path | 0..1 | string | The path to the element to be set dynamically ele-1: All FHIR elements must have a @value or children | |
expression | 0..1 | Expression | An expression that provides the dynamic value for the customization ele-1: All FHIR elements must have a @value or children | |
action | 0..* | A sub-action ele-1: All FHIR elements must have a @value or children | ||
asNeeded[x] | Σ | 0..1 | Preconditions for service Binding: ?? (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. ele-1: All FHIR elements must have a @value or children | |
asNeededBoolean | boolean | |||
asNeededCodeableConcept | CodeableConcept | |||
Documentation for this format |