HL7 FHIR JP Core ImplementationGuide
2.0.0-dev - ci-build
HL7 FHIR JP Core ImplementationGuide - Local Development build (v2.0.0-dev) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
項目 | 内容 |
定義URL | http://jpfhir.jp/fhir/core/StructureDefinition/JP_PlanDefinition_ChemotherapyRegimen |
Version | 2.0.0-dev |
Name | JP_PlanDefinition_ChemotherapyRegimen |
Title | JP Core PlanDefinition ChemotherapyRegimen Profile |
Status | Draft ( 2023-11-30 ) |
Copyright | Copyright FHIR Japanese implementation research working group in Japan Association of Medical Informatics (JAMI) 一般社団法人日本医療情報学会NeXEHRS課題研究会FHIR日本実装検討WG |
このプロファイルはPlanDefinitionリソースに対して、化学療法レジメンの定義に関する情報を送受信するための共通の制約と拡張を定めたものである。
本プロファイルは、化学療法レジメンの定義情報を表現するJP_PlanDefinition_ChemotherapyRegimenリソースの記録・更新・検索を行う上で、準拠するべき必須となる要素や、サポートすべき拡張、用語、検索パラメータを定義する。
本プロファイルは、以下のようなユースケースを想定する。
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from PlanDefinition
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | PlanDefinition | TBD | |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | 【仮】レジメン種別に関する情報 URL: http://jpfhir.jp/fhir/core/Extension/StructureDefinition/JP_PlanDefinition_ChemotherapyRegimen_RegimenType Binding: JP Core PlanDefinition ChemotherapyRegimen RegimenType ValueSet (example) | |
![]() ![]() ![]() |
0..* | UsageContext | 【仮】対象疾患 | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
0..* | (Complex) | Days on which the action should be performed URL: http://hl7.org/fhir/StructureDefinition/timing-daysOfCycle | |
![]() ![]() ![]() ![]() |
0..1 | Timing | 【仮】総サイクル(n日サイクルを n回繰り返す等) | |
![]() ![]() ![]() ![]() |
0..1 | canonical(JP Core ActivityDefinition ChemotherapyRegimen Injection Profile | JP Core ActivityDefinition ChemotherapyRegimen Oral Profile) | 【仮】医薬品情報のActivityDefinitionを参照する | |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | PlanDefinition | TBD cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | 【仮】レジメン種別に関する情報 URL: http://jpfhir.jp/fhir/core/Extension/StructureDefinition/JP_PlanDefinition_ChemotherapyRegimen_RegimenType Binding: JP Core PlanDefinition ChemotherapyRegimen RegimenType ValueSet (example) ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 0..* | UsageContext | 【仮】対象疾患 ele-1: All FHIR elements must have a @value or children |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | PlanDefinition | TBD cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | 【仮】レジメン種別に関する情報 URL: http://jpfhir.jp/fhir/core/Extension/StructureDefinition/JP_PlanDefinition_ChemotherapyRegimen_RegimenType Binding: JP Core PlanDefinition ChemotherapyRegimen RegimenType ValueSet (example) | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Canonical identifier for this plan definition, represented as a URI (globally unique) | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | Additional identifier for the plan definition | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Business version of the plan definition | ||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Name for this plan definition (computer friendly) | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Name for this plan definition (human friendly) | ||||
![]() ![]() ![]() |
0..1 | string | Subordinate title of the plan definition | |||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | order-set | clinical-protocol | eca-rule | workflow-definition Binding: PlanDefinitionType (extensible): The type of PlanDefinition. | ||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
![]() ![]() ![]() |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
![]() ![]() ![]() |
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.). | ||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Reference(Group) | |||||||
![]() ![]() ![]() ![]() |
canonical(MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition) | |||||||
![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date last changed | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
![]() ![]() ![]() |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
![]() ![]() ![]() |
Σ | 0..1 | markdown | Natural language description of the plan definition | ||||
![]() ![]() ![]() |
Σ | 0..* | UsageContext | 【仮】対象疾患 | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Intended jurisdiction for plan definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
![]() ![]() ![]() |
0..1 | markdown | Why this plan definition is defined | |||||
![]() ![]() ![]() |
0..1 | string | Describes the clinical usage of the plan | |||||
![]() ![]() ![]() |
0..1 | markdown | Use and/or publishing restrictions | |||||
![]() ![]() ![]() |
0..1 | date | When the plan definition was approved by publisher | |||||
![]() ![]() ![]() |
0..1 | date | When the plan definition was last reviewed | |||||
![]() ![]() ![]() |
Σ | 0..1 | Period | When the plan definition is expected to be used | ||||
![]() ![]() ![]() |
0..* | CodeableConcept | E.g. Education, Treatment, Assessment Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering. | |||||
![]() ![]() ![]() |
0..* | ContactDetail | Who authored the content | |||||
![]() ![]() ![]() |
0..* | ContactDetail | Who edited the content | |||||
![]() ![]() ![]() |
0..* | ContactDetail | Who reviewed the content | |||||
![]() ![]() ![]() |
0..* | ContactDetail | Who endorsed the content | |||||
![]() ![]() ![]() |
0..* | RelatedArtifact | Additional documentation, citations | |||||
![]() ![]() ![]() |
0..* | canonical(Library) | Logic used by the plan definition | |||||
![]() ![]() ![]() |
0..* | BackboneElement | What the plan is trying to accomplish | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | E.g. Treatment, dietary, behavioral Binding: GoalCategory (example): Example codes for grouping goals for filtering or presentation. | |||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Code or text describing the goal Binding: SNOMEDCTClinicalFindings (example): Describes goals that can be achieved. | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: GoalPriority (preferred): Indicates the level of importance associated with reaching or sustaining a goal. | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | When goal pursuit begins Binding: GoalStartEvent (example): Identifies the types of events that might trigger the start of a goal. | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | What does the goal address Binding: Condition/Problem/DiagnosisCodes (example): Identifies problems, conditions, issues, or concerns that goals may address. | |||||
![]() ![]() ![]() ![]() |
0..* | RelatedArtifact | Supporting documentation for the goal | |||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Target outcome for the goal | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | The parameter whose value is to be tracked Binding: LOINCCodes (example): Identifies types of parameters that can be tracked to determine goal achievement. | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | The target value to be achieved | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Duration | Reach goal within | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Action defined by the plan | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | (Complex) | Days on which the action should be performed URL: http://hl7.org/fhir/StructureDefinition/timing-daysOfCycle | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | string | User-visible prefix for the action (e.g. 1. or A.) | |||||
![]() ![]() ![]() ![]() |
0..1 | string | User-visible title | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Brief description of the action | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system | |||||
![]() ![]() ![]() ![]() |
0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: ActionCode (example): Provides examples of actions to be performed. | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Why the action should be performed Binding: ActionReasonCode (example): Provides examples of reasons for actions to be performed. | |||||
![]() ![]() ![]() ![]() |
0..* | RelatedArtifact | Supporting documentation for the intended performer of the action | |||||
![]() ![]() ![]() ![]() |
0..* | id | What goals this action supports | |||||
![]() ![]() ![]() ![]() |
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.). | ||||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() ![]() |
Reference(Group) | |||||||
![]() ![]() ![]() ![]() ![]() |
canonical(Any) | |||||||
![]() ![]() ![]() ![]() |
0..* | TriggerDefinition | When the action should be triggered | |||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Whether or not the action is applicable | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions. | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Expression | Boolean-valued expression | |||||
![]() ![]() ![]() ![]() |
0..* | DataRequirement | Input data requirements | |||||
![]() ![]() ![]() ![]() |
0..* | DataRequirement | Output data definition | |||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Relationship to another action | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | id | What action is this related to | |||||
![]() ![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Time offset for the relationship | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Duration | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() |
0..1 | Timing | 【仮】総サイクル(n日サイクルを n回繰り返す等) | |||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Who should participate in the action | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action. | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: Action Participant Role (example): Defines roles played by participants for the action. | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed. | |||||
![]() ![]() ![]() ![]() |
0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group. | |||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() |
0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required. | |||||
![]() ![]() ![]() ![]() |
0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group. | |||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() |
0..1 | canonical(JP Core ActivityDefinition ChemotherapyRegimen Injection Profile | JP Core ActivityDefinition ChemotherapyRegimen Oral Profile) | 【仮】医薬品情報のActivityDefinitionを参照する | |||||
![]() ![]() ![]() ![]() |
0..1 | canonical(StructureMap) | Transform to apply the template | |||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Dynamic aspects of the definition | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | The path to the element to be set dynamically | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Expression | An expression that provides the dynamic value for the customization | |||||
![]() ![]() ![]() ![]() |
0..* | See action (PlanDefinition) | A sub-action | |||||
![]() |
Terminology Bindings
Path | Conformance | ValueSet | URI | |||
PlanDefinition.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
PlanDefinition.type | extensible | PlanDefinitionTypehttp://hl7.org/fhir/ValueSet/plan-definition-type from the FHIR Standard | ||||
PlanDefinition.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.3.0 from the FHIR Standard | ||||
PlanDefinition.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-type from the FHIR Standard | ||||
PlanDefinition.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard | ||||
PlanDefinition.topic | example | DefinitionTopichttp://hl7.org/fhir/ValueSet/definition-topic from the FHIR Standard | ||||
PlanDefinition.goal.category | example | GoalCategoryhttp://hl7.org/fhir/ValueSet/goal-category from the FHIR Standard | ||||
PlanDefinition.goal.description | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard | ||||
PlanDefinition.goal.priority | preferred | GoalPriorityhttp://hl7.org/fhir/ValueSet/goal-priority from the FHIR Standard | ||||
PlanDefinition.goal.start | example | GoalStartEventhttp://hl7.org/fhir/ValueSet/goal-start-event from the FHIR Standard | ||||
PlanDefinition.goal.addresses | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard | ||||
PlanDefinition.goal.target.measure | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes from the FHIR Standard | ||||
PlanDefinition.action.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action.code | example | ActionCodehttp://hl7.org/fhir/ValueSet/action-code from the FHIR Standard | ||||
PlanDefinition.action.reason | example | ActionReasonCodehttp://hl7.org/fhir/ValueSet/action-reason-code from the FHIR Standard | ||||
PlanDefinition.action.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-type from the FHIR Standard | ||||
PlanDefinition.action.condition.kind | required | ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action.relatedAction.relationship | required | ActionRelationshipTypehttp://hl7.org/fhir/ValueSet/action-relationship-type|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action.participant.type | required | ActionParticipantTypehttp://hl7.org/fhir/ValueSet/action-participant-type|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action.participant.role | example | ActionParticipantRolehttp://terminology.hl7.org/ValueSet/action-participant-role | ||||
PlanDefinition.action.type | extensible | ActionTypehttp://hl7.org/fhir/ValueSet/action-type from the FHIR Standard | ||||
PlanDefinition.action.groupingBehavior | required | ActionGroupingBehaviorhttp://hl7.org/fhir/ValueSet/action-grouping-behavior|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action.selectionBehavior | required | ActionSelectionBehaviorhttp://hl7.org/fhir/ValueSet/action-selection-behavior|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action.requiredBehavior | required | ActionRequiredBehaviorhttp://hl7.org/fhir/ValueSet/action-required-behavior|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action.precheckBehavior | required | ActionPrecheckBehaviorhttp://hl7.org/fhir/ValueSet/action-precheck-behavior|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action.cardinalityBehavior | required | ActionCardinalityBehaviorhttp://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.3.0 from the FHIR Standard |
Constraints
Id | Grade | Path(s) | Details | Requirements |
cnl-0 | warning | PlanDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}') | |
dom-2 | error | PlanDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | PlanDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | PlanDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | PlanDefinition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | PlanDefinition | A resource should have narrative for robust management : text.`div`.exists() | |
dom-r4b | warning | PlanDefinition.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems : ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic) | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from PlanDefinition
Summary
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from PlanDefinition
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | PlanDefinition | TBD | |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | 【仮】レジメン種別に関する情報 URL: http://jpfhir.jp/fhir/core/Extension/StructureDefinition/JP_PlanDefinition_ChemotherapyRegimen_RegimenType Binding: JP Core PlanDefinition ChemotherapyRegimen RegimenType ValueSet (example) | |
![]() ![]() ![]() |
0..* | UsageContext | 【仮】対象疾患 | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
0..* | (Complex) | Days on which the action should be performed URL: http://hl7.org/fhir/StructureDefinition/timing-daysOfCycle | |
![]() ![]() ![]() ![]() |
0..1 | Timing | 【仮】総サイクル(n日サイクルを n回繰り返す等) | |
![]() ![]() ![]() ![]() |
0..1 | canonical(JP Core ActivityDefinition ChemotherapyRegimen Injection Profile | JP Core ActivityDefinition ChemotherapyRegimen Oral Profile) | 【仮】医薬品情報のActivityDefinitionを参照する | |
![]() |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | PlanDefinition | TBD cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | 【仮】レジメン種別に関する情報 URL: http://jpfhir.jp/fhir/core/Extension/StructureDefinition/JP_PlanDefinition_ChemotherapyRegimen_RegimenType Binding: JP Core PlanDefinition ChemotherapyRegimen RegimenType ValueSet (example) ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 0..* | UsageContext | 【仮】対象疾患 ele-1: All FHIR elements must have a @value or children |
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | PlanDefinition | TBD cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | 【仮】レジメン種別に関する情報 URL: http://jpfhir.jp/fhir/core/Extension/StructureDefinition/JP_PlanDefinition_ChemotherapyRegimen_RegimenType Binding: JP Core PlanDefinition ChemotherapyRegimen RegimenType ValueSet (example) | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Canonical identifier for this plan definition, represented as a URI (globally unique) | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | Additional identifier for the plan definition | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Business version of the plan definition | ||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Name for this plan definition (computer friendly) | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Name for this plan definition (human friendly) | ||||
![]() ![]() ![]() |
0..1 | string | Subordinate title of the plan definition | |||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | order-set | clinical-protocol | eca-rule | workflow-definition Binding: PlanDefinitionType (extensible): The type of PlanDefinition. | ||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
![]() ![]() ![]() |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
![]() ![]() ![]() |
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.). | ||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Reference(Group) | |||||||
![]() ![]() ![]() ![]() |
canonical(MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition) | |||||||
![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date last changed | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
![]() ![]() ![]() |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
![]() ![]() ![]() |
Σ | 0..1 | markdown | Natural language description of the plan definition | ||||
![]() ![]() ![]() |
Σ | 0..* | UsageContext | 【仮】対象疾患 | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Intended jurisdiction for plan definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
![]() ![]() ![]() |
0..1 | markdown | Why this plan definition is defined | |||||
![]() ![]() ![]() |
0..1 | string | Describes the clinical usage of the plan | |||||
![]() ![]() ![]() |
0..1 | markdown | Use and/or publishing restrictions | |||||
![]() ![]() ![]() |
0..1 | date | When the plan definition was approved by publisher | |||||
![]() ![]() ![]() |
0..1 | date | When the plan definition was last reviewed | |||||
![]() ![]() ![]() |
Σ | 0..1 | Period | When the plan definition is expected to be used | ||||
![]() ![]() ![]() |
0..* | CodeableConcept | E.g. Education, Treatment, Assessment Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering. | |||||
![]() ![]() ![]() |
0..* | ContactDetail | Who authored the content | |||||
![]() ![]() ![]() |
0..* | ContactDetail | Who edited the content | |||||
![]() ![]() ![]() |
0..* | ContactDetail | Who reviewed the content | |||||
![]() ![]() ![]() |
0..* | ContactDetail | Who endorsed the content | |||||
![]() ![]() ![]() |
0..* | RelatedArtifact | Additional documentation, citations | |||||
![]() ![]() ![]() |
0..* | canonical(Library) | Logic used by the plan definition | |||||
![]() ![]() ![]() |
0..* | BackboneElement | What the plan is trying to accomplish | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | E.g. Treatment, dietary, behavioral Binding: GoalCategory (example): Example codes for grouping goals for filtering or presentation. | |||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Code or text describing the goal Binding: SNOMEDCTClinicalFindings (example): Describes goals that can be achieved. | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: GoalPriority (preferred): Indicates the level of importance associated with reaching or sustaining a goal. | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | When goal pursuit begins Binding: GoalStartEvent (example): Identifies the types of events that might trigger the start of a goal. | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | What does the goal address Binding: Condition/Problem/DiagnosisCodes (example): Identifies problems, conditions, issues, or concerns that goals may address. | |||||
![]() ![]() ![]() ![]() |
0..* | RelatedArtifact | Supporting documentation for the goal | |||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Target outcome for the goal | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | The parameter whose value is to be tracked Binding: LOINCCodes (example): Identifies types of parameters that can be tracked to determine goal achievement. | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | The target value to be achieved | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Duration | Reach goal within | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Action defined by the plan | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | (Complex) | Days on which the action should be performed URL: http://hl7.org/fhir/StructureDefinition/timing-daysOfCycle | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | string | User-visible prefix for the action (e.g. 1. or A.) | |||||
![]() ![]() ![]() ![]() |
0..1 | string | User-visible title | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Brief description of the action | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system | |||||
![]() ![]() ![]() ![]() |
0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: ActionCode (example): Provides examples of actions to be performed. | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Why the action should be performed Binding: ActionReasonCode (example): Provides examples of reasons for actions to be performed. | |||||
![]() ![]() ![]() ![]() |
0..* | RelatedArtifact | Supporting documentation for the intended performer of the action | |||||
![]() ![]() ![]() ![]() |
0..* | id | What goals this action supports | |||||
![]() ![]() ![]() ![]() |
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.). | ||||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() ![]() |
Reference(Group) | |||||||
![]() ![]() ![]() ![]() ![]() |
canonical(Any) | |||||||
![]() ![]() ![]() ![]() |
0..* | TriggerDefinition | When the action should be triggered | |||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Whether or not the action is applicable | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions. | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Expression | Boolean-valued expression | |||||
![]() ![]() ![]() ![]() |
0..* | DataRequirement | Input data requirements | |||||
![]() ![]() ![]() ![]() |
0..* | DataRequirement | Output data definition | |||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Relationship to another action | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | id | What action is this related to | |||||
![]() ![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Time offset for the relationship | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Duration | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() |
0..1 | Timing | 【仮】総サイクル(n日サイクルを n回繰り返す等) | |||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Who should participate in the action | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action. | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: Action Participant Role (example): Defines roles played by participants for the action. | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed. | |||||
![]() ![]() ![]() ![]() |
0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group. | |||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() |
0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required. | |||||
![]() ![]() ![]() ![]() |
0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group. | |||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() |
0..1 | canonical(JP Core ActivityDefinition ChemotherapyRegimen Injection Profile | JP Core ActivityDefinition ChemotherapyRegimen Oral Profile) | 【仮】医薬品情報のActivityDefinitionを参照する | |||||
![]() ![]() ![]() ![]() |
0..1 | canonical(StructureMap) | Transform to apply the template | |||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Dynamic aspects of the definition | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | The path to the element to be set dynamically | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Expression | An expression that provides the dynamic value for the customization | |||||
![]() ![]() ![]() ![]() |
0..* | See action (PlanDefinition) | A sub-action | |||||
![]() |
Terminology Bindings
Path | Conformance | ValueSet | URI | |||
PlanDefinition.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
PlanDefinition.type | extensible | PlanDefinitionTypehttp://hl7.org/fhir/ValueSet/plan-definition-type from the FHIR Standard | ||||
PlanDefinition.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.3.0 from the FHIR Standard | ||||
PlanDefinition.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-type from the FHIR Standard | ||||
PlanDefinition.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard | ||||
PlanDefinition.topic | example | DefinitionTopichttp://hl7.org/fhir/ValueSet/definition-topic from the FHIR Standard | ||||
PlanDefinition.goal.category | example | GoalCategoryhttp://hl7.org/fhir/ValueSet/goal-category from the FHIR Standard | ||||
PlanDefinition.goal.description | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard | ||||
PlanDefinition.goal.priority | preferred | GoalPriorityhttp://hl7.org/fhir/ValueSet/goal-priority from the FHIR Standard | ||||
PlanDefinition.goal.start | example | GoalStartEventhttp://hl7.org/fhir/ValueSet/goal-start-event from the FHIR Standard | ||||
PlanDefinition.goal.addresses | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard | ||||
PlanDefinition.goal.target.measure | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes from the FHIR Standard | ||||
PlanDefinition.action.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action.code | example | ActionCodehttp://hl7.org/fhir/ValueSet/action-code from the FHIR Standard | ||||
PlanDefinition.action.reason | example | ActionReasonCodehttp://hl7.org/fhir/ValueSet/action-reason-code from the FHIR Standard | ||||
PlanDefinition.action.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-type from the FHIR Standard | ||||
PlanDefinition.action.condition.kind | required | ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action.relatedAction.relationship | required | ActionRelationshipTypehttp://hl7.org/fhir/ValueSet/action-relationship-type|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action.participant.type | required | ActionParticipantTypehttp://hl7.org/fhir/ValueSet/action-participant-type|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action.participant.role | example | ActionParticipantRolehttp://terminology.hl7.org/ValueSet/action-participant-role | ||||
PlanDefinition.action.type | extensible | ActionTypehttp://hl7.org/fhir/ValueSet/action-type from the FHIR Standard | ||||
PlanDefinition.action.groupingBehavior | required | ActionGroupingBehaviorhttp://hl7.org/fhir/ValueSet/action-grouping-behavior|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action.selectionBehavior | required | ActionSelectionBehaviorhttp://hl7.org/fhir/ValueSet/action-selection-behavior|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action.requiredBehavior | required | ActionRequiredBehaviorhttp://hl7.org/fhir/ValueSet/action-required-behavior|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action.precheckBehavior | required | ActionPrecheckBehaviorhttp://hl7.org/fhir/ValueSet/action-precheck-behavior|4.3.0 from the FHIR Standard | ||||
PlanDefinition.action.cardinalityBehavior | required | ActionCardinalityBehaviorhttp://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.3.0 from the FHIR Standard |
Constraints
Id | Grade | Path(s) | Details | Requirements |
cnl-0 | warning | PlanDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}') | |
dom-2 | error | PlanDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | PlanDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | PlanDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | PlanDefinition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | PlanDefinition | A resource should have narrative for robust management : text.`div`.exists() | |
dom-r4b | warning | PlanDefinition.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems : ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic) | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from PlanDefinition
Summary
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron
本プロファイルに準拠するためには、次の項目の値が存在しなければならない。
status : 本リソースのステータス (draft | active | retired | unknown) |
本プロファイルで定義された拡張は次の通りである。
拡張 | 説明 | 定義 | 値型 |
---|---|---|---|
レジメン種別 | レジメン種別の情報を格納する拡張 | [JP_PlanDefinition_ChemotherapyRegimen_RegimenType] | CodeableConcept |
相対投与日 | 開始日からの相対的な投与日付を表現する拡張 《action配下》 |
[JP_PlanDefinition_ChemotherapyRegimen_TimingDaysOfCycle] | integer |
TBD
分類 | 用語集 | CS名 | URI |
---|---|---|---|
レジメン種別 | TBD | TBD | TBD |
本プロファイルで追加定義された制約はない。
本プロファイルで追加された項目は以下の通りである。
本プロファイルに準拠するためには、以下の検索パラメータをサポートしなければならない(SHALL)
検索パラメータidentifierを指定し、レコードIDなどの識別子によりPlanDefinitionを検索
GET [base]/PlanDefinition?identifier={system|}[code]
例:
GET [base]/PlanDefinition?identifier=http://myhospital.com/fhir/PlanDefinition|123
指定された識別子に一致するPlanDefinitionリソースを含むBundleを検索する。
TBD
本プロファイルで追加定義されたオプション検索パラメータはない。
注射薬の場合は JP_ActivityDefinition_ChemotherapyRegimen_Injection を、内服薬の場合は JP_ActivityDefinition_ChemotherapyRegimen_Oral を用いて記述する。 1つの薬剤に対して1つのインスタンスを生成し、当リソースのcontained要素に含め、action#definitionCanonicalとの関連付けを行うこと。
「注射薬A+輸液B」と「内服薬C」の組み合わせを表現したインスタンス例を示す。 *全体像を掴むためのサンプルであるため、薬剤以外の詳細な記述は省略する。
{
"resourceType" : "PlanDefinition",
"contained" : [
{
"resourceType" : "ActivityDefinition",
"id" : "1111",
"contained": [
{
"resourceType": "Medication",
"id": "#1",
"ingredient": [
{ "itemCodeableConcept": { "text": "注射薬A" } },
{ "itemCodeableConcept": { "text": "輸液B" } }
]
},
],
"productReference": { "reference": "Medication/1" }
},
{
"resourceType" : "ActivityDefinition",
"id" : "2222",
"productCodeableConcept" : { "text" : "内服薬C" }
}
],
"action" : [
{
"action": [
{ "definitionCanonical" : "#1111" },
{ "definitionCanonical" : "#2222" }
]
}
]
}
レジメン種別を識別するコードと名称は、PlanDefinitionに対して定義した拡張「JP_PlanDefinition_ChemotherapyRegimen_RegimenType」を使用し、CodeableConcept型を使用して記録する。
TODO: バインドする用語集は検討中"extension": [{
"url": "http://jpfhir.jp/fhir/core/Extension/StructureDefinition/JP_PlanDefinition_ChemotherapyRegimen_RegimenType",
"valueCodeableConcept": {
"coding": [{
"system": "TBD",
"code": "TBD",
"display": "mFOLFOX6"
}],
"text": "mFOLFOX6"
}
}]
TODO: 例えばFOLFOXの場合、「大腸癌」と記述するか、それとも「上行結腸癌」「横行結腸癌」「下行結腸癌」「S状結腸癌」などと細分化して記述するか。また修飾語はJP_Conditionを真似するか。
"useContext": [
{
"code": {
"system": "http://terminology.hl7.org/CodeSystem/usage-context-type",
"code": "focus"
},
"valueCodeableConcept": {
"coding": [
{
"system": "TBD",
"code": "12345"
}
],
"text": "〇〇癌"
}
}
]
投与期間と休薬期間を合わせた1周期(コース)の日数をPlanDefinition.action.timingTiming.repeat.duration要素に記録する。また、コースの繰り返し回数(サイクル数)をPlanDefinition.action.timingTiming.repeat.count要素に記録する。 人間が解釈可能な1コースの期間と、サイクル数のテキスト表現をPlanDefinition.action.textEquivalentに記録する。
「1コース14日を6サイクル繰り返す」のインスタンス例を示す。
"action": [
{
"textEquivalent": "1コース14日を6サイクル繰り返す",
"timingTiming": {
"repeat": {
"count": 6,
"duration": 14,
"durationUnit": "d"
}
}
}
]
「1コース14日を4〜6サイクル繰り返す」のように、サイクル数に幅がある場合、PlanDefinition.action.timingTiming.repeat.countに繰り返し回数の下限を記録し、PlanDefinition.action.timingTiming.repeat.countMaxに上限を記録する。
TODO: 繰り返し数未定(できる限り継続する、PDまでなど)の場合はどうするか。"action": [
{
"textEquivalent": "1コース14日を4〜6サイクル繰り返す",
"timingTiming": {
"repeat": {
"count": 4,
"countMax": 6,
"duration": 14,
"durationUnit": "d"
}
}
}
]
投与開始日からの相対的な投与日を、PlanDefinition.actionに定義した拡張「JP_PlanDefinition_ChemotherapyRegimen_TimingDaysOfCycle」を使用し、integer型を使用して記録する。
「day1 と day8」に投与する場合のインスタンス例を示す。
"action": [{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/timing-daysOfCycle",
"valueInteger": 1
},
{
"url": "http://hl7.org/fhir/StructureDefinition/timing-daysOfCycle",
"valueInteger": 8
}
]
}]
TBD
TBD