Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.4 - release

Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.4) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Resource Profile: ManaakiNgaTahiPlanDefinition

Official URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/ManaakiNgaTahiPlanDefinition | Version: 0.1.3
Active as of 2025-12-11 | Computable Name: ManaakiNgaTahiPlanDefinition

PlanDefinition template which creates Manaaki Nga Tahi (Care in the Community) CarePlans

Usages:

- Examples for this Profile: COVIDMVPCarePlanTemplate
- CapabilityStatements using this Profile: Shared Care FHIR Server Capability Statement

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
PlanDefinition | C | 0..* | PlanDefinition | The definition of a plan for a series of actions, independent of any specific patient or context Constraints: pdf-0
identifier | Σ | 1..* | Identifier | Additional identifier for the plan definition
use | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: usual
value | Σ | 1..1 | string | The value that is unique Example General: 123456
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
subject[x] |  | 0..1 | CodeableConcept | 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.). Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/resource-types
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: Patient
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
PlanDefinition.identifier.use | required | Pattern Value: usual `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` From the FHIR Standard
PlanDefinition.status | required | PublicationStatus `http://hl7.org/fhir/ValueSet/publication-status|4.0.1` From the FHIR Standard
PlanDefinition.subject[x] | extensible | Pattern Value: Patient `http://hl7.org/fhir/ValueSet/subject-type` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
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: Bindings Constraints Obligations
--- | --- | --- | --- | ---
PlanDefinition |  | 0..* | PlanDefinition | The definition of a plan for a series of actions, independent of any specific patient or context
implicitRules |  | 0..0 |  |
contained |  | 0..0 |  |
modifierExtension |  | 0..0 |  |
identifier |  | 1..* | Identifier | Additional identifier for the plan definition
use |  | 1..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: usual
value |  | 1..1 | string | The value that is unique
subject[x] |  | 0..1 | CodeableConcept | Type of individual the plan definition is focused on Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/resource-types
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: Patient
useContext |  | 0..0 |  |
copyright |  | 0..0 |  |
approvalDate |  | 0..0 |  |
relatedArtifact |  | 0..0 |  |
library |  | 0..0 |  |
goal |  |  |  |
extension |  | 0..0 |  |
modifierExtension |  | 0..0 |  |
documentation |  | 0..0 |  |
target |  |  |  |
id |  | 0..0 |  |
extension |  | 0..0 |  |
modifierExtension |  | 0..0 |  |
action |  |  |  |
extension |  | 0..0 |  |
modifierExtension |  | 0..0 |  |
code |  | 0..0 |  |
reason |  | 0..0 |  |
documentation |  | 0..0 |  |
subject[x] |  | 0..1 | CodeableConcept | Type of individual the action is focused on
trigger |  | 0..0 |  |
condition |  | 0..0 |  |
input |  | 0..0 |  |
output |  | 0..0 |  |
relatedAction |  | 0..0 |  |
timing[x] |  | 0..0 |  |
participant |  | 0..0 |  |
groupingBehavior |  | 0..0 |  |
selectionBehavior |  | 0..0 |  |
definition[x] |  | 0..1 | canonical(ActivityDefinition | Questionnaire) | Description of the activity to be performed
transform |  | 0..0 |  |
dynamicValue |  | 0..0 |  |
action |  | 0..0 |  |
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
PlanDefinition | C | 0..* | PlanDefinition | 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
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
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
extension |  | 0..* | Extension | Additional content defined by implementations
url | Σ | 0..1 | uri | Canonical identifier for this plan definition, represented as a URI (globally unique)
identifier | Σ | 1..* | Identifier | Additional identifier for the plan definition
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: usual
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | Σ | 1..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
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 | CodeableConcept | 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.). Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/resource-types
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: Patient
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
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
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
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
goal |  | 0..* | BackboneElement | What the plan is trying to accomplish
id |  | 0..1 | string | Unique id for inter-element referencing
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.
target |  | 0..* | BackboneElement | Target outcome for the goal
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
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.
goalId |  | 0..* | id | What goals this action supports
subject[x] |  | 0..1 | CodeableConcept | 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.).
type |  | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed.
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 | canonical(ActivityDefinition | Questionnaire) | Description of the activity to be performed
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
PlanDefinition.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` From the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
PlanDefinition.identifier.use | required | Pattern Value: usual `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` From the FHIR Standard
PlanDefinition.identifier.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` From the FHIR Standard
PlanDefinition.type | extensible | PlanDefinitionType `http://hl7.org/fhir/ValueSet/plan-definition-type` From the FHIR Standard
PlanDefinition.status | required | PublicationStatus `http://hl7.org/fhir/ValueSet/publication-status|4.0.1` From the FHIR Standard
PlanDefinition.subject[x] | extensible | Pattern Value: Patient `http://hl7.org/fhir/ValueSet/subject-type` From the FHIR Standard
PlanDefinition.jurisdiction | extensible | Jurisdiction ValueSet `http://hl7.org/fhir/ValueSet/jurisdiction` From the FHIR Standard
PlanDefinition.topic | example | DefinitionTopic `http://hl7.org/fhir/ValueSet/definition-topic` From the FHIR Standard
PlanDefinition.goal.category | example | GoalCategory `http://hl7.org/fhir/ValueSet/goal-category` From the FHIR Standard
PlanDefinition.goal.description | example | SNOMEDCTClinicalFindings `http://hl7.org/fhir/ValueSet/clinical-findings` From the FHIR Standard
PlanDefinition.goal.priority | preferred | GoalPriority `http://hl7.org/fhir/ValueSet/goal-priority` From the FHIR Standard
PlanDefinition.goal.start | example | GoalStartEvent `http://hl7.org/fhir/ValueSet/goal-start-event` From the FHIR Standard
PlanDefinition.goal.addresses | example | Condition/Problem/DiagnosisCodes `http://hl7.org/fhir/ValueSet/condition-code` From the FHIR Standard
PlanDefinition.goal.target.measure | example | LOINCCodes(a valid code from LOINC) `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
PlanDefinition.action.priority | required | RequestPriority `http://hl7.org/fhir/ValueSet/request-priority|4.0.1` From the FHIR Standard
PlanDefinition.action.subject[x] | extensible | SubjectType `http://hl7.org/fhir/ValueSet/subject-type` From the FHIR Standard
PlanDefinition.action.condition.kind | required | ActionConditionKind `http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1` From the FHIR Standard
PlanDefinition.action.relatedAction.relationship | required | ActionRelationshipType `http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1` From the FHIR Standard
PlanDefinition.action.participant.type | required | ActionParticipantType `http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1` From the FHIR Standard
PlanDefinition.action.participant.role | example | ActionParticipantRole `http://hl7.org/fhir/ValueSet/action-participant-role` From the FHIR Standard
PlanDefinition.action.type | extensible | ActionType `http://hl7.org/fhir/ValueSet/action-type` From the FHIR Standard
PlanDefinition.action.requiredBehavior | required | ActionRequiredBehavior `http://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1` From the FHIR Standard
PlanDefinition.action.precheckBehavior | required | ActionPrecheckBehavior `http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1` From the FHIR Standard
PlanDefinition.action.cardinalityBehavior | required | ActionCardinalityBehavior `http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | 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

Mandatory: 3 elements
Prohibited: 31 elements

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
PlanDefinition | C | 0..* | PlanDefinition | The definition of a plan for a series of actions, independent of any specific patient or context Constraints: pdf-0
identifier | Σ | 1..* | Identifier | Additional identifier for the plan definition
use | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: usual
value | Σ | 1..1 | string | The value that is unique Example General: 123456
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
subject[x] |  | 0..1 | CodeableConcept | 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.). Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/resource-types
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: Patient
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
PlanDefinition.identifier.use | required | Pattern Value: usual `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` From the FHIR Standard
PlanDefinition.status | required | PublicationStatus `http://hl7.org/fhir/ValueSet/publication-status|4.0.1` From the FHIR Standard
PlanDefinition.subject[x] | extensible | Pattern Value: Patient `http://hl7.org/fhir/ValueSet/subject-type` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
PlanDefinition |  | 0..* | PlanDefinition | The definition of a plan for a series of actions, independent of any specific patient or context
implicitRules |  | 0..0 |  |
contained |  | 0..0 |  |
modifierExtension |  | 0..0 |  |
identifier |  | 1..* | Identifier | Additional identifier for the plan definition
use |  | 1..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: usual
value |  | 1..1 | string | The value that is unique
subject[x] |  | 0..1 | CodeableConcept | Type of individual the plan definition is focused on Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/resource-types
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: Patient
useContext |  | 0..0 |  |
copyright |  | 0..0 |  |
approvalDate |  | 0..0 |  |
relatedArtifact |  | 0..0 |  |
library |  | 0..0 |  |
goal |  |  |  |
extension |  | 0..0 |  |
modifierExtension |  | 0..0 |  |
documentation |  | 0..0 |  |
target |  |  |  |
id |  | 0..0 |  |
extension |  | 0..0 |  |
modifierExtension |  | 0..0 |  |
action |  |  |  |
extension |  | 0..0 |  |
modifierExtension |  | 0..0 |  |
code |  | 0..0 |  |
reason |  | 0..0 |  |
documentation |  | 0..0 |  |
subject[x] |  | 0..1 | CodeableConcept | Type of individual the action is focused on
trigger |  | 0..0 |  |
condition |  | 0..0 |  |
input |  | 0..0 |  |
output |  | 0..0 |  |
relatedAction |  | 0..0 |  |
timing[x] |  | 0..0 |  |
participant |  | 0..0 |  |
groupingBehavior |  | 0..0 |  |
selectionBehavior |  | 0..0 |  |
definition[x] |  | 0..1 | canonical(ActivityDefinition | Questionnaire) | Description of the activity to be performed
transform |  | 0..0 |  |
dynamicValue |  | 0..0 |  |
action |  | 0..0 |  |
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
PlanDefinition | C | 0..* | PlanDefinition | 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
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
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
extension |  | 0..* | Extension | Additional content defined by implementations
url | Σ | 0..1 | uri | Canonical identifier for this plan definition, represented as a URI (globally unique)
identifier | Σ | 1..* | Identifier | Additional identifier for the plan definition
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: usual
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | Σ | 1..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
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 | CodeableConcept | 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.). Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/resource-types
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: Patient
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
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
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
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
goal |  | 0..* | BackboneElement | What the plan is trying to accomplish
id |  | 0..1 | string | Unique id for inter-element referencing
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.
target |  | 0..* | BackboneElement | Target outcome for the goal
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
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.
goalId |  | 0..* | id | What goals this action supports
subject[x] |  | 0..1 | CodeableConcept | 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.).
type |  | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed.
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 | canonical(ActivityDefinition | Questionnaire) | Description of the activity to be performed
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
PlanDefinition.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` From the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
PlanDefinition.identifier.use | required | Pattern Value: usual `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` From the FHIR Standard
PlanDefinition.identifier.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` From the FHIR Standard
PlanDefinition.type | extensible | PlanDefinitionType `http://hl7.org/fhir/ValueSet/plan-definition-type` From the FHIR Standard
PlanDefinition.status | required | PublicationStatus `http://hl7.org/fhir/ValueSet/publication-status|4.0.1` From the FHIR Standard
PlanDefinition.subject[x] | extensible | Pattern Value: Patient `http://hl7.org/fhir/ValueSet/subject-type` From the FHIR Standard
PlanDefinition.jurisdiction | extensible | Jurisdiction ValueSet `http://hl7.org/fhir/ValueSet/jurisdiction` From the FHIR Standard
PlanDefinition.topic | example | DefinitionTopic `http://hl7.org/fhir/ValueSet/definition-topic` From the FHIR Standard
PlanDefinition.goal.category | example | GoalCategory `http://hl7.org/fhir/ValueSet/goal-category` From the FHIR Standard
PlanDefinition.goal.description | example | SNOMEDCTClinicalFindings `http://hl7.org/fhir/ValueSet/clinical-findings` From the FHIR Standard
PlanDefinition.goal.priority | preferred | GoalPriority `http://hl7.org/fhir/ValueSet/goal-priority` From the FHIR Standard
PlanDefinition.goal.start | example | GoalStartEvent `http://hl7.org/fhir/ValueSet/goal-start-event` From the FHIR Standard
PlanDefinition.goal.addresses | example | Condition/Problem/DiagnosisCodes `http://hl7.org/fhir/ValueSet/condition-code` From the FHIR Standard
PlanDefinition.goal.target.measure | example | LOINCCodes(a valid code from LOINC) `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
PlanDefinition.action.priority | required | RequestPriority `http://hl7.org/fhir/ValueSet/request-priority|4.0.1` From the FHIR Standard
PlanDefinition.action.subject[x] | extensible | SubjectType `http://hl7.org/fhir/ValueSet/subject-type` From the FHIR Standard
PlanDefinition.action.condition.kind | required | ActionConditionKind `http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1` From the FHIR Standard
PlanDefinition.action.relatedAction.relationship | required | ActionRelationshipType `http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1` From the FHIR Standard
PlanDefinition.action.participant.type | required | ActionParticipantType `http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1` From the FHIR Standard
PlanDefinition.action.participant.role | example | ActionParticipantRole `http://hl7.org/fhir/ValueSet/action-participant-role` From the FHIR Standard
PlanDefinition.action.type | extensible | ActionType `http://hl7.org/fhir/ValueSet/action-type` From the FHIR Standard
PlanDefinition.action.requiredBehavior | required | ActionRequiredBehavior `http://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1` From the FHIR Standard
PlanDefinition.action.precheckBehavior | required | ActionPrecheckBehavior `http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1` From the FHIR Standard
PlanDefinition.action.cardinalityBehavior | required | ActionCardinalityBehavior `http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | 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

Mandatory: 3 elements
Prohibited: 31 elements

Other representations of profile: CSV, Excel, Schematron