0.1.0 - ci-build

RarecareFHIRIG - Local Development build (v0.1.0). See the Directory of published versions

Resource Profile: Rare Condition Management Plan

Defining URL:http://rarecare.world/fhir/StructureDefinition/rare-care-plan
Version:0.1.0
Name:RareCarePlanDefinition
Title:Rare Condition Management Plan
Status:Active as of 2021-06-18T17:19:10+02:00
Definition:

The PlanDefinition for a rare conditions refers to PlanDefinitions of other diseases, i.e. Shwachman-Diamond Syndrome is typically associated with Neutropenia. A code from Orphanet is required.

Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://rarecare.world/fhir/StructureDefinition/rare-care-plan

Formal Views of Profile Content

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

This structure is derived from DiseasePlanDefinition

Summary

This structure is derived from DiseasePlanDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition 0..*DiseasePlanDefinitionThe definition of a plan for a series of actions, independent of any specific patient or context
... description 0..1markdownNatural language description of the plan definition
... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations
.... url 0..1urlWhere the artifact can be accessed
... goal
.... description
..... text 0..1stringPlain text representation of the concept
.... addresses 0..*CodeableConceptWhat does the goal address
Binding: http://www.orpha.net (required)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition I0..*DiseasePlanDefinitionThe definition of a plan for a series of actions, independent of any specific patient or context
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ0..1uriCanonical identifier for this plan definition, represented as a URI (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the plan definition
... version Σ0..1stringBusiness version of the plan definition
... name ΣI0..1stringName for this plan definition (computer friendly)
... title Σ0..1stringName for this plan definition (human friendly)
... subtitle 0..1stringSubordinate title of the plan definition
... type Σ0..1CodeableConceptorder-set | clinical-protocol | eca-rule | workflow-definition
Binding: PlanDefinitionType (extensible): The type of PlanDefinition.


Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: clinical-protocol
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ0..1booleanFor testing purposes, not real usage
... subject[x] 0..1(Slice Definition)Type of individual the plan definition is focused on
Slice: Unordered, Closed by type:$this
Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).

.... subject[x]:subjectCodeableConcept 0..1CodeableConceptType 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
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/resource-types
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: Patient
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text0..1stringPlain text representation of the concept
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
Required Pattern: Stichting Rare Care World
... contact Σ0..*ContactDetailContact details for the publisher
... description Σ0..1markdownNatural language description of the plan definition
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for plan definition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1markdownWhy this plan definition is defined
... usage 0..1stringDescribes the clinical usage of the plan
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the plan definition was approved by publisher
... lastReviewDate 0..1dateWhen the plan definition was last reviewed
... effectivePeriod Σ0..1PeriodWhen the plan definition is expected to be used
... topic 0..*CodeableConceptE.g. Education, Treatment, Assessment
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.



Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/definition-topic
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: treatment
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... author 0..*ContactDetailWho authored the content
... editor 0..*ContactDetailWho edited the content
... reviewer 0..*ContactDetailWho reviewed the content
... endorser 0..*ContactDetailWho endorsed the content
... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... type Σ1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.

.... label Σ0..1stringShort label
.... display Σ0..1stringBrief description of the related artifact
.... citation Σ0..1markdownBibliographic citation for the artifact
.... url Σ0..1urlWhere the artifact can be accessed
.... document Σ0..1AttachmentWhat document is being referenced
.... resource Σ0..1canonical(Resource)What resource is being referenced
... library 0..*canonical(Library)Logic used by the plan definition
... goal 0..*BackboneElementWhat the plan is trying to accomplish
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... category 0..1CodeableConceptE.g. Treatment, dietary, behavioral
Binding: GoalCategory (example): Example codes for grouping goals for filtering or presentation.

.... description 1..1CodeableConceptCode or text describing the goal
Binding: SNOMEDCTClinicalFindings (example): Describes goals that can be achieved.

..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
..... text Σ0..1stringPlain text representation of the concept
.... priority 0..1CodeableConcepthigh-priority | medium-priority | low-priority
Binding: GoalPriority (preferred): Indicates the level of importance associated with reaching or sustaining a goal.

.... start 0..1CodeableConceptWhen goal pursuit begins
Binding: GoalStartEvent (example): Identifies the types of events that might trigger the start of a goal.

.... addresses 0..*CodeableConceptWhat does the goal address
Binding: http://www.orpha.net (required)
.... documentation 0..*RelatedArtifactSupporting documentation for the goal
.... target 0..*BackboneElementTarget outcome for the goal
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... measure 0..1CodeableConceptThe 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..1The target value to be achieved
...... detailQuantityQuantity
...... detailRangeRange
...... detailCodeableConceptCodeableConcept
..... due 0..1DurationReach goal within
... action 0..*BackboneElementAction defined by the plan
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... prefix 0..1stringUser-visible prefix for the action (e.g. 1. or A.)
.... title 0..1stringUser-visible title
.... description 0..1stringBrief description of the action
.... textEquivalent 0..1stringStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
.... priority 0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

.... code 0..*CodeableConceptCode representing the meaning of the action or sub-actions
.... reason 0..*CodeableConceptWhy the action should be performed
.... documentation 0..*RelatedArtifactSupporting documentation for the intended performer of the action
.... goalId 0..*idWhat goals this action supports
.... subject[x] 0..1Type 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.).

..... subjectCodeableConceptCodeableConcept
..... subjectReferenceReference(Group)
.... trigger 0..*TriggerDefinitionWhen the action should be triggered
.... condition 0..*BackboneElementWhether or not the action is applicable
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... kind 1..1codeapplicability | start | stop
Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.

..... expression 0..1ExpressionBoolean-valued expression
.... input 0..*DataRequirementInput data requirements
.... output 0..*DataRequirementOutput data definition
.... relatedAction 0..*BackboneElementRelationship to another action
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... actionId 1..1idWhat action is this related to
..... relationship 1..1codebefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Binding: ActionRelationshipType (required): Defines the types of relationships between actions.

..... offset[x] 0..1Time offset for the relationship
...... offsetDurationDuration
...... offsetRangeRange
.... timing[x] 0..1When the action should take place
..... timingDateTimedateTime
..... timingAgeAge
..... timingPeriodPeriod
..... timingDurationDuration
..... timingRangeRange
..... timingTimingTiming
.... participant 0..*BackboneElementWho should participate in the action
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1codepatient | practitioner | related-person | device
Binding: ActionParticipantType (required): The type of participant for the action.

..... role 0..1CodeableConceptE.g. Nurse, Surgeon, Parent
Binding: ActionParticipantRole (example): Defines roles played by participants for the action.

.... type 0..1CodeableConceptcreate | update | remove | fire-event
Binding: ActionType (extensible): The type of action to be performed.

.... groupingBehavior 0..1codevisual-group | logical-group | sentence-group
Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.

.... selectionBehavior 0..1codeany | all | all-or-none | exactly-one | at-most-one | one-or-more
Binding: ActionSelectionBehavior (required): Defines selection behavior of a group.

.... requiredBehavior 0..1codemust | could | must-unless-documented
Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.

.... precheckBehavior 0..1codeyes | no
Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.

.... cardinalityBehavior 0..1codesingle | multiple
Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated.

.... definition[x] 0..1Description of the activity to be performed
..... definitionCanonicalcanonical(ActivityDefinition | PlanDefinition | Questionnaire)
..... definitionUriuri
.... transform 0..1canonical(StructureMap)Transform to apply the template
.... dynamicValue 0..*BackboneElementDynamic aspects of the definition
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... path 0..1stringThe path to the element to be set dynamically
..... expression 0..1ExpressionAn expression that provides the dynamic value for the customization
.... action 0..*See action (PlanDefinition)A sub-action

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition I0..*DiseasePlanDefinitionThe definition of a plan for a series of actions, independent of any specific patient or context

doco Documentation for this format

This structure is derived from DiseasePlanDefinition

Summary

Differential View

This structure is derived from DiseasePlanDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition 0..*DiseasePlanDefinitionThe definition of a plan for a series of actions, independent of any specific patient or context
... description 0..1markdownNatural language description of the plan definition
... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations
.... url 0..1urlWhere the artifact can be accessed
... goal
.... description
..... text 0..1stringPlain text representation of the concept
.... addresses 0..*CodeableConceptWhat does the goal address
Binding: http://www.orpha.net (required)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition I0..*DiseasePlanDefinitionThe definition of a plan for a series of actions, independent of any specific patient or context
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ0..1uriCanonical identifier for this plan definition, represented as a URI (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the plan definition
... version Σ0..1stringBusiness version of the plan definition
... name ΣI0..1stringName for this plan definition (computer friendly)
... title Σ0..1stringName for this plan definition (human friendly)
... subtitle 0..1stringSubordinate title of the plan definition
... type Σ0..1CodeableConceptorder-set | clinical-protocol | eca-rule | workflow-definition
Binding: PlanDefinitionType (extensible): The type of PlanDefinition.


Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: clinical-protocol
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ0..1booleanFor testing purposes, not real usage
... subject[x] 0..1(Slice Definition)Type of individual the plan definition is focused on
Slice: Unordered, Closed by type:$this
Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).

.... subject[x]:subjectCodeableConcept 0..1CodeableConceptType 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
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/resource-types
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: Patient
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text0..1stringPlain text representation of the concept
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
Required Pattern: Stichting Rare Care World
... contact Σ0..*ContactDetailContact details for the publisher
... description Σ0..1markdownNatural language description of the plan definition
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for plan definition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1markdownWhy this plan definition is defined
... usage 0..1stringDescribes the clinical usage of the plan
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the plan definition was approved by publisher
... lastReviewDate 0..1dateWhen the plan definition was last reviewed
... effectivePeriod Σ0..1PeriodWhen the plan definition is expected to be used
... topic 0..*CodeableConceptE.g. Education, Treatment, Assessment
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.



Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/definition-topic
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: treatment
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... author 0..*ContactDetailWho authored the content
... editor 0..*ContactDetailWho edited the content
... reviewer 0..*ContactDetailWho reviewed the content
... endorser 0..*ContactDetailWho endorsed the content
... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... type Σ1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.

.... label Σ0..1stringShort label
.... display Σ0..1stringBrief description of the related artifact
.... citation Σ0..1markdownBibliographic citation for the artifact
.... url Σ0..1urlWhere the artifact can be accessed
.... document Σ0..1AttachmentWhat document is being referenced
.... resource Σ0..1canonical(Resource)What resource is being referenced
... library 0..*canonical(Library)Logic used by the plan definition
... goal 0..*BackboneElementWhat the plan is trying to accomplish
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... category 0..1CodeableConceptE.g. Treatment, dietary, behavioral
Binding: GoalCategory (example): Example codes for grouping goals for filtering or presentation.

.... description 1..1CodeableConceptCode or text describing the goal
Binding: SNOMEDCTClinicalFindings (example): Describes goals that can be achieved.

..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
..... text Σ0..1stringPlain text representation of the concept
.... priority 0..1CodeableConcepthigh-priority | medium-priority | low-priority
Binding: GoalPriority (preferred): Indicates the level of importance associated with reaching or sustaining a goal.

.... start 0..1CodeableConceptWhen goal pursuit begins
Binding: GoalStartEvent (example): Identifies the types of events that might trigger the start of a goal.

.... addresses 0..*CodeableConceptWhat does the goal address
Binding: http://www.orpha.net (required)
.... documentation 0..*RelatedArtifactSupporting documentation for the goal
.... target 0..*BackboneElementTarget outcome for the goal
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... measure 0..1CodeableConceptThe 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..1The target value to be achieved
...... detailQuantityQuantity
...... detailRangeRange
...... detailCodeableConceptCodeableConcept
..... due 0..1DurationReach goal within
... action 0..*BackboneElementAction defined by the plan
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... prefix 0..1stringUser-visible prefix for the action (e.g. 1. or A.)
.... title 0..1stringUser-visible title
.... description 0..1stringBrief description of the action
.... textEquivalent 0..1stringStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
.... priority 0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

.... code 0..*CodeableConceptCode representing the meaning of the action or sub-actions
.... reason 0..*CodeableConceptWhy the action should be performed
.... documentation 0..*RelatedArtifactSupporting documentation for the intended performer of the action
.... goalId 0..*idWhat goals this action supports
.... subject[x] 0..1Type 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.).

..... subjectCodeableConceptCodeableConcept
..... subjectReferenceReference(Group)
.... trigger 0..*TriggerDefinitionWhen the action should be triggered
.... condition 0..*BackboneElementWhether or not the action is applicable
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... kind 1..1codeapplicability | start | stop
Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.

..... expression 0..1ExpressionBoolean-valued expression
.... input 0..*DataRequirementInput data requirements
.... output 0..*DataRequirementOutput data definition
.... relatedAction 0..*BackboneElementRelationship to another action
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... actionId 1..1idWhat action is this related to
..... relationship 1..1codebefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Binding: ActionRelationshipType (required): Defines the types of relationships between actions.

..... offset[x] 0..1Time offset for the relationship
...... offsetDurationDuration
...... offsetRangeRange
.... timing[x] 0..1When the action should take place
..... timingDateTimedateTime
..... timingAgeAge
..... timingPeriodPeriod
..... timingDurationDuration
..... timingRangeRange
..... timingTimingTiming
.... participant 0..*BackboneElementWho should participate in the action
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1codepatient | practitioner | related-person | device
Binding: ActionParticipantType (required): The type of participant for the action.

..... role 0..1CodeableConceptE.g. Nurse, Surgeon, Parent
Binding: ActionParticipantRole (example): Defines roles played by participants for the action.

.... type 0..1CodeableConceptcreate | update | remove | fire-event
Binding: ActionType (extensible): The type of action to be performed.

.... groupingBehavior 0..1codevisual-group | logical-group | sentence-group
Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.

.... selectionBehavior 0..1codeany | all | all-or-none | exactly-one | at-most-one | one-or-more
Binding: ActionSelectionBehavior (required): Defines selection behavior of a group.

.... requiredBehavior 0..1codemust | could | must-unless-documented
Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.

.... precheckBehavior 0..1codeyes | no
Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.

.... cardinalityBehavior 0..1codesingle | multiple
Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated.

.... definition[x] 0..1Description of the activity to be performed
..... definitionCanonicalcanonical(ActivityDefinition | PlanDefinition | Questionnaire)
..... definitionUriuri
.... transform 0..1canonical(StructureMap)Transform to apply the template
.... dynamicValue 0..*BackboneElementDynamic aspects of the definition
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... path 0..1stringThe path to the element to be set dynamically
..... expression 0..1ExpressionAn expression that provides the dynamic value for the customization
.... action 0..*See action (PlanDefinition)A sub-action

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
PlanDefinition.languagepreferredCommonLanguages
Max Binding: AllLanguages
PlanDefinition.typeextensiblePattern: clinical-protocol
PlanDefinition.statusrequiredPublicationStatus
PlanDefinition.subject[x]extensibleSubjectType
PlanDefinition.subject[x]:subjectCodeableConceptextensiblePattern: Patient
PlanDefinition.jurisdictionextensibleJurisdiction ValueSet
PlanDefinition.topicexamplePattern: treatment
PlanDefinition.relatedArtifact.typerequiredRelatedArtifactType
PlanDefinition.goal.categoryexampleGoalCategory
PlanDefinition.goal.descriptionexampleSNOMEDCTClinicalFindings
PlanDefinition.goal.prioritypreferredGoalPriority
PlanDefinition.goal.startexampleGoalStartEvent
PlanDefinition.goal.addressesrequiredhttp://www.orpha.net
PlanDefinition.goal.target.measureexampleLOINCCodes
PlanDefinition.action.priorityrequiredRequestPriority
PlanDefinition.action.subject[x]extensibleSubjectType
PlanDefinition.action.condition.kindrequiredActionConditionKind
PlanDefinition.action.relatedAction.relationshiprequiredActionRelationshipType
PlanDefinition.action.participant.typerequiredActionParticipantType
PlanDefinition.action.participant.roleexampleActionParticipantRole
PlanDefinition.action.typeextensibleActionType
PlanDefinition.action.groupingBehaviorrequiredActionGroupingBehavior
PlanDefinition.action.selectionBehaviorrequiredActionSelectionBehavior
PlanDefinition.action.requiredBehaviorrequiredActionRequiredBehavior
PlanDefinition.action.precheckBehaviorrequiredActionPrecheckBehavior
PlanDefinition.action.cardinalityBehaviorrequiredActionCardinalityBehavior

Constraints

IdPathDetailsRequirements
dom-2PlanDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3PlanDefinitionIf 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-4PlanDefinitionIf 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-5PlanDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6PlanDefinitionA resource should have narrative for robust management
: text.`div`.exists()
pdf-0PlanDefinitionName 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}')
ele-1PlanDefinition.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1PlanDefinition.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1PlanDefinition.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1PlanDefinition.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1PlanDefinition.urlAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.titleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.subtitleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.experimentalAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.subject[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.subject[x]:subjectCodeableConceptAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.dateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.publisherAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.contactAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.useContextAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.jurisdictionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.purposeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.usageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.copyrightAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.approvalDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.lastReviewDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.effectivePeriodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.topicAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.authorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.editorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.reviewerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.endorserAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.relatedArtifactAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.relatedArtifact.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1PlanDefinition.relatedArtifact.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1PlanDefinition.relatedArtifact.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.relatedArtifact.labelAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.relatedArtifact.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.relatedArtifact.citationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.relatedArtifact.urlAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.relatedArtifact.documentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.relatedArtifact.resourceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.libraryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.goalAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.goal.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1PlanDefinition.goal.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1PlanDefinition.goal.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1PlanDefinition.goal.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1PlanDefinition.goal.categoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.goal.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.goal.description.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1PlanDefinition.goal.description.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1PlanDefinition.goal.description.codingAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.goal.description.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.goal.priorityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.goal.startAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.goal.addressesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.goal.documentationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.goal.targetAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.goal.target.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1PlanDefinition.goal.target.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1PlanDefinition.goal.target.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1PlanDefinition.goal.target.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1PlanDefinition.goal.target.measureAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.goal.target.detail[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.goal.target.dueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.actionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1PlanDefinition.action.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1PlanDefinition.action.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1PlanDefinition.action.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1PlanDefinition.action.prefixAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.titleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.textEquivalentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.priorityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.reasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.documentationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.goalIdAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.subject[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.triggerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.conditionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.condition.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1PlanDefinition.action.condition.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1PlanDefinition.action.condition.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1PlanDefinition.action.condition.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1PlanDefinition.action.condition.kindAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.condition.expressionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.inputAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.outputAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.relatedActionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.relatedAction.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1PlanDefinition.action.relatedAction.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1PlanDefinition.action.relatedAction.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1PlanDefinition.action.relatedAction.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1PlanDefinition.action.relatedAction.actionIdAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.relatedAction.relationshipAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.relatedAction.offset[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.timing[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.participantAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.participant.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1PlanDefinition.action.participant.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1PlanDefinition.action.participant.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1PlanDefinition.action.participant.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1PlanDefinition.action.participant.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.participant.roleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.groupingBehaviorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.selectionBehaviorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.requiredBehaviorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.precheckBehaviorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.cardinalityBehaviorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.definition[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.transformAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.dynamicValueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.dynamicValue.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1PlanDefinition.action.dynamicValue.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1PlanDefinition.action.dynamicValue.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1PlanDefinition.action.dynamicValue.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1PlanDefinition.action.dynamicValue.pathAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.dynamicValue.expressionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1PlanDefinition.action.actionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())