Introduction

This profile is used to represent Knowledge Artifacts in the MedMorph Reference Architecture IG. For a detailed overview of Knowledge Artifacts and how they are used, please refer to Provisioning Requirements.

Implementation Requirements

Implementers are advised to read Provisioning Requirements to implement the PlanDefinition profile.

API : Creation of PlanDefinition Resource Instance:

The PlanDefinition instance is created using the regular POST API. The syntax is as shown below.

POST http://<FHIR Server URL>/PlanDefinition

The body of the request will contain the JSON data of PlanDefinition to be used in creation.

API : Updation of PlanDefinition Resource Instance:

The PlanDefinition instance is updated using the regular PUT API. The syntax is as shown below.

POST http://<FHIR Server URL>/PlanDefinition/[Instance Id]

The body of the request will contain the JSON data of PlanDefinition to be used for updating the instance. The id of the PlanDefinition body should match the [Instance Id] in the request.

API : Retrieval of PlanDefinition Resource Instance:

The PlanDefinition instance is retrieved using the regular GET API. The syntax is as shown below.

GET http://<FHIR Server URL>/PlanDefinition/[Instance Id]

The instance corresponding to the [Instance Id] is returned.

API : Search of PlanDefinition Resource Instance:

The PlanDefinition instance can be searched using the regular GET API. The syntax for various searches are as shown below.

GET http://<FHIR Server URL>/PlanDefinition/?publisher=[publisher name]

GET http://<FHIR Server URL>/PlanDefinition/?name=[name of plan definition instance]

GET http://<FHIR Server URL>/PlanDefinition/?title=[title of plan definition instance ]

GET http://<FHIR Server URL>/PlanDefinition/?name=[name of plan definition instance ]&version=[version number]

The search results are returned back in a bundle.

• Text Summary
• Differential Table
• Snapshot Table
• Snapshot Table (Must Support)
• All

This structure is derived from Shareable PlanDefinition

Name	Flags	Card.	Type	Description & Constraints
PlanDefinition		1..1	Shareable PlanDefinition	MedMorph PlanDefinition
ext-receiverAddress	S	1..1	Reference(Endpoint)	Indicates the address where the report has to be sent. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-receiverAddress
ext-authorSignature	S	0..1	Signature	Indicates the signature of the author who created the PlanDefinition URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-authorSignature
ext-asyncIndicator	S	0..1	boolean	True indicates that the messages resulting from the PlanDefinition are expected to be processed asynchronously URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-asyncIndicator
ext-expectedResponseTime	S	0..1	Duration	Indicates the maximum time the sender has to wait to get a response, beyond which the message is assumed to have failed to reach the destination. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-expectedResponseTime
type	S	1..1	CodeableConcept	order-set | clinical-protocol | eca-rule | workflow-definition
subject[x]	S	0..1	CodeableConcept, Reference(Group)	Type of individual the plan definition is focused on
effectivePeriod	S	0..1	Period	When the plan definition is expected to be used
relatedArtifact	S	0..*	RelatedArtifact	Additional documentation, citations
library	S	0..*	canonical(Library)	Logic used by the plan definition
action	S	0..*	BackboneElement	Action defined by the plan
description	S	0..1	string	Brief description of the action
code	S	0..1	CodeableConcept	Code representing the meaning of the action or sub-actions Binding: US Public Health PlanDefinition Action (extensible): The set of actions that can be used to create plan definition
trigger	S	0..*	TriggerDefinition	When the action should be triggered
ext-us-ph-namedEventType	S	0..1	CodeableConcept	Indicates the types of named events to subscribe to from the EHR. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-us-ph-namedEventType Binding: US Public Health TriggerDefinition NamedEvent (extensible): The set of named events that can be used for subscriptions
type	S	1..1	code	named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Fixed Value: named-event
condition	S	0..*	BackboneElement	Whether or not the action is applicable
kind	S	1..1	code	applicability | start | stop
expression	S	0..1	Expression	Boolean-valued expression
input	S	0..*	DataRequirement	Input data requirements
type	S	1..1	code	The type of the required data
output	S	0..*	DataRequirement	Output data definition
type	S	1..1	code	The type of the required data
relatedAction	S	0..*	BackboneElement	Relationship to another action
actionId	S	1..1	id	What action is this related to
relationship	S	1..1	code	before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
offsetDuration	S	0..1	Duration	Time offset for the relationship
timing[x]	S	0..1	Duration	When the action should take place
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
PlanDefinition	I	1..1	Shareable PlanDefinition	MedMorph PlanDefinition
id	Σ	0..1	string	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) Max Binding: AllLanguages: A human language.
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
ext-receiverAddress	S	1..1	Reference(Endpoint)	Indicates the address where the report has to be sent. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-receiverAddress
ext-authorSignature	S	0..1	Signature	Indicates the signature of the author who created the PlanDefinition URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-authorSignature
ext-asyncIndicator	S	0..1	boolean	True indicates that the messages resulting from the PlanDefinition are expected to be processed asynchronously URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-asyncIndicator
ext-expectedResponseTime	S	0..1	Duration	Indicates the maximum time the sender has to wait to get a response, beyond which the message is assumed to have failed to reach the destination. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-expectedResponseTime
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
url	Σ	1..1	uri	Canonical identifier for this plan definition, represented as a URI (globally unique)
identifier	SΣ	0..*	Identifier	Additional identifier for the plan definition
version	Σ	1..1	string	Business version of the plan definition
name	ΣI	1..1	string	Name for this plan definition (computer friendly)
title	SΣ	0..1	string	Name for this plan definition (human friendly)
subtitle		0..1	string	Subordinate title of the plan definition
type	SΣ	1..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	Σ	1..1	boolean	For testing purposes, not real usage
subject[x]	S	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.).
subjectCodeableConcept			CodeableConcept
subjectReference			Reference(Group)
date	SΣ	0..1	dateTime	Date last changed
publisher	Σ	1..1	string	Name of the publisher (organization or individual)
contact	SΣ	0..*	ContactDetail	Contact details for the publisher
description	Σ	1..1	markdown	Natural language description of the plan definition
useContext	SΣ	0..*	UsageContext	The context that the content is intended to support
jurisdiction	SΣ	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	SΣ	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	S	0..*	RelatedArtifact	Additional documentation, citations
library	S	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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
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
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
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	S	0..*	BackboneElement	Action defined by the plan
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
prefix		0..1	string	User-visible prefix for the action (e.g. 1. or A.)
title		0..1	string	User-visible title
description	S	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	S	0..1	CodeableConcept	Code representing the meaning of the action or sub-actions Binding: US Public Health PlanDefinition Action (extensible): The set of actions that can be used to create plan definition
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	S	0..*	TriggerDefinition	When the action should be triggered
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
ext-us-ph-namedEventType	S	0..1	CodeableConcept	Indicates the types of named events to subscribe to from the EHR. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-us-ph-namedEventType Binding: US Public Health TriggerDefinition NamedEvent (extensible): The set of named events that can be used for subscriptions
type	SΣ	1..1	code	named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Binding: TriggerType (required): The type of trigger. Fixed Value: named-event
name	Σ	0..1	string	Name or URI that identifies the event
timing[x]	Σ	0..1		Timing of the event
timingTiming			Timing
timingReference			Reference(Schedule)
timingDate			date
timingDateTime			dateTime
data	Σ	0..*	DataRequirement	Triggering data of the event (multiple = 'and')
condition	Σ	0..1	Expression	Whether the event triggers (boolean expression)
condition	S	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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
kind	S	1..1	code	applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
expression	S	0..1	Expression	Boolean-valued expression
input	S	0..*	DataRequirement	Input data requirements
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
type	SΣ	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	ΣI	0..*	Element	What codes are expected drq-1: Either a path or a searchParam must be provided, but not both
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
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	ΣI	0..*	Element	What dates/date ranges are expected drq-2: Either a path or a searchParam must be provided, but not both
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
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
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
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	S	0..*	DataRequirement	Output data definition
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
type	SΣ	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	ΣI	0..*	Element	What codes are expected drq-1: Either a path or a searchParam must be provided, but not both
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
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	ΣI	0..*	Element	What dates/date ranges are expected drq-2: Either a path or a searchParam must be provided, but not both
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
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
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
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	S	0..*	BackboneElement	Relationship to another action
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
actionId	S	1..1	id	What action is this related to
relationship	S	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.
Slices for offset[x]		0..1	Duration	Time offset for the relationship Slice: Unordered, Closed by type:$this
offset[x]:offsetDuration	S	0..1	Duration	Time offset for the relationship
timing[x]	S	0..1	Duration	When the action should take place
participant		0..*	BackboneElement	Who should participate in the action
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		1..1	code	patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action.
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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
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

Name	Flags	Card.	Type	Description & Constraints
PlanDefinition	I	1..1	Shareable PlanDefinition	MedMorph PlanDefinition
ext-receiverAddress		1..1	Reference(Endpoint)	Indicates the address where the report has to be sent. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-receiverAddress
ext-authorSignature		0..1	Signature	Indicates the signature of the author who created the PlanDefinition URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-authorSignature
ext-asyncIndicator		0..1	boolean	True indicates that the messages resulting from the PlanDefinition are expected to be processed asynchronously URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-asyncIndicator
ext-expectedResponseTime		0..1	Duration	Indicates the maximum time the sender has to wait to get a response, beyond which the message is assumed to have failed to reach the destination. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-expectedResponseTime
identifier	Σ	0..*	Identifier	Additional identifier for the plan definition
title	Σ	0..1	string	Name for this plan definition (human friendly)
type	Σ	1..1	CodeableConcept	order-set | clinical-protocol | eca-rule | workflow-definition Binding: PlanDefinitionType (extensible): The type of PlanDefinition.
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.).
subjectCodeableConcept			CodeableConcept
subjectReference			Reference(Group)
date	Σ	0..1	dateTime	Date last changed
contact	Σ	0..*	ContactDetail	Contact details for the publisher
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.
effectivePeriod	Σ	0..1	Period	When the plan definition is expected to be used
relatedArtifact		0..*	RelatedArtifact	Additional documentation, citations
library		0..*	canonical(Library)	Logic used by the plan definition
action		0..*	BackboneElement	Action defined by the plan
description		0..1	string	Brief description of the action
code		0..1	CodeableConcept	Code representing the meaning of the action or sub-actions Binding: US Public Health PlanDefinition Action (extensible): The set of actions that can be used to create plan definition
trigger		0..*	TriggerDefinition	When the action should be triggered
ext-us-ph-namedEventType		0..1	CodeableConcept	Indicates the types of named events to subscribe to from the EHR. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-us-ph-namedEventType Binding: US Public Health TriggerDefinition NamedEvent (extensible): The set of named events that can be used for subscriptions
type	Σ	1..1	code	named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Binding: TriggerType (required): The type of trigger. Fixed Value: named-event
condition		0..*	BackboneElement	Whether or not the action is applicable
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
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.
output		0..*	DataRequirement	Output data definition
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.
relatedAction		0..*	BackboneElement	Relationship to another action
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]:offsetDuration		0..1	Duration	Time offset for the relationship
timing[x]		0..1	Duration	When the action should take place
Documentation for this format

This structure is derived from Shareable PlanDefinition

Summary

Mandatory: 2 elements (6 nested mandatory elements)
Must-Support: 27 elements
Fixed Value: 1 element

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-receiverAddress
• http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-authorSignature
• http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-asyncIndicator
• http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-expectedResponseTime
• http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-us-ph-namedEventType

Differential View

This structure is derived from Shareable PlanDefinition

Name	Flags	Card.	Type	Description & Constraints
PlanDefinition		1..1	Shareable PlanDefinition	MedMorph PlanDefinition
ext-receiverAddress	S	1..1	Reference(Endpoint)	Indicates the address where the report has to be sent. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-receiverAddress
ext-authorSignature	S	0..1	Signature	Indicates the signature of the author who created the PlanDefinition URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-authorSignature
ext-asyncIndicator	S	0..1	boolean	True indicates that the messages resulting from the PlanDefinition are expected to be processed asynchronously URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-asyncIndicator
ext-expectedResponseTime	S	0..1	Duration	Indicates the maximum time the sender has to wait to get a response, beyond which the message is assumed to have failed to reach the destination. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-expectedResponseTime
type	S	1..1	CodeableConcept	order-set | clinical-protocol | eca-rule | workflow-definition
subject[x]	S	0..1	CodeableConcept, Reference(Group)	Type of individual the plan definition is focused on
effectivePeriod	S	0..1	Period	When the plan definition is expected to be used
relatedArtifact	S	0..*	RelatedArtifact	Additional documentation, citations
library	S	0..*	canonical(Library)	Logic used by the plan definition
action	S	0..*	BackboneElement	Action defined by the plan
description	S	0..1	string	Brief description of the action
code	S	0..1	CodeableConcept	Code representing the meaning of the action or sub-actions Binding: US Public Health PlanDefinition Action (extensible): The set of actions that can be used to create plan definition
trigger	S	0..*	TriggerDefinition	When the action should be triggered
ext-us-ph-namedEventType	S	0..1	CodeableConcept	Indicates the types of named events to subscribe to from the EHR. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-us-ph-namedEventType Binding: US Public Health TriggerDefinition NamedEvent (extensible): The set of named events that can be used for subscriptions
type	S	1..1	code	named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Fixed Value: named-event
condition	S	0..*	BackboneElement	Whether or not the action is applicable
kind	S	1..1	code	applicability | start | stop
expression	S	0..1	Expression	Boolean-valued expression
input	S	0..*	DataRequirement	Input data requirements
type	S	1..1	code	The type of the required data
output	S	0..*	DataRequirement	Output data definition
type	S	1..1	code	The type of the required data
relatedAction	S	0..*	BackboneElement	Relationship to another action
actionId	S	1..1	id	What action is this related to
relationship	S	1..1	code	before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
offsetDuration	S	0..1	Duration	Time offset for the relationship
timing[x]	S	0..1	Duration	When the action should take place
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
PlanDefinition	I	1..1	Shareable PlanDefinition	MedMorph PlanDefinition
id	Σ	0..1	string	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) Max Binding: AllLanguages: A human language.
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
ext-receiverAddress	S	1..1	Reference(Endpoint)	Indicates the address where the report has to be sent. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-receiverAddress
ext-authorSignature	S	0..1	Signature	Indicates the signature of the author who created the PlanDefinition URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-authorSignature
ext-asyncIndicator	S	0..1	boolean	True indicates that the messages resulting from the PlanDefinition are expected to be processed asynchronously URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-asyncIndicator
ext-expectedResponseTime	S	0..1	Duration	Indicates the maximum time the sender has to wait to get a response, beyond which the message is assumed to have failed to reach the destination. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-expectedResponseTime
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
url	Σ	1..1	uri	Canonical identifier for this plan definition, represented as a URI (globally unique)
identifier	SΣ	0..*	Identifier	Additional identifier for the plan definition
version	Σ	1..1	string	Business version of the plan definition
name	ΣI	1..1	string	Name for this plan definition (computer friendly)
title	SΣ	0..1	string	Name for this plan definition (human friendly)
subtitle		0..1	string	Subordinate title of the plan definition
type	SΣ	1..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	Σ	1..1	boolean	For testing purposes, not real usage
subject[x]	S	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.).
subjectCodeableConcept			CodeableConcept
subjectReference			Reference(Group)
date	SΣ	0..1	dateTime	Date last changed
publisher	Σ	1..1	string	Name of the publisher (organization or individual)
contact	SΣ	0..*	ContactDetail	Contact details for the publisher
description	Σ	1..1	markdown	Natural language description of the plan definition
useContext	SΣ	0..*	UsageContext	The context that the content is intended to support
jurisdiction	SΣ	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	SΣ	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	S	0..*	RelatedArtifact	Additional documentation, citations
library	S	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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
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
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
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	S	0..*	BackboneElement	Action defined by the plan
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
prefix		0..1	string	User-visible prefix for the action (e.g. 1. or A.)
title		0..1	string	User-visible title
description	S	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	S	0..1	CodeableConcept	Code representing the meaning of the action or sub-actions Binding: US Public Health PlanDefinition Action (extensible): The set of actions that can be used to create plan definition
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	S	0..*	TriggerDefinition	When the action should be triggered
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
ext-us-ph-namedEventType	S	0..1	CodeableConcept	Indicates the types of named events to subscribe to from the EHR. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-us-ph-namedEventType Binding: US Public Health TriggerDefinition NamedEvent (extensible): The set of named events that can be used for subscriptions
type	SΣ	1..1	code	named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Binding: TriggerType (required): The type of trigger. Fixed Value: named-event
name	Σ	0..1	string	Name or URI that identifies the event
timing[x]	Σ	0..1		Timing of the event
timingTiming			Timing
timingReference			Reference(Schedule)
timingDate			date
timingDateTime			dateTime
data	Σ	0..*	DataRequirement	Triggering data of the event (multiple = 'and')
condition	Σ	0..1	Expression	Whether the event triggers (boolean expression)
condition	S	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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
kind	S	1..1	code	applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.
expression	S	0..1	Expression	Boolean-valued expression
input	S	0..*	DataRequirement	Input data requirements
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
type	SΣ	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	ΣI	0..*	Element	What codes are expected drq-1: Either a path or a searchParam must be provided, but not both
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
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	ΣI	0..*	Element	What dates/date ranges are expected drq-2: Either a path or a searchParam must be provided, but not both
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
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
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
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	S	0..*	DataRequirement	Output data definition
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
type	SΣ	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	ΣI	0..*	Element	What codes are expected drq-1: Either a path or a searchParam must be provided, but not both
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
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	ΣI	0..*	Element	What dates/date ranges are expected drq-2: Either a path or a searchParam must be provided, but not both
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
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
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
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	S	0..*	BackboneElement	Relationship to another action
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
actionId	S	1..1	id	What action is this related to
relationship	S	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.
Slices for offset[x]		0..1	Duration	Time offset for the relationship Slice: Unordered, Closed by type:$this
offset[x]:offsetDuration	S	0..1	Duration	Time offset for the relationship
timing[x]	S	0..1	Duration	When the action should take place
participant		0..*	BackboneElement	Who should participate in the action
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		1..1	code	patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action.
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
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
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