HL7® FHIR® Te Aho o Te Kahu, Cancer Control Agency Implementation Guide
0.1.0 - CI Build

HL7® FHIR® Te Aho o Te Kahu, Cancer Control Agency Implementation Guide, published by David Hay. This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of https://github.com/HL7NZ/cca/ and changes regularly. See the Directory of published versions

Resource Profile: PlanDefinition

Defining URL:http://hl7.org.nz/fhir/StructureDefinition/CcaPlanDefinition
Version:0.1.0
Name:CcaPlanDefinition
Title:PlanDefinition
Status:Active as of 2020-11-25T22:41:52+00:00
Definition:

CCA Regimen Plan Definition.

Publisher:David Hay
Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org.nz/fhir/StructureDefinition/CcaPlanDefinition

Formal Views of Profile Content

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

This structure is derived from PlanDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition 0..*PlanDefinitionThe definition of a plan for a series of actions, independent of any specific patient or context
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... sact-support-factor 0..*(Complex)Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-support-factor
... sact-regimen-type 0..1CodeableConceptExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-regimen-type
Binding: Regimen type code (required)
... sact-treatment-intent 0..1CodeableConceptExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-treatment-intent
Binding: Treatment intent (required)
... sact-off-label 0..1booleanExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-off-label
... sact-plan-instructions 0..1markdownExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-plan-instructions
... sact-disclaimer 0..1markdownExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-disclaimer
... type 0..1CodeableConceptorder-set | clinical-protocol | eca-rule | workflow-definition
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: clinical-protocol
... status
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... sact-additional-plan-status 0..1codeExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-additional-plan-status
Binding: PlanDefinition additional status (required)
... useContext 0..*(Slice Definition)The context that the content is intended to support
Slice: Unordered, Open At End by value:code
.... useContext:All Slices Content/Rules for all slices
..... value[x] 1..1CodeableConceptValue that defines the context
.... useContext:cancer-type S0..*UsageContextThe type of cancer
..... code 1..1CodingType of context being specified
Required Pattern: At least the following
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: focus
..... valueCodeableConcept 1..1CodeableConceptValue that defines the context
Binding: Cancer type (required)
... reviewer 0..0
... endorser 0..0
... library 0..0
... goal 0..0
... action 1..1BackboneElementAction defined by the plan
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... sact-plan-instructions 0..1markdownExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-plan-instructions
.... priority 0..0
.... code 0..0
.... reason 0..0
.... subject[x] 0..0
.... trigger 0..0
.... condition 0..0
.... input 0..0
.... output 0..0
.... timing[x] 0..1TimingWhen the action should take place
.... type 0..0
.... precheckBehavior 0..0
.... cardinalityBehavior 0..0
.... transform 0..0
.... dynamicValue 0..0
.... action 0..*BackboneElementA sub-action
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... sact-plan-instructions 0..1markdownExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-plan-instructions
..... sact-timing-of-days 0..*(Complex)Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-timing-of-days

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition I0..*PlanDefinitionThe 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..*ExtensionExtension
Slice: Unordered, Open by value:url
... sact-support-factor 0..*(Complex)Optional Extensions Element
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-support-factor
... sact-regimen-type 0..1CodeableConceptOptional Extensions Element
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-regimen-type
Binding: Regimen type code (required)
... sact-replaced-by 0..1Reference(PlanDefinition)Optional Extensions Element
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-replaced-by
... sact-treatment-intent 0..1CodeableConceptOptional Extensions Element
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-treatment-intent
Binding: Treatment intent (required)
... sact-off-label 0..1booleanOptional Extensions Element
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-off-label
... sact-plan-instructions 0..1markdownOptional Extensions Element
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-plan-instructions
... sact-disclaimer 0..1markdownOptional Extensions Element
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-disclaimer
... 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.

.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... sact-additional-plan-status 0..1codeOptional Extensions Element
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-additional-plan-status
Binding: PlanDefinition additional status (required)
.... value 0..1stringPrimitive value for code
... experimental Σ0..1booleanFor testing purposes, not real usage
... subject[x] 0..1Type 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.).

.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description Σ0..1markdownNatural language description of the plan definition
... useContext Σ0..*(Slice Definition)The context that the content is intended to support
Slice: Unordered, Open At End by value:code
.... useContext:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... code Σ1..1CodingType of context being specified
Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context.

..... value[x] Σ1..1CodeableConceptValue that defines the context
Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.

.... useContext:cancer-type SΣ0..*UsageContextThe type of cancer
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... code Σ1..1CodingType of context being specified
Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system0..1uriIdentity of the terminology system
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: focus
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... value[x] Σ1..1(Slice Definition)Value that defines the context
Slice: Unordered, Closed by type:$this
Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.

...... value[x]:valueCodeableConcept Σ1..1CodeableConceptValue that defines the context
Binding: Cancer type (required)
... 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.


... author 0..*ContactDetailWho authored the content
... editor 0..*ContactDetailWho edited the content
... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations
... action 1..1BackboneElementAction defined by the plan
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... sact-plan-instructions 0..1markdownOptional Extensions Element
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-plan-instructions
.... 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
.... documentation 0..*RelatedArtifactSupporting documentation for the intended performer of the action
.... goalId 0..*idWhat goals this action supports
.... 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..1TimingWhen the action should take place
.... 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.

.... 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.

.... definition[x] 0..1Description of the activity to be performed
..... definitionCanonicalcanonical(ActivityDefinition | PlanDefinition | Questionnaire)
..... definitionUriuri
.... action 0..*BackboneElementA sub-action
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... sact-plan-instructions 0..1markdownOptional Extensions Element
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-plan-instructions
..... sact-timing-of-days 0..*(Complex)Optional Extensions Element
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-timing-of-days
..... 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..*PlanDefinitionThe definition of a plan for a series of actions, independent of any specific patient or context
... useContext:cancer-type Σ0..*UsageContextThe type of cancer

doco Documentation for this format

Differential View

This structure is derived from PlanDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition 0..*PlanDefinitionThe definition of a plan for a series of actions, independent of any specific patient or context
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... sact-support-factor 0..*(Complex)Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-support-factor
... sact-regimen-type 0..1CodeableConceptExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-regimen-type
Binding: Regimen type code (required)
... sact-treatment-intent 0..1CodeableConceptExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-treatment-intent
Binding: Treatment intent (required)
... sact-off-label 0..1booleanExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-off-label
... sact-plan-instructions 0..1markdownExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-plan-instructions
... sact-disclaimer 0..1markdownExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-disclaimer
... type 0..1CodeableConceptorder-set | clinical-protocol | eca-rule | workflow-definition
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: clinical-protocol
... status
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... sact-additional-plan-status 0..1codeExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-additional-plan-status
Binding: PlanDefinition additional status (required)
... useContext 0..*(Slice Definition)The context that the content is intended to support
Slice: Unordered, Open At End by value:code
.... useContext:All Slices Content/Rules for all slices
..... value[x] 1..1CodeableConceptValue that defines the context
.... useContext:cancer-type S0..*UsageContextThe type of cancer
..... code 1..1CodingType of context being specified
Required Pattern: At least the following
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: focus
..... valueCodeableConcept 1..1CodeableConceptValue that defines the context
Binding: Cancer type (required)
... reviewer 0..0
... endorser 0..0
... library 0..0
... goal 0..0
... action 1..1BackboneElementAction defined by the plan
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... sact-plan-instructions 0..1markdownExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-plan-instructions
.... priority 0..0
.... code 0..0
.... reason 0..0
.... subject[x] 0..0
.... trigger 0..0
.... condition 0..0
.... input 0..0
.... output 0..0
.... timing[x] 0..1TimingWhen the action should take place
.... type 0..0
.... precheckBehavior 0..0
.... cardinalityBehavior 0..0
.... transform 0..0
.... dynamicValue 0..0
.... action 0..*BackboneElementA sub-action
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... sact-plan-instructions 0..1markdownExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-plan-instructions
..... sact-timing-of-days 0..*(Complex)Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-timing-of-days

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition I0..*PlanDefinitionThe 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..*ExtensionExtension
Slice: Unordered, Open by value:url
... sact-support-factor 0..*(Complex)Optional Extensions Element
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-support-factor
... sact-regimen-type 0..1CodeableConceptOptional Extensions Element
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-regimen-type
Binding: Regimen type code (required)
... sact-replaced-by 0..1Reference(PlanDefinition)Optional Extensions Element
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-replaced-by
... sact-treatment-intent 0..1CodeableConceptOptional Extensions Element
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-treatment-intent
Binding: Treatment intent (required)
... sact-off-label 0..1booleanOptional Extensions Element
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-off-label
... sact-plan-instructions 0..1markdownOptional Extensions Element
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-plan-instructions
... sact-disclaimer 0..1markdownOptional Extensions Element
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-disclaimer
... 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.

.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... sact-additional-plan-status 0..1codeOptional Extensions Element
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-additional-plan-status
Binding: PlanDefinition additional status (required)
.... value 0..1stringPrimitive value for code
... experimental Σ0..1booleanFor testing purposes, not real usage
... subject[x] 0..1Type 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.).

.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description Σ0..1markdownNatural language description of the plan definition
... useContext Σ0..*(Slice Definition)The context that the content is intended to support
Slice: Unordered, Open At End by value:code
.... useContext:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... code Σ1..1CodingType of context being specified
Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context.

..... value[x] Σ1..1CodeableConceptValue that defines the context
Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.

.... useContext:cancer-type SΣ0..*UsageContextThe type of cancer
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... code Σ1..1CodingType of context being specified
Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system0..1uriIdentity of the terminology system
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: focus
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... value[x] Σ1..1(Slice Definition)Value that defines the context
Slice: Unordered, Closed by type:$this
Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.

...... value[x]:valueCodeableConcept Σ1..1CodeableConceptValue that defines the context
Binding: Cancer type (required)
... 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.


... author 0..*ContactDetailWho authored the content
... editor 0..*ContactDetailWho edited the content
... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations
... action 1..1BackboneElementAction defined by the plan
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... sact-plan-instructions 0..1markdownOptional Extensions Element
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-plan-instructions
.... 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
.... documentation 0..*RelatedArtifactSupporting documentation for the intended performer of the action
.... goalId 0..*idWhat goals this action supports
.... 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..1TimingWhen the action should take place
.... 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.

.... 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.

.... definition[x] 0..1Description of the activity to be performed
..... definitionCanonicalcanonical(ActivityDefinition | PlanDefinition | Questionnaire)
..... definitionUriuri
.... action 0..*BackboneElementA sub-action
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... sact-plan-instructions 0..1markdownOptional Extensions Element
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-plan-instructions
..... sact-timing-of-days 0..*(Complex)Optional Extensions Element
URL: http://hl7.org.nz/fhir/StructureDefinition/sact-timing-of-days
..... 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: Schematron

Terminology Bindings

PathConformanceValueSet / Code
PlanDefinition.languagepreferredCommonLanguages
Max Binding: AllLanguages
PlanDefinition.typeextensiblePattern: clinical-protocol
PlanDefinition.statusrequiredPublicationStatus
PlanDefinition.subject[x]extensibleSubjectType
PlanDefinition.useContext.codeextensibleUsageContextType
PlanDefinition.useContext.value[x]exampleContext of Use ValueSet
PlanDefinition.useContext:cancer-type.codeextensiblePattern: focus
PlanDefinition.useContext:cancer-type.value[x]exampleContext of Use ValueSet
PlanDefinition.useContext:cancer-type.value[x]:valueCodeableConceptrequiredCancerType
PlanDefinition.jurisdictionextensibleJurisdiction ValueSet
PlanDefinition.topicexampleDefinitionTopic
PlanDefinition.goal.categoryexampleGoalCategory
PlanDefinition.goal.descriptionexampleSNOMEDCTClinicalFindings
PlanDefinition.goal.prioritypreferredGoalPriority
PlanDefinition.goal.startexampleGoalStartEvent
PlanDefinition.goal.addressesexampleCondition/Problem/DiagnosisCodes
PlanDefinition.goal.target.measureexampleLOINCCodes
PlanDefinition.action.condition.kindrequiredActionConditionKind
PlanDefinition.action.relatedAction.relationshiprequiredActionRelationshipType
PlanDefinition.action.participant.typerequiredActionParticipantType
PlanDefinition.action.participant.roleexampleActionParticipantRole
PlanDefinition.action.groupingBehaviorrequiredActionGroupingBehavior
PlanDefinition.action.selectionBehaviorrequiredActionSelectionBehavior
PlanDefinition.action.requiredBehaviorrequiredActionRequiredBehavior
PlanDefinition.action.action.priorityrequiredRequestPriority
PlanDefinition.action.action.subject[x]extensibleSubjectType
PlanDefinition.action.action.condition.kindrequiredActionConditionKind
PlanDefinition.action.action.relatedAction.relationshiprequiredActionRelationshipType
PlanDefinition.action.action.participant.typerequiredActionParticipantType
PlanDefinition.action.action.participant.roleexampleActionParticipantRole
PlanDefinition.action.action.typeextensibleActionType
PlanDefinition.action.action.groupingBehaviorrequiredActionGroupingBehavior
PlanDefinition.action.action.selectionBehaviorrequiredActionSelectionBehavior
PlanDefinition.action.action.requiredBehaviorrequiredActionRequiredBehavior
PlanDefinition.action.action.precheckBehaviorrequiredActionPrecheckBehavior
PlanDefinition.action.action.cardinalityBehaviorrequiredActionCardinalityBehavior
<