HL7® FHIR® Te Aho o Te Kahu, Cancer Control Agency Implementation Guide, published by Te Aho o Te Kahu, Cancer Control Agency. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. 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
| Official URL: http://hl7.org.nz/fhir/StructureDefinition/CcaPlanDefinition | Version: 0.1.0 | |||
| Active as of 2024-03-03 |
Realm: 
|
Computable Name: CcaPlanDefinition | ||
CCA Regimen Plan Definition.
Usage:
- Refer to this Resource Profile: Replaced by
- Examples for this Resource Profile: LUNG NSCLC Metastatic - alectinib, LUNG NSCLC NON-Metastatic - alectinib, GU PROS Castration resistant Metastatic - abiraterone and dexamethasone, GYN END Adjuvant - cISplatin chemoradiation followed by cARBOplatin and PACLItaxel... Show 2 more
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from PlanDefinition
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  PlanDefinition | 0..* | PlanDefinition | The definition of a plan for a series of actions, independent of any specific patient or context | |
  Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 support-factor | 0..* | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/sact-support-factor | |
| regimen-type | 0..1 | CodeableConcept | Regimen type URL: http://hl7.org.nz/fhir/StructureDefinition/sact-regimen-type Binding: Regimen type code (required) | |
| replaced-by | 0..1 | Reference(PlanDefinition) | Replaced by URL: http://hl7.org.nz/fhir/StructureDefinition/sact-replaced-by | |
| treatment-setting | 0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/sact-treatment-setting Binding: Treatment setting (required) | |
| offLabel | 0..1 | boolean | Off label URL: http://hl7.org.nz/fhir/StructureDefinition/sact-off-label | |
| plan-instructions | 0..1 | markdown | Instructions for use URL: http://hl7.org.nz/fhir/StructureDefinition/sact-plan-instructions | |
| disclaimer | 0..1 | markdown | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/sact-disclaimer | |
| additionalDetails | 0..* | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/sact-additional-details | |
  type | 0..1 | CodeableConcept | order-set | clinical-protocol | eca-rule | workflow-definition Required Pattern: At least the following | |
   coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
 system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type | |
 code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: clinical-protocol | |
| status | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| additional-status | 0..1 | code | Regimen under review URL: http://hl7.org.nz/fhir/StructureDefinition/sact-additional-plan-status Binding: PlanDefinition additional status (required) | |
 Slices for useContext | 0..* | UsageContext | 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..1 | CodeableConcept | Value that defines the context | |
 useContext:cancer-type | S | 0..* | UsageContext | The type of cancer |
 code | 1..1 | Coding | Type of context being specified Required Pattern: At least the following | |
 code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: focus | |
 value[x] | 1..1 | CodeableConcept, Quantity, Range, Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization) | Value that defines the context Binding: Cancer type (required) | |
| reviewer | 0..0 | |||
| endorser | 0..0 | |||
| library | 0..0 | |||
| goal | 0..0 | |||
| action | 1..1 | BackboneElement | Action defined by the plan | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| action-instructions | 0..1 | markdown | Instructions for use 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..1 | Timing | When the action should take place | |
| type | 0..0 | |||
| precheckBehavior | 0..0 | |||
| cardinalityBehavior | 0..0 | |||
| transform | 0..0 | |||
| dynamicValue | 0..0 | |||
| action | 0..* | BackboneElement | A sub-action | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| action-instructions | 0..1 | markdown | Instructions for use URL: http://hl7.org.nz/fhir/StructureDefinition/sact-plan-instructions | |
| timing-of-days | 0..* | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/sact-timing-of-days | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Conformance | ValueSet | URI |
| PlanDefinition.useContext:cancer-type.value[x] | required | CancerTypehttps://standards.digital.health.nz/fhir/ValueSet/cancer-type-codefrom this IG |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PlanDefinition | C | 0..* | PlanDefinition | The definition of a plan for a series of actions, independent of any specific patient or context pdf-0: Name should be usable as an identifier for the module by machine processing applications such as code generation |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| support-factor | 0..* | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/sact-support-factor | |
| regimen-type | 0..1 | CodeableConcept | Regimen type URL: http://hl7.org.nz/fhir/StructureDefinition/sact-regimen-type Binding: Regimen type code (required) | |
| replaced-by | 0..1 | Reference(PlanDefinition) | Replaced by URL: http://hl7.org.nz/fhir/StructureDefinition/sact-replaced-by | |
| treatment-setting | 0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/sact-treatment-setting Binding: Treatment setting (required) | |
| offLabel | 0..1 | boolean | Off label URL: http://hl7.org.nz/fhir/StructureDefinition/sact-off-label | |
| plan-instructions | 0..1 | markdown | Instructions for use URL: http://hl7.org.nz/fhir/StructureDefinition/sact-plan-instructions | |
| disclaimer | 0..1 | markdown | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/sact-disclaimer | |
| additionalDetails | 0..* | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/sact-additional-details | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| type | Σ | 0..1 | CodeableConcept | order-set | clinical-protocol | eca-rule | workflow-definition Binding: PlanDefinitionType (extensible): The type of PlanDefinition. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: clinical-protocol | |
| status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| additional-status | 0..1 | code | Regimen under review URL: http://hl7.org.nz/fhir/StructureDefinition/sact-additional-plan-status Binding: PlanDefinition additional status (required) | |
| Slices for useContext | Σ | 0..* | UsageContext | 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 | |||
 code | Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. |
| value[x] | Σ | 1..1 | CodeableConcept | Value 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..* | UsageContext | The type of cancer |
| code | Σ | 1..1 | Coding | Type 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 |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: focus | |
  value[x] | Σ | 1..1 | Value that defines the context Binding: Cancer type (required) | |
| valueCodeableConcept | CodeableConcept | |||
| valueQuantity | Quantity | |||
| valueRange | Range | |||
 valueReference | Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization) | |||
| action | 1..1 | BackboneElement | Action defined by the plan | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| action-instructions | 0..1 | markdown | Instructions for use URL: http://hl7.org.nz/fhir/StructureDefinition/sact-plan-instructions | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| timing[x] | 0..1 | Timing | When the action should take place | |
| action | 0..* | BackboneElement | A sub-action | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| action-instructions | 0..1 | markdown | Instructions for use URL: http://hl7.org.nz/fhir/StructureDefinition/sact-plan-instructions | |
| timing-of-days | 0..* | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/sact-timing-of-days | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet / Code | URI |
| PlanDefinition.type | extensible | Pattern: clinical-protocolhttp://hl7.org/fhir/ValueSet/plan-definition-typefrom the FHIR Standard | |
| PlanDefinition.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | |
| PlanDefinition.useContext.code | extensible | UsageContextTypehttp://hl7.org/fhir/ValueSet/usage-context-typefrom the FHIR Standard | |
| PlanDefinition.useContext.value[x] | example | Context of Use ValueSethttp://hl7.org/fhir/ValueSet/use-contextfrom the FHIR Standard | |
| PlanDefinition.useContext:cancer-type.code | extensible | Pattern: focushttp://hl7.org/fhir/ValueSet/usage-context-typefrom the FHIR Standard | |
| PlanDefinition.useContext:cancer-type.value[x] | required | CancerTypehttps://standards.digital.health.nz/fhir/ValueSet/cancer-type-codefrom this IG | |
| PlanDefinition.goal.description | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findingsfrom the FHIR Standard | |
| PlanDefinition.action.condition.kind | required | ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1from the FHIR Standard |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| PlanDefinition | C | 0..* | PlanDefinition | The definition of a plan for a series of actions, independent of any specific patient or context pdf-0: Name should be usable as an identifier for the module by machine processing applications such as code generation | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| support-factor | 0..* | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/sact-support-factor | |||||
| regimen-type | 0..1 | CodeableConcept | Regimen type URL: http://hl7.org.nz/fhir/StructureDefinition/sact-regimen-type Binding: Regimen type code (required) | |||||
| replaced-by | 0..1 | Reference(PlanDefinition) | Replaced by URL: http://hl7.org.nz/fhir/StructureDefinition/sact-replaced-by | |||||
| treatment-setting | 0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/sact-treatment-setting Binding: Treatment setting (required) | |||||
| offLabel | 0..1 | boolean | Off label URL: http://hl7.org.nz/fhir/StructureDefinition/sact-off-label | |||||
| plan-instructions | 0..1 | markdown | Instructions for use URL: http://hl7.org.nz/fhir/StructureDefinition/sact-plan-instructions | |||||
| disclaimer | 0..1 | markdown | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/sact-disclaimer | |||||
| additionalDetails | 0..* | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/sact-additional-details | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url | Σ | 0..1 | uri | Canonical identifier for this plan definition, represented as a URI (globally unique) | ||||
| identifier | Σ | 0..* | Identifier | Additional identifier for the plan definition | ||||
| version | Σ | 0..1 | string | Business version of the plan definition | ||||
| name | ΣC | 0..1 | string | Name for this plan definition (computer friendly) | ||||
| title | Σ | 0..1 | string | Name for this plan definition (human friendly) | ||||
| subtitle | 0..1 | string | Subordinate title of the plan definition | |||||
| type | Σ | 0..1 | CodeableConcept | order-set | clinical-protocol | eca-rule | workflow-definition Binding: PlanDefinitionType (extensible): The type of PlanDefinition. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: clinical-protocol | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| additional-status | 0..1 | code | Regimen under review URL: http://hl7.org.nz/fhir/StructureDefinition/sact-additional-plan-status Binding: PlanDefinition additional status (required) | |||||
| value | 0..1 | string | Primitive value for code | |||||
| experimental | Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
| subject[x] | 0..1 | Type of individual the plan definition is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). | ||||||
| subjectCodeableConcept | CodeableConcept | |||||||
| subjectReference | Reference(Group) | |||||||
| date | Σ | 0..1 | dateTime | Date last changed | ||||
| publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact | Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description | Σ | 0..1 | markdown | Natural language description of the plan definition | ||||
| Slices for useContext | Σ | 0..* | UsageContext | 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..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| code | Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. | ||||
| value[x] | Σ | 1..1 | CodeableConcept | Value 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..* | UsageContext | The type of cancer | ||||
 id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| code | Σ | 1..1 | Coding | Type 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 | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 0..1 | uri | Identity of the terminology system | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: focus | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| value[x] | Σ | 1..1 | Value that defines the context Binding: Cancer type (required) | |||||
| valueCodeableConcept | CodeableConcept | |||||||
| valueQuantity | Quantity | |||||||
| valueRange | Range | |||||||
| valueReference | Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization) | |||||||
| jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for plan definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| purpose | 0..1 | markdown | Why this plan definition is defined | |||||
| usage | 0..1 | string | Describes the clinical usage of the plan | |||||
| copyright | 0..1 | markdown | Use and/or publishing restrictions | |||||
| approvalDate | 0..1 | date | When the plan definition was approved by publisher | |||||
| lastReviewDate | 0..1 | date | When the plan definition was last reviewed | |||||
| effectivePeriod | Σ | 0..1 | Period | When the plan definition is expected to be used | ||||
| topic | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering. | |||||
| author | 0..* | ContactDetail | Who authored the content | |||||
| editor | 0..* | ContactDetail | Who edited the content | |||||
| relatedArtifact | 0..* | RelatedArtifact | Additional documentation, citations | |||||
| action | 1..1 | BackboneElement | Action defined by the plan | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| action-instructions | 0..1 | markdown | Instructions for use URL: http://hl7.org.nz/fhir/StructureDefinition/sact-plan-instructions | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| prefix | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.) | |||||
| title | 0..1 | string | User-visible title | |||||
| description | 0..1 | string | Brief description of the action | |||||
| textEquivalent | 0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system | |||||
| documentation | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action | |||||
| goalId | 0..* | id | What goals this action supports | |||||
| relatedAction | 0..* | BackboneElement | Relationship to another action | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| actionId | 1..1 | id | What action is this related to | |||||
| relationship | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions. | |||||
| offset[x] | 0..1 | Time offset for the relationship | ||||||
| offsetDuration | Duration | |||||||
| offsetRange | Range | |||||||
| timing[x] | 0..1 | Timing | When the action should take place | |||||
| participant | 0..* | BackboneElement | Who should participate in the action | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action. | |||||
| role | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example): Defines roles played by participants for the action. | |||||
| groupingBehavior | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group. | |||||
| selectionBehavior | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group. | |||||
| requiredBehavior | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required. | |||||
| definition[x] | 0..1 | Description of the activity to be performed | ||||||
| definitionCanonical | canonical(ActivityDefinition | PlanDefinition | Questionnaire) | |||||||
| definitionUri | uri | |||||||
| action | 0..* | BackboneElement | A sub-action | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| action-instructions | 0..1 | markdown | Instructions for use URL: http://hl7.org.nz/fhir/StructureDefinition/sact-plan-instructions | |||||
| timing-of-days | 0..* | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/sact-timing-of-days | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| prefix | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.) | |||||
| title | 0..1 | string | User-visible title | |||||
| description | 0..1 | string | Brief description of the action | |||||
| textEquivalent | 0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system | |||||
| priority | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |||||
| code | 0..* | CodeableConcept | Code representing the meaning of the action or sub-actions | |||||
| reason | 0..* | CodeableConcept | Why the action should be performed | |||||
| documentation | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action | |||||
| goalId | 0..* | id | What goals this action supports | |||||
| subject[x] | 0..1 | Type of individual the action is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). | ||||||
| subjectCodeableConcept | CodeableConcept | |||||||
| subjectReference | Reference(Group) | |||||||
| trigger | 0..* | TriggerDefinition | When the action should be triggered | |||||
| condition | 0..* | BackboneElement | Whether or not the action is applicable | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| kind | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions. | |||||
| expression | 0..1 | Expression | Boolean-valued expression | |||||
| input | 0..* | DataRequirement | Input data requirements | |||||
| output | 0..* | DataRequirement | Output data definition | |||||
| relatedAction | 0..* | BackboneElement | Relationship to another action | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| actionId | 1..1 | id | What action is this related to | |||||
| relationship | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions. | |||||
| offset[x] | 0..1 | Time offset for the relationship | ||||||
| offsetDuration | Duration | |||||||
| offsetRange | Range | |||||||
| timing[x] | 0..1 | When the action should take place | ||||||
| timingDateTime | dateTime | |||||||
| timingAge | Age | |||||||
| timingPeriod | Period | |||||||
| timingDuration | Duration | |||||||
| timingRange | Range | |||||||
| timingTiming | Timing | |||||||
| participant | 0..* | BackboneElement | Who should participate in the action | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action. | |||||
| role | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example): Defines roles played by participants for the action. | |||||
| type | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed. | |||||
| groupingBehavior | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group. | |||||
| selectionBehavior | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group. | |||||
| requiredBehavior | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required. | |||||
| precheckBehavior | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group. | |||||
| cardinalityBehavior | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated. | |||||
| definition[x] | 0..1 | Description of the activity to be performed | ||||||
| definitionCanonical | canonical(ActivityDefinition | PlanDefinition | Questionnaire) | |||||||
| definitionUri | uri | |||||||
| transform | 0..1 | canonical(StructureMap) | Transform to apply the template | |||||
| dynamicValue | 0..* | BackboneElement | Dynamic aspects of the definition | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| path | 0..1 | string | The path to the element to be set dynamically | |||||
| expression | 0..1 | Expression | An expression that provides the dynamic value for the customization | |||||
| action | 0..* | See action (PlanDefinition) | A sub-action | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet / Code | URI | |||
| PlanDefinition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| PlanDefinition.type | extensible | Pattern: clinical-protocolhttp://hl7.org/fhir/ValueSet/plan-definition-typefrom the FHIR Standard | ||||
| PlanDefinition.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | ||||
| PlanDefinition.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-typefrom the FHIR Standard | ||||
| PlanDefinition.useContext.code | extensible | UsageContextTypehttp://hl7.org/fhir/ValueSet/usage-context-typefrom the FHIR Standard | ||||
| PlanDefinition.useContext.value[x] | example | Context of Use ValueSethttp://hl7.org/fhir/ValueSet/use-contextfrom the FHIR Standard | ||||
| PlanDefinition.useContext:cancer-type.code | extensible | Pattern: focushttp://hl7.org/fhir/ValueSet/usage-context-typefrom the FHIR Standard | ||||
| PlanDefinition.useContext:cancer-type.value[x] | required | CancerTypehttps://standards.digital.health.nz/fhir/ValueSet/cancer-type-codefrom this IG | ||||
| PlanDefinition.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdictionfrom the FHIR Standard | ||||
| PlanDefinition.topic | example | DefinitionTopichttp://hl7.org/fhir/ValueSet/definition-topicfrom the FHIR Standard | ||||
| PlanDefinition.goal.category | example | GoalCategoryhttp://hl7.org/fhir/ValueSet/goal-categoryfrom the FHIR Standard | ||||
| PlanDefinition.goal.description | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findingsfrom the FHIR Standard | ||||
| PlanDefinition.goal.priority | preferred | GoalPriorityhttp://hl7.org/fhir/ValueSet/goal-priorityfrom the FHIR Standard | ||||
| PlanDefinition.goal.start | example | GoalStartEventhttp://hl7.org/fhir/ValueSet/goal-start-eventfrom the FHIR Standard | ||||
| PlanDefinition.goal.addresses | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-codefrom the FHIR Standard | ||||
| PlanDefinition.goal.target.measure | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | ||||
| PlanDefinition.action.condition.kind | required | ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.relatedAction.relationship | required | ActionRelationshipTypehttp://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.participant.type | required | ActionParticipantTypehttp://hl7.org/fhir/ValueSet/action-participant-type|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.participant.role | example | ActionParticipantRolehttp://hl7.org/fhir/ValueSet/action-participant-rolefrom the FHIR Standard | ||||
| PlanDefinition.action.groupingBehavior | required | ActionGroupingBehaviorhttp://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.selectionBehavior | required | ActionSelectionBehaviorhttp://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.requiredBehavior | required | ActionRequiredBehaviorhttp://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.action.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.action.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-typefrom the FHIR Standard | ||||
| PlanDefinition.action.action.condition.kind | required | ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.action.relatedAction.relationship | required | ActionRelationshipTypehttp://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.action.participant.type | required | ActionParticipantTypehttp://hl7.org/fhir/ValueSet/action-participant-type|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.action.participant.role | example | ActionParticipantRolehttp://hl7.org/fhir/ValueSet/action-participant-rolefrom the FHIR Standard | ||||
| PlanDefinition.action.action.type | extensible | ActionTypehttp://hl7.org/fhir/ValueSet/action-typefrom the FHIR Standard | ||||
| PlanDefinition.action.action.groupingBehavior | required | ActionGroupingBehaviorhttp://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.action.selectionBehavior | required | ActionSelectionBehaviorhttp://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.action.requiredBehavior | required | ActionRequiredBehaviorhttp://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.action.precheckBehavior | required | ActionPrecheckBehaviorhttp://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.action.cardinalityBehavior | required | ActionCardinalityBehaviorhttp://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1from the FHIR Standard |
This structure is derived from PlanDefinition
Summary
Mandatory: 1 element
Must-Support: 1 element
Prohibited: 17 elements
Extensions
This structure refers to these extensions:
- http://hl7.org.nz/fhir/StructureDefinition/sact-support-factor
- http://hl7.org.nz/fhir/StructureDefinition/sact-regimen-type
- http://hl7.org.nz/fhir/StructureDefinition/sact-replaced-by
- http://hl7.org.nz/fhir/StructureDefinition/sact-treatment-setting
- http://hl7.org.nz/fhir/StructureDefinition/sact-off-label
- http://hl7.org.nz/fhir/StructureDefinition/sact-plan-instructions
- http://hl7.org.nz/fhir/StructureDefinition/sact-disclaimer
- http://hl7.org.nz/fhir/StructureDefinition/sact-additional-details
- http://hl7.org.nz/fhir/StructureDefinition/sact-additional-plan-status
- http://hl7.org.nz/fhir/StructureDefinition/sact-timing-of-days
Slices
This structure defines the following Slices:
- The element PlanDefinition.useContext is sliced based on the value of value:code (Open at End)
Differential View
This structure is derived from PlanDefinition
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PlanDefinition | 0..* | PlanDefinition | The definition of a plan for a series of actions, independent of any specific patient or context | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| support-factor | 0..* | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/sact-support-factor | |
| regimen-type | 0..1 | CodeableConcept | Regimen type URL: http://hl7.org.nz/fhir/StructureDefinition/sact-regimen-type Binding: Regimen type code (required) | |
| replaced-by | 0..1 | Reference(PlanDefinition) | Replaced by URL: http://hl7.org.nz/fhir/StructureDefinition/sact-replaced-by | |
| treatment-setting | 0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/sact-treatment-setting Binding: Treatment setting (required) | |
| offLabel | 0..1 | boolean | Off label URL: http://hl7.org.nz/fhir/StructureDefinition/sact-off-label | |
| plan-instructions | 0..1 | markdown | Instructions for use URL: http://hl7.org.nz/fhir/StructureDefinition/sact-plan-instructions | |
| disclaimer | 0..1 | markdown | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/sact-disclaimer | |
| additionalDetails | 0..* | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/sact-additional-details | |
| type | 0..1 | CodeableConcept | order-set | clinical-protocol | eca-rule | workflow-definition Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: clinical-protocol | |
| status | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| additional-status | 0..1 | code | Regimen under review URL: http://hl7.org.nz/fhir/StructureDefinition/sact-additional-plan-status Binding: PlanDefinition additional status (required) | |
| Slices for useContext | 0..* | UsageContext | 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..1 | CodeableConcept | Value that defines the context | |
| useContext:cancer-type | S | 0..* | UsageContext | The type of cancer |
| code | 1..1 | Coding | Type of context being specified Required Pattern: At least the following | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: focus | |
| value[x] | 1..1 | CodeableConcept, Quantity, Range, Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization) | Value that defines the context Binding: Cancer type (required) | |
| reviewer | 0..0 | |||
| endorser | 0..0 | |||
| library | 0..0 | |||
| goal | 0..0 | |||
| action | 1..1 | BackboneElement | Action defined by the plan | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| action-instructions | 0..1 | markdown | Instructions for use 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..1 | Timing | When the action should take place | |
| type | 0..0 | |||
| precheckBehavior | 0..0 | |||
| cardinalityBehavior | 0..0 | |||
| transform | 0..0 | |||
| dynamicValue | 0..0 | |||
| action | 0..* | BackboneElement | A sub-action | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| action-instructions | 0..1 | markdown | Instructions for use URL: http://hl7.org.nz/fhir/StructureDefinition/sact-plan-instructions | |
| timing-of-days | 0..* | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/sact-timing-of-days | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Conformance | ValueSet | URI |
| PlanDefinition.useContext:cancer-type.value[x] | required | CancerTypehttps://standards.digital.health.nz/fhir/ValueSet/cancer-type-codefrom this IG |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PlanDefinition | C | 0..* | PlanDefinition | The definition of a plan for a series of actions, independent of any specific patient or context pdf-0: Name should be usable as an identifier for the module by machine processing applications such as code generation |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| support-factor | 0..* | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/sact-support-factor | |
| regimen-type | 0..1 | CodeableConcept | Regimen type URL: http://hl7.org.nz/fhir/StructureDefinition/sact-regimen-type Binding: Regimen type code (required) | |
| replaced-by | 0..1 | Reference(PlanDefinition) | Replaced by URL: http://hl7.org.nz/fhir/StructureDefinition/sact-replaced-by | |
| treatment-setting | 0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/sact-treatment-setting Binding: Treatment setting (required) | |
| offLabel | 0..1 | boolean | Off label URL: http://hl7.org.nz/fhir/StructureDefinition/sact-off-label | |
| plan-instructions | 0..1 | markdown | Instructions for use URL: http://hl7.org.nz/fhir/StructureDefinition/sact-plan-instructions | |
| disclaimer | 0..1 | markdown | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/sact-disclaimer | |
| additionalDetails | 0..* | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/sact-additional-details | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| type | Σ | 0..1 | CodeableConcept | order-set | clinical-protocol | eca-rule | workflow-definition Binding: PlanDefinitionType (extensible): The type of PlanDefinition. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: clinical-protocol | |
| status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| additional-status | 0..1 | code | Regimen under review URL: http://hl7.org.nz/fhir/StructureDefinition/sact-additional-plan-status Binding: PlanDefinition additional status (required) | |
| Slices for useContext | Σ | 0..* | UsageContext | 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 | |||
| code | Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. |
| value[x] | Σ | 1..1 | CodeableConcept | Value 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..* | UsageContext | The type of cancer |
| code | Σ | 1..1 | Coding | Type 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 |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: focus | |
| value[x] | Σ | 1..1 | Value that defines the context Binding: Cancer type (required) | |
| valueCodeableConcept | CodeableConcept | |||
| valueQuantity | Quantity | |||
| valueRange | Range | |||
| valueReference | Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization) | |||
| action | 1..1 | BackboneElement | Action defined by the plan | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| action-instructions | 0..1 | markdown | Instructions for use URL: http://hl7.org.nz/fhir/StructureDefinition/sact-plan-instructions | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| timing[x] | 0..1 | Timing | When the action should take place | |
| action | 0..* | BackboneElement | A sub-action | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| action-instructions | 0..1 | markdown | Instructions for use URL: http://hl7.org.nz/fhir/StructureDefinition/sact-plan-instructions | |
| timing-of-days | 0..* | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/sact-timing-of-days | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet / Code | URI |
| PlanDefinition.type | extensible | Pattern: clinical-protocolhttp://hl7.org/fhir/ValueSet/plan-definition-typefrom the FHIR Standard | |
| PlanDefinition.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | |
| PlanDefinition.useContext.code | extensible | UsageContextTypehttp://hl7.org/fhir/ValueSet/usage-context-typefrom the FHIR Standard | |
| PlanDefinition.useContext.value[x] | example | Context of Use ValueSethttp://hl7.org/fhir/ValueSet/use-contextfrom the FHIR Standard | |
| PlanDefinition.useContext:cancer-type.code | extensible | Pattern: focushttp://hl7.org/fhir/ValueSet/usage-context-typefrom the FHIR Standard | |
| PlanDefinition.useContext:cancer-type.value[x] | required | CancerTypehttps://standards.digital.health.nz/fhir/ValueSet/cancer-type-codefrom this IG | |
| PlanDefinition.goal.description | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findingsfrom the FHIR Standard | |
| PlanDefinition.action.condition.kind | required | ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1from the FHIR Standard |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| PlanDefinition | C | 0..* | PlanDefinition | The definition of a plan for a series of actions, independent of any specific patient or context pdf-0: Name should be usable as an identifier for the module by machine processing applications such as code generation | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| support-factor | 0..* | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/sact-support-factor | |||||
| regimen-type | 0..1 | CodeableConcept | Regimen type URL: http://hl7.org.nz/fhir/StructureDefinition/sact-regimen-type Binding: Regimen type code (required) | |||||
| replaced-by | 0..1 | Reference(PlanDefinition) | Replaced by URL: http://hl7.org.nz/fhir/StructureDefinition/sact-replaced-by | |||||
| treatment-setting | 0..1 | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/sact-treatment-setting Binding: Treatment setting (required) | |||||
| offLabel | 0..1 | boolean | Off label URL: http://hl7.org.nz/fhir/StructureDefinition/sact-off-label | |||||
| plan-instructions | 0..1 | markdown | Instructions for use URL: http://hl7.org.nz/fhir/StructureDefinition/sact-plan-instructions | |||||
| disclaimer | 0..1 | markdown | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/sact-disclaimer | |||||
| additionalDetails | 0..* | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/sact-additional-details | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url | Σ | 0..1 | uri | Canonical identifier for this plan definition, represented as a URI (globally unique) | ||||
| identifier | Σ | 0..* | Identifier | Additional identifier for the plan definition | ||||
| version | Σ | 0..1 | string | Business version of the plan definition | ||||
| name | ΣC | 0..1 | string | Name for this plan definition (computer friendly) | ||||
| title | Σ | 0..1 | string | Name for this plan definition (human friendly) | ||||
| subtitle | 0..1 | string | Subordinate title of the plan definition | |||||
| type | Σ | 0..1 | CodeableConcept | order-set | clinical-protocol | eca-rule | workflow-definition Binding: PlanDefinitionType (extensible): The type of PlanDefinition. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: clinical-protocol | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| additional-status | 0..1 | code | Regimen under review URL: http://hl7.org.nz/fhir/StructureDefinition/sact-additional-plan-status Binding: PlanDefinition additional status (required) | |||||
| value | 0..1 | string | Primitive value for code | |||||
| experimental | Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
| subject[x] | 0..1 | Type of individual the plan definition is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). | ||||||
| subjectCodeableConcept | CodeableConcept | |||||||
| subjectReference | Reference(Group) | |||||||
| date | Σ | 0..1 | dateTime | Date last changed | ||||
| publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact | Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description | Σ | 0..1 | markdown | Natural language description of the plan definition | ||||
| Slices for useContext | Σ | 0..* | UsageContext | 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..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| code | Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context. | ||||
| value[x] | Σ | 1..1 | CodeableConcept | Value 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..* | UsageContext | The type of cancer | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| code | Σ | 1..1 | Coding | Type 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 | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 0..1 | uri | Identity of the terminology system | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: focus | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| value[x] | Σ | 1..1 | Value that defines the context Binding: Cancer type (required) | |||||
| valueCodeableConcept | CodeableConcept | |||||||
| valueQuantity | Quantity | |||||||
| valueRange | Range | |||||||
| valueReference | Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization) | |||||||
| jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for plan definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| purpose | 0..1 | markdown | Why this plan definition is defined | |||||
| usage | 0..1 | string | Describes the clinical usage of the plan | |||||
| copyright | 0..1 | markdown | Use and/or publishing restrictions | |||||
| approvalDate | 0..1 | date | When the plan definition was approved by publisher | |||||
| lastReviewDate | 0..1 | date | When the plan definition was last reviewed | |||||
| effectivePeriod | Σ | 0..1 | Period | When the plan definition is expected to be used | ||||
| topic | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering. | |||||
| author | 0..* | ContactDetail | Who authored the content | |||||
| editor | 0..* | ContactDetail | Who edited the content | |||||
| relatedArtifact | 0..* | RelatedArtifact | Additional documentation, citations | |||||
| action | 1..1 | BackboneElement | Action defined by the plan | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| action-instructions | 0..1 | markdown | Instructions for use URL: http://hl7.org.nz/fhir/StructureDefinition/sact-plan-instructions | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| prefix | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.) | |||||
| title | 0..1 | string | User-visible title | |||||
| description | 0..1 | string | Brief description of the action | |||||
| textEquivalent | 0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system | |||||
| documentation | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action | |||||
| goalId | 0..* | id | What goals this action supports | |||||
| relatedAction | 0..* | BackboneElement | Relationship to another action | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| actionId | 1..1 | id | What action is this related to | |||||
| relationship | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions. | |||||
| offset[x] | 0..1 | Time offset for the relationship | ||||||
| offsetDuration | Duration | |||||||
| offsetRange | Range | |||||||
| timing[x] | 0..1 | Timing | When the action should take place | |||||
| participant | 0..* | BackboneElement | Who should participate in the action | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action. | |||||
| role | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example): Defines roles played by participants for the action. | |||||
| groupingBehavior | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group. | |||||
| selectionBehavior | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group. | |||||
| requiredBehavior | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required. | |||||
| definition[x] | 0..1 | Description of the activity to be performed | ||||||
| definitionCanonical | canonical(ActivityDefinition | PlanDefinition | Questionnaire) | |||||||
| definitionUri | uri | |||||||
| action | 0..* | BackboneElement | A sub-action | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| action-instructions | 0..1 | markdown | Instructions for use URL: http://hl7.org.nz/fhir/StructureDefinition/sact-plan-instructions | |||||
| timing-of-days | 0..* | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/sact-timing-of-days | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| prefix | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.) | |||||
| title | 0..1 | string | User-visible title | |||||
| description | 0..1 | string | Brief description of the action | |||||
| textEquivalent | 0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system | |||||
| priority | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |||||
| code | 0..* | CodeableConcept | Code representing the meaning of the action or sub-actions | |||||
| reason | 0..* | CodeableConcept | Why the action should be performed | |||||
| documentation | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action | |||||
| goalId | 0..* | id | What goals this action supports | |||||
| subject[x] | 0..1 | Type of individual the action is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). | ||||||
| subjectCodeableConcept | CodeableConcept | |||||||
| subjectReference | Reference(Group) | |||||||
| trigger | 0..* | TriggerDefinition | When the action should be triggered | |||||
| condition | 0..* | BackboneElement | Whether or not the action is applicable | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| kind | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions. | |||||
| expression | 0..1 | Expression | Boolean-valued expression | |||||
| input | 0..* | DataRequirement | Input data requirements | |||||
| output | 0..* | DataRequirement | Output data definition | |||||
| relatedAction | 0..* | BackboneElement | Relationship to another action | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| actionId | 1..1 | id | What action is this related to | |||||
| relationship | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions. | |||||
| offset[x] | 0..1 | Time offset for the relationship | ||||||
| offsetDuration | Duration | |||||||
| offsetRange | Range | |||||||
| timing[x] | 0..1 | When the action should take place | ||||||
| timingDateTime | dateTime | |||||||
| timingAge | Age | |||||||
| timingPeriod | Period | |||||||
| timingDuration | Duration | |||||||
| timingRange | Range | |||||||
| timingTiming | Timing | |||||||
| participant | 0..* | BackboneElement | Who should participate in the action | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action. | |||||
| role | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example): Defines roles played by participants for the action. | |||||
| type | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed. | |||||
| groupingBehavior | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group. | |||||
| selectionBehavior | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group. | |||||
| requiredBehavior | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required. | |||||
| precheckBehavior | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group. | |||||
| cardinalityBehavior | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated. | |||||
| definition[x] | 0..1 | Description of the activity to be performed | ||||||
| definitionCanonical | canonical(ActivityDefinition | PlanDefinition | Questionnaire) | |||||||
| definitionUri | uri | |||||||
| transform | 0..1 | canonical(StructureMap) | Transform to apply the template | |||||
| dynamicValue | 0..* | BackboneElement | Dynamic aspects of the definition | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| path | 0..1 | string | The path to the element to be set dynamically | |||||
| expression | 0..1 | Expression | An expression that provides the dynamic value for the customization | |||||
| action | 0..* | See action (PlanDefinition) | A sub-action | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet / Code | URI | |||
| PlanDefinition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| PlanDefinition.type | extensible | Pattern: clinical-protocolhttp://hl7.org/fhir/ValueSet/plan-definition-typefrom the FHIR Standard | ||||
| PlanDefinition.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | ||||
| PlanDefinition.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-typefrom the FHIR Standard | ||||
| PlanDefinition.useContext.code | extensible | UsageContextTypehttp://hl7.org/fhir/ValueSet/usage-context-typefrom the FHIR Standard | ||||
| PlanDefinition.useContext.value[x] | example | Context of Use ValueSethttp://hl7.org/fhir/ValueSet/use-contextfrom the FHIR Standard | ||||
| PlanDefinition.useContext:cancer-type.code | extensible | Pattern: focushttp://hl7.org/fhir/ValueSet/usage-context-typefrom the FHIR Standard | ||||
| PlanDefinition.useContext:cancer-type.value[x] | required | CancerTypehttps://standards.digital.health.nz/fhir/ValueSet/cancer-type-codefrom this IG | ||||
| PlanDefinition.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdictionfrom the FHIR Standard | ||||
| PlanDefinition.topic | example | DefinitionTopichttp://hl7.org/fhir/ValueSet/definition-topicfrom the FHIR Standard | ||||
| PlanDefinition.goal.category | example | GoalCategoryhttp://hl7.org/fhir/ValueSet/goal-categoryfrom the FHIR Standard | ||||
| PlanDefinition.goal.description | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findingsfrom the FHIR Standard | ||||
| PlanDefinition.goal.priority | preferred | GoalPriorityhttp://hl7.org/fhir/ValueSet/goal-priorityfrom the FHIR Standard | ||||
| PlanDefinition.goal.start | example | GoalStartEventhttp://hl7.org/fhir/ValueSet/goal-start-eventfrom the FHIR Standard | ||||
| PlanDefinition.goal.addresses | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-codefrom the FHIR Standard | ||||
| PlanDefinition.goal.target.measure | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | ||||
| PlanDefinition.action.condition.kind | required | ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.relatedAction.relationship | required | ActionRelationshipTypehttp://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.participant.type | required | ActionParticipantTypehttp://hl7.org/fhir/ValueSet/action-participant-type|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.participant.role | example | ActionParticipantRolehttp://hl7.org/fhir/ValueSet/action-participant-rolefrom the FHIR Standard | ||||
| PlanDefinition.action.groupingBehavior | required | ActionGroupingBehaviorhttp://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.selectionBehavior | required | ActionSelectionBehaviorhttp://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.requiredBehavior | required | ActionRequiredBehaviorhttp://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.action.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.action.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-typefrom the FHIR Standard | ||||
| PlanDefinition.action.action.condition.kind | required | ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.action.relatedAction.relationship | required | ActionRelationshipTypehttp://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.action.participant.type | required | ActionParticipantTypehttp://hl7.org/fhir/ValueSet/action-participant-type|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.action.participant.role | example | ActionParticipantRolehttp://hl7.org/fhir/ValueSet/action-participant-rolefrom the FHIR Standard | ||||
| PlanDefinition.action.action.type | extensible | ActionTypehttp://hl7.org/fhir/ValueSet/action-typefrom the FHIR Standard | ||||
| PlanDefinition.action.action.groupingBehavior | required | ActionGroupingBehaviorhttp://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.action.selectionBehavior | required | ActionSelectionBehaviorhttp://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.action.requiredBehavior | required | ActionRequiredBehaviorhttp://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.action.precheckBehavior | required | ActionPrecheckBehaviorhttp://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.action.cardinalityBehavior | required | ActionCardinalityBehaviorhttp://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1from the FHIR Standard |
This structure is derived from PlanDefinition
Summary
Mandatory: 1 element
Must-Support: 1 element
Prohibited: 17 elements
Extensions
This structure refers to these extensions:
- http://hl7.org.nz/fhir/StructureDefinition/sact-support-factor
- http://hl7.org.nz/fhir/StructureDefinition/sact-regimen-type
- http://hl7.org.nz/fhir/StructureDefinition/sact-replaced-by
- http://hl7.org.nz/fhir/StructureDefinition/sact-treatment-setting
- http://hl7.org.nz/fhir/StructureDefinition/sact-off-label
- http://hl7.org.nz/fhir/StructureDefinition/sact-plan-instructions
- http://hl7.org.nz/fhir/StructureDefinition/sact-disclaimer
- http://hl7.org.nz/fhir/StructureDefinition/sact-additional-details
- http://hl7.org.nz/fhir/StructureDefinition/sact-additional-plan-status
- http://hl7.org.nz/fhir/StructureDefinition/sact-timing-of-days
Slices
This structure defines the following Slices:
- The element PlanDefinition.useContext is sliced based on the value of value:code (Open at End)
Other representations of profile: CSV, Excel, Schematron