Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
PlanDefinition | TU | DomainResource | The definition of a plan for a series of actions, independent of any specific patient or context
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation + Warning: goalid should reference the id of a goal definition + Warning: targetId should reference the id of an action Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: MetadataResource |
|
url | Σ C | 0..1 | uri | Canonical identifier for this plan definition, represented as a URI (globally unique)
+ Warning: URL should not contain | or # - these characters make processing canonical references problematic |
identifier | Σ | 0..* | Identifier | Additional identifier for the plan definition
|
version | Σ | 0..1 | string | Business version of the plan definition
|
versionAlgorithm[x] | Σ | 0..1 | How to compare versions
Binding: Version Algorithm ( Extensible) |
|
versionAlgorithmString | string | |||
versionAlgorithmCoding | Coding | |||
name | Σ C | 0..1 | string | Name for this plan definition (computer friendly)
|
title | Σ T | 0..1 | string | Name for this plan definition (human friendly)
|
subtitle | T | 0..1 | string | Subordinate title of the plan definition
|
type | Σ | 0..1 | CodeableConcept | order-set | clinical-protocol | eca-rule | workflow-definition
Binding: Plan Definition Type ( Extensible) |
status | ?! Σ | 1..1 | code | draft | active | retired | unknown
Binding: PublicationStatus ( Required) |
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage
|
subject[x] | 0..1 | Type of individual the plan definition is focused on
Binding: Participant Resource Types ( Extensible) |
||
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference( Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition) | |||
subjectCanonical | canonical( EvidenceVariable) | |||
date | Σ | 0..1 | dateTime | Date last changed
|
publisher | Σ T | 0..1 | string | Name of the publisher/steward (organization or individual)
|
contact | Σ | 0..* | ContactDetail | Contact details for the publisher
|
description | Σ T | 0..1 | markdown | Natural language description of the plan definition
|
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support
|
jurisdiction | Σ XD | 0..* | CodeableConcept | Intended jurisdiction for plan definition (if applicable)
Binding: Jurisdiction ValueSet ( Extensible) |
purpose | T | 0..1 | markdown | Why this plan definition is defined
|
usage | T | 0..1 | markdown | Describes the clinical usage of the plan
|
copyright | 0..1 | markdown | Use and/or publishing restrictions
|
|
copyrightLabel | T | 0..1 | string | Copyright holder and year(s)
|
approvalDate | 0..1 | date | When the plan definition was approved by publisher
|
|
lastReviewDate | 0..1 | date | When the plan definition was last reviewed by the publisher
|
|
effectivePeriod | Σ | 0..1 | Period | When the plan definition is expected to be used
|
topic | XD | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment
Binding: Definition Topic ( Example) |
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 | C | 0..* | BackboneElement | What the plan is trying to accomplish
|
category | 0..1 | CodeableConcept | E.g. Treatment, dietary, behavioral
Binding: Goal Category ( Example) |
|
description | 1..1 | CodeableConcept | Code or text describing the goal
Binding: SNOMED CT Clinical Findings ( Example) |
|
priority | 0..1 | CodeableConcept | high-priority | medium-priority | low-priority
Binding: Goal Priority ( Preferred) |
|
start | 0..1 | CodeableConcept | When goal pursuit begins
Binding: Goal Start Event ( Example) |
|
addresses | 0..* | CodeableConcept | What does the goal address
Binding: Condition/Problem/Diagnosis Codes ( Example) |
|
documentation | 0..* | RelatedArtifact | Supporting documentation for the goal
|
|
target | 0..* | BackboneElement | Target outcome for the goal
|
|
measure | 0..1 | CodeableConcept | The parameter whose value is to be tracked
Binding: LOINC Codes ( Example) |
|
detail[x] | 0..1 | The target value to be achieved
|
||
detailQuantity | Quantity | |||
detailRange | Range | |||
detailCodeableConcept | CodeableConcept | |||
detailString | string | |||
detailBoolean | boolean | |||
detailInteger | integer | |||
detailRatio | Ratio | |||
due | 0..1 | Duration | Reach goal within
|
|
actor | 0..* | BackboneElement | Actors within the plan
|
|
title | T | 0..1 | string | User-visible title
|
description | T | 0..1 | markdown | Describes the actor
|
option | 1..* | BackboneElement | Who or what can be this actor
|
|
type | 0..1 | code | careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Binding: Action Participant Type ( Required) |
|
typeCanonical | 0..1 | canonical( CapabilityStatement) | Who or what can participate
|
|
typeReference | 0..1 | Reference( CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Who or what can participate
|
|
role | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent
Binding: Action Participant Role ( Example) |
|
action | C | 0..* | BackboneElement | Action defined by the plan
|
linkId | 0..1 | string | Unique id for the action in the PlanDefinition
|
|
prefix | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.)
|
|
title | T | 0..1 | string | User-visible title
|
description | T | 0..1 | markdown | Brief description of the action
|
textEquivalent | T | 0..1 | markdown | 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) |
|
code | 0..1 | CodeableConcept | Code representing the meaning of the action or sub-actions
Binding: Action Code ( Example) |
|
reason | 0..* | CodeableConcept | Why the action should be performed
Binding: Action Reason Code ( Example) |
|
documentation | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action
|
|
goalId | C | 0..* | id | What goals this action supports
|
subject[x] | 0..1 | Type of individual the action is focused on
Binding: Participant Resource Types ( Extensible) |
||
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference( Group) | |||
subjectCanonical | canonical() | |||
trigger | 0..* | TriggerDefinition | When the action should be triggered
|
|
condition | 0..* | BackboneElement | Whether or not the action is applicable
|
|
kind | 1..1 | code | applicability | start | stop
Binding: Action Condition Kind ( Required) |
|
expression | 0..1 | Expression | Boolean-valued expression
|
|
input | C | 0..* | BackboneElement | Input data requirements
+ Rule: Input data elements must have a requirement or a relatedData, but not both |
title | T | 0..1 | string | User-visible title
|
requirement | C | 0..1 | DataRequirement | What data is provided
|
relatedData | C | 0..1 | id | What data is provided
|
output | C | 0..* | BackboneElement | Output data definition
+ Rule: Output data element must have a requirement or a relatedData, but not both |
title | T | 0..1 | string | User-visible title
|
requirement | C | 0..1 | DataRequirement | What data is provided
|
relatedData | C | 0..1 | string | What data is provided
|
relatedAction | C | 0..* | BackboneElement | Relationship to another action
|
targetId | C | 1..1 | id | What action is this related to
|
relationship | 1..1 | code | before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
Binding: Action Relationship Type ( Required) |
|
endRelationship | 0..1 | code | before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
Binding: Action Relationship Type ( Required) |
|
offset[x] | 0..1 | Time offset for the relationship
|
||
offsetDuration | Duration | |||
offsetRange | Range | |||
timing[x] | 0..1 | When the action should take place
|
||
timingAge | Age | |||
timingDuration | Duration | |||
timingRange | Range | |||
timingTiming | Timing | |||
location | 0..1 | CodeableReference( Location) | Where it should happen
|
|
participant | 0..* | BackboneElement | Who should participate in the action
|
|
actorId | 0..1 | string | What actor
|
|
type | 0..1 | code | careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Binding: Action Participant Type ( Required) |
|
typeCanonical | 0..1 | canonical( CapabilityStatement) | Who or what can participate
|
|
typeReference | 0..1 | Reference( CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Who or what can participate
|
|
role | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent
Binding: Action Participant Role ( Example) |
|
function | 0..1 | CodeableConcept | E.g. Author, Reviewer, Witness, etc
Binding: Action Participant Function ( Example) |
|
type | 0..1 | CodeableConcept | create | update | remove | fire-event
Binding: Action Type ( Extensible) |
|
groupingBehavior | 0..1 | code | visual-group | logical-group | sentence-group
Binding: Action Grouping Behavior ( Required) |
|
selectionBehavior | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more
Binding: Action Selection Behavior ( Required) |
|
requiredBehavior | 0..1 | code | must | could | must-unless-documented
Binding: Action Required Behavior ( Required) |
|
precheckBehavior | 0..1 | code | yes | no
Binding: Action Precheck Behavior ( Required) |
|
cardinalityBehavior | 0..1 | code | single | multiple
Binding: Action Cardinality Behavior ( Required) |
|
definition[x] | 0..1 | Description of the activity to be performed
|
||
definitionCanonical | canonical( ActivityDefinition | MessageDefinition | ObservationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition) | |||
definitionUri | uri | |||
transform | 0..1 | canonical( StructureMap) | Transform to apply the template
|
|
dynamicValue | 0..* | BackboneElement | Dynamic aspects of the definition
|
|
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 | A sub-action
|
|
asNeeded[x] | Σ | 0..1 | Preconditions for service
Binding: SNOMED CT Medication As Needed Reason Codes ( Example) |
|
asNeededBoolean | boolean | |||
asNeededCodeableConcept | CodeableConcept | |||
Documentation for this format |