ePath R4 Implementation Guide
1.0.1 - ci-build Japan

ePath R4 Implementation Guide - Local Development build (v1.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: EPath PlanDefinition EP02

Official URL: http://e-path.jp/fhir/ePath/StructureDefinition/EPathPlanDefinitionEP02 Version: 1.0.1
Active as of 2026-02-19 Computable Name: EPathPlanDefinitionEP02

Copyright/Legal: Joint Committee of JAMI and JSCP（日本医療情報学会と日本クリニカルパス学会との合同委員会）. CC(Creative Commons) BY-ND 4.0

施設パス定義

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PlanDefinition C 0..* PlanDefinition The definition of a plan for a series of actions, independent of any specific patient or context
Constraints: pdf-0
... meta Σ 1..1 Meta Metadata about the resource
.... profile SΣ 1..* canonical(StructureDefinition) 本プロファイルを識別するURLとバージョンを指定する。http://e-path.jp/fhir/ePath/StructureDefinition/EPathPlanDefinitionEP02|x.y.z を設定する。
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ePathPlanDefinitionProtocolBase S 0..1 canonical(), uri EPath PlanDefinition ProtocolBase
URL: http://e-path.jp/fhir/ePath/StructureDefinition/EPathPlanDefinitionProtocolBase
.... extension:ePathPlanDefinitionAdaptiveCriteriaText S 1..1 string 適応基準テキスト
URL: http://e-path.jp/fhir/ePath/StructureDefinition/EPathPlanDefinitionAdaptiveCriteriaText
.... extension:ePathPlanDefinitionScheduledDays 0..1 integer パス予定日数
URL: http://e-path.jp/fhir/ePath/StructureDefinition/EPathPlanDefinitionScheduledDays
.... extension:ePathPlanDefinitionClinicalDepartment 0..* CodeableConcept EPath PlanDefinition ClinicalDepartment
URL: http://e-path.jp/fhir/ePath/StructureDefinition/EPathPlanDefinitionClinicalDepartment
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url SΣ 1..1 uri ベースURL/PlanDefinition/EP02.医療機関コード.施設パス識別を設定する。
... Slices for identifier Σ 1..* Identifier Additional identifier for the plan definition
Slice: Unordered, Open by value:system
.... identifier:ePathIdentificationFacility SΣ 1..1 Identifier パス識別（ひな型パス識別）
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri 固定値 http://e-path.jp/fhir/ePath/IdSystem/facility-path-id を設定する。
Fixed Value: http://e-path.jp/fhir/ePath/IdSystem/facility-path-id
..... value SΣ 1..1 string 施設（ローカル）パスコード
Example General: 123456
..... assigner SΣ 1..1 Reference(Organization) 施設パスを管理する医療機関情報（Organization）への参照
...... identifier SΣ 1..1 Identifier Logical reference, when literal reference is not known
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: http://jpfhir.jp/fhir/core/IdSystem/insurance-medical-institution-no
....... value SΣ 1..1 string The value that is unique
Example General: 123456
... version Σ 0..1 string 施設パスのバージョン
... title SΣ 1..1 string 施設パス名称
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... goal S 0..* BackboneElement What the plan is trying to accomplish
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... description 1..1 CodeableConcept Code or text describing the goal
Binding: SNOMEDCTClinicalFindings (example): Describes goals that can be achieved.
.... addresses S 0..* CodeableConcept 病名
Binding: Condition/Problem/DiagnosisCodes (example): Identifies problems, conditions, issues, or concerns that goals may address.
..... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
Binding: JP Core Condition Disease Code MEDIS RecordNo ValueSet (example)
...... coding:masterDiseaseKeyNumber Σ 0..* Coding MEDIS ICD10対応標準病名マスター(管理番号)
Binding: JP Core Condition Disease Code MEDIS RecordNo ValueSet (preferred)
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://medis.or.jp/CodeSystem/master-disease-keyNumber
....... code SΣ 1..1 code Symbol in syntax defined by the system
....... display SΣ 1..1 string Representation defined by the system
...... coding:ICD10-2013-full Σ 0..* Coding MHLW 厚生労働省ICD102013版
Binding: MHLW 厚生労働省ICD102013版 (preferred)
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://jpfhir.jp/fhir/core/mhlw/CodeSystem/ICD10-2013-full
....... code SΣ 1..1 code Symbol in syntax defined by the system
....... display SΣ 1..1 string Representation defined by the system
... action S 0..* BackboneElement 病日・イベント情報
.... id S 1..1 string 病日[-パスステップ]を設定する。
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... title S 1..1 string 病日、またはイベント名称
.... Slices for timing[x] 0..1 フォーム（Questionnaire）などを入力するタイミングを設定する。
Slice: Unordered, Open by type:$this
..... timingDateTime dateTime
..... timingAge Age
..... timingPeriod Period
..... timingDuration Duration
..... timingRange Range
..... timingTiming Timing
..... timing[x]:timingTiming 0..1 Timing When the action should take place
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... repeat SΣC 0..1 Element 繰り返しの定義。例えば、「月水金」や「X年Y月Z日からX年Y月Z日まで」など。id（病日[-パスステップ]）で表現できる場合は設定しなくてもよい。
Constraints: tim-1, tim-2, tim-4, tim-5, tim-6, tim-7, tim-8, tim-9, tim-10
.... definition[x] S 0..1 イベント（EPathPlanDefinitionEvent）、質問（EPathQuestionnaire）への正規URLを指定する。
..... definitionCanonical canonical(EPath PlanDefinition Event | EPath Questionnaire)
..... definitionUri uri

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PlanDefinition.identifier:ePathIdentificationFacility.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
PlanDefinition.identifier:ePathIdentificationFacility.​assigner.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
PlanDefinition.status Base required PublicationStatus 📍4.0.1 FHIR Std.
PlanDefinition.goal.​description Base example SNOMED CT Clinical Findings 📍4.0.1 FHIR Std.
PlanDefinition.goal.​addresses Base example Condition/Problem/Diagnosis Codes 📍4.0.1 FHIR Std.
PlanDefinition.goal.​addresses.coding Base example JP Core Condition Disease Code MEDIS RecordNo ValueSet 📦1.1.0 jpfhir-terminology v1.5
PlanDefinition.goal.​addresses.coding:masterDiseaseKeyNumber Base preferred JP Core Condition Disease Code MEDIS RecordNo ValueSet 📦1.1.0 jpfhir-terminology v1.5
PlanDefinition.goal.​addresses.coding:ICD10-2013-full Base preferred MHLW 厚生労働省ICD102013版 📦1.1.0 jpfhir-terminology v1.5

Constraints

Id Grade Path(s) Description Expression
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 in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-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()
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()
pdf-0 warning PlanDefinition Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
tim-1 error PlanDefinition.action.timing[x]:timingTiming.repeat if there's a duration, there needs to be duration units duration.empty() or durationUnit.exists()
tim-2 error PlanDefinition.action.timing[x]:timingTiming.repeat if there's a period, there needs to be period units period.empty() or periodUnit.exists()
tim-4 error PlanDefinition.action.timing[x]:timingTiming.repeat duration SHALL be a non-negative value duration.exists() implies duration >= 0
tim-5 error PlanDefinition.action.timing[x]:timingTiming.repeat period SHALL be a non-negative value period.exists() implies period >= 0
tim-6 error PlanDefinition.action.timing[x]:timingTiming.repeat If there's a periodMax, there must be a period periodMax.empty() or period.exists()
tim-7 error PlanDefinition.action.timing[x]:timingTiming.repeat If there's a durationMax, there must be a duration durationMax.empty() or duration.exists()
tim-8 error PlanDefinition.action.timing[x]:timingTiming.repeat If there's a countMax, there must be a count countMax.empty() or count.exists()
tim-9 error PlanDefinition.action.timing[x]:timingTiming.repeat If there's an offset, there must be a when (and not C, CM, CD, CV) offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not()))
tim-10 error PlanDefinition.action.timing[x]:timingTiming.repeat If there's a timeOfDay, there cannot be a when, or vice versa timeOfDay.empty() or when.empty()

This structure is derived from PlanDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PlanDefinition PlanDefinition
... meta 1..1 Meta Metadata about the resource
.... profile S 1..* canonical(StructureDefinition) 本プロファイルを識別するURLとバージョンを指定する。http://e-path.jp/fhir/ePath/StructureDefinition/EPathPlanDefinitionEP02|x.y.z を設定する。
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ePathPlanDefinitionProtocolBase S 0..1 canonical(), uri EPath PlanDefinition ProtocolBase
URL: http://e-path.jp/fhir/ePath/StructureDefinition/EPathPlanDefinitionProtocolBase
.... extension:ePathPlanDefinitionAdaptiveCriteriaText S 1..1 string 適応基準テキスト
URL: http://e-path.jp/fhir/ePath/StructureDefinition/EPathPlanDefinitionAdaptiveCriteriaText
.... extension:ePathPlanDefinitionScheduledDays 0..1 integer パス予定日数
URL: http://e-path.jp/fhir/ePath/StructureDefinition/EPathPlanDefinitionScheduledDays
.... extension:ePathPlanDefinitionClinicalDepartment 0..* CodeableConcept EPath PlanDefinition ClinicalDepartment
URL: http://e-path.jp/fhir/ePath/StructureDefinition/EPathPlanDefinitionClinicalDepartment
... url S 1..1 uri ベースURL/PlanDefinition/EP02.医療機関コード.施設パス識別を設定する。
... Slices for identifier 1..* Identifier Additional identifier for the plan definition
Slice: Unordered, Open by value:system
.... identifier:ePathIdentificationFacility S 1..1 Identifier パス識別（ひな型パス識別）
..... system 1..1 uri 固定値 http://e-path.jp/fhir/ePath/IdSystem/facility-path-id を設定する。
Fixed Value: http://e-path.jp/fhir/ePath/IdSystem/facility-path-id
..... value S 1..1 string 施設（ローカル）パスコード
..... assigner S 1..1 Reference(Organization) 施設パスを管理する医療機関情報（Organization）への参照
...... identifier S 1..1 Identifier Logical reference, when literal reference is not known
....... system 1..1 uri The namespace for the identifier value
Fixed Value: http://jpfhir.jp/fhir/core/IdSystem/insurance-medical-institution-no
....... value S 1..1 string The value that is unique
... version 0..1 string 施設パスのバージョン
... title S 1..1 string 施設パス名称
... goal S 0..* BackboneElement What the plan is trying to accomplish
.... addresses S 0..* CodeableConcept 病名
..... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
Binding: JP Core Condition Disease Code MEDIS RecordNo ValueSet (example)
...... coding:masterDiseaseKeyNumber 0..* Coding MEDIS ICD10対応標準病名マスター(管理番号)
Binding: JP Core Condition Disease Code MEDIS RecordNo ValueSet (preferred)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://medis.or.jp/CodeSystem/master-disease-keyNumber
....... code S 1..1 code Symbol in syntax defined by the system
....... display S 1..1 string Representation defined by the system
...... coding:ICD10-2013-full 0..* Coding MHLW 厚生労働省ICD102013版
Binding: MHLW 厚生労働省ICD102013版 (preferred)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://jpfhir.jp/fhir/core/mhlw/CodeSystem/ICD10-2013-full
....... code S 1..1 code Symbol in syntax defined by the system
....... display S 1..1 string Representation defined by the system
... action S 0..* BackboneElement 病日・イベント情報
.... id S 1..1 string 病日[-パスステップ]を設定する。
.... title S 1..1 string 病日、またはイベント名称
.... Slices for timing[x] 0..1 dateTime, Age, Period, Duration, Range, Timing フォーム（Questionnaire）などを入力するタイミングを設定する。
Slice: Unordered, Open by type:$this
..... timing[x]:timingTiming 0..1 Timing When the action should take place
...... repeat S 0..1 Element 繰り返しの定義。例えば、「月水金」や「X年Y月Z日からX年Y月Z日まで」など。id（病日[-パスステップ]）で表現できる場合は設定しなくてもよい。
.... definition[x] S 0..1 イベント（EPathPlanDefinitionEvent）、質問（EPathQuestionnaire）への正規URLを指定する。
..... definitionCanonical canonical(EPath PlanDefinition Event | EPath Questionnaire)
..... definitionUri uri

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
PlanDefinition.goal.​addresses.coding Base example JP Core Condition Disease Code MEDIS RecordNo ValueSet 📦1.1.0 jpfhir-terminology v1.5
PlanDefinition.goal.​addresses.coding:masterDiseaseKeyNumber Base preferred JP Core Condition Disease Code MEDIS RecordNo ValueSet 📦1.1.0 jpfhir-terminology v1.5
PlanDefinition.goal.​addresses.coding:ICD10-2013-full Base preferred MHLW 厚生労働省ICD102013版 📦1.1.0 jpfhir-terminology v1.5
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PlanDefinition C 0..* PlanDefinition The definition of a plan for a series of actions, independent of any specific patient or context
Constraints: pdf-0
... id Σ 0..1 id Logical id of this artifact
... meta Σ 1..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile SΣ 1..* canonical(StructureDefinition) 本プロファイルを識別するURLとバージョンを指定する。http://e-path.jp/fhir/ePath/StructureDefinition/EPathPlanDefinitionEP02|x.y.z を設定する。
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... 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.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ePathPlanDefinitionProtocolBase S 0..1 canonical(), uri EPath PlanDefinition ProtocolBase
URL: http://e-path.jp/fhir/ePath/StructureDefinition/EPathPlanDefinitionProtocolBase
.... extension:ePathPlanDefinitionAdaptiveCriteriaText S 1..1 string 適応基準テキスト
URL: http://e-path.jp/fhir/ePath/StructureDefinition/EPathPlanDefinitionAdaptiveCriteriaText
.... extension:ePathPlanDefinitionScheduledDays 0..1 integer パス予定日数
URL: http://e-path.jp/fhir/ePath/StructureDefinition/EPathPlanDefinitionScheduledDays
.... extension:ePathPlanDefinitionClinicalDepartment 0..* CodeableConcept EPath PlanDefinition ClinicalDepartment
URL: http://e-path.jp/fhir/ePath/StructureDefinition/EPathPlanDefinitionClinicalDepartment
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url SΣ 1..1 uri ベースURL/PlanDefinition/EP02.医療機関コード.施設パス識別を設定する。
... Slices for identifier Σ 1..* Identifier Additional identifier for the plan definition
Slice: Unordered, Open by value:system
.... identifier:ePathIdentificationFacility SΣ 1..1 Identifier パス識別（ひな型パス識別）
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 1..1 uri 固定値 http://e-path.jp/fhir/ePath/IdSystem/facility-path-id を設定する。
Fixed Value: http://e-path.jp/fhir/ePath/IdSystem/facility-path-id
..... value SΣ 1..1 string 施設（ローカル）パスコード
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner SΣ 1..1 Reference(Organization) 施設パスを管理する医療機関情報（Organization）への参照
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier SΣ 1..1 Identifier Logical reference, when literal reference is not known
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
....... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: http://jpfhir.jp/fhir/core/IdSystem/insurance-medical-institution-no
....... value SΣ 1..1 string The value that is unique
Example General: 123456
....... period Σ 0..1 Period Time period when id is/was valid for use
....... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
...... display Σ 0..1 string Text alternative for the resource
... version Σ 0..1 string 施設パスのバージョン
... name ΣC 0..1 string Name for this plan definition (computer friendly)
... title SΣ 1..1 string 施設パス名称
... 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.
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... 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
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for plan definition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
... 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
... reviewer 0..* ContactDetail Who reviewed the content
... endorser 0..* ContactDetail Who endorsed the content
... relatedArtifact 0..* RelatedArtifact Additional documentation, citations
... library 0..* canonical(Library) Logic used by the plan definition
... goal S 0..* BackboneElement What the plan is trying to accomplish
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... category 0..1 CodeableConcept E.g. Treatment, dietary, behavioral
Binding: GoalCategory (example): Example codes for grouping goals for filtering or presentation.
.... description 1..1 CodeableConcept Code or text describing the goal
Binding: SNOMEDCTClinicalFindings (example): Describes goals that can be achieved.
.... priority 0..1 CodeableConcept high-priority | medium-priority | low-priority
Binding: GoalPriority (preferred): Indicates the level of importance associated with reaching or sustaining a goal.
.... start 0..1 CodeableConcept When goal pursuit begins
Binding: GoalStartEvent (example): Identifies the types of events that might trigger the start of a goal.
.... addresses S 0..* CodeableConcept 病名
Binding: Condition/Problem/DiagnosisCodes (example): Identifies problems, conditions, issues, or concerns that goals may address.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
Binding: JP Core Condition Disease Code MEDIS RecordNo ValueSet (example)
...... coding:masterDiseaseKeyNumber Σ 0..* Coding MEDIS ICD10対応標準病名マスター(管理番号)
Binding: JP Core Condition Disease Code MEDIS RecordNo ValueSet (preferred)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://medis.or.jp/CodeSystem/master-disease-keyNumber
....... version Σ 0..1 string Version of the system - if relevant
....... code SΣ 1..1 code Symbol in syntax defined by the system
....... display SΣ 1..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... coding:ICD10-2013-full Σ 0..* Coding MHLW 厚生労働省ICD102013版
Binding: MHLW 厚生労働省ICD102013版 (preferred)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://jpfhir.jp/fhir/core/mhlw/CodeSystem/ICD10-2013-full
....... version Σ 0..1 string Version of the system - if relevant
....... code SΣ 1..1 code Symbol in syntax defined by the system
....... display SΣ 1..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
.... documentation 0..* RelatedArtifact Supporting documentation for the goal
.... target 0..* BackboneElement Target outcome for the goal
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... measure 0..1 CodeableConcept The parameter whose value is to be tracked
Binding: LOINCCodes (example): Identifies types of parameters that can be tracked to determine goal achievement.
..... detail[x] 0..1 The target value to be achieved
...... detailQuantity Quantity
...... detailRange Range
...... detailCodeableConcept CodeableConcept
..... due 0..1 Duration Reach goal within
... action S 0..* BackboneElement 病日・イベント情報
.... id S 1..1 string 病日[-パスステップ]を設定する。
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... prefix 0..1 string User-visible prefix for the action (e.g. 1. or A.)
.... title S 1..1 string 病日、またはイベント名称
.... 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
.... Slices for timing[x] 0..1 フォーム（Questionnaire）などを入力するタイミングを設定する。
Slice: Unordered, Open by type:$this
..... timingDateTime dateTime
..... timingAge Age
..... timingPeriod Period
..... timingDuration Duration
..... timingRange Range
..... timingTiming Timing
..... timing[x]:timingTiming 0..1 Timing When the action should take place
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... event Σ 0..* dateTime When the event occurs
...... repeat SΣC 0..1 Element 繰り返しの定義。例えば、「月水金」や「X年Y月Z日からX年Y月Z日まで」など。id（病日[-パスステップ]）で表現できる場合は設定しなくてもよい。
Constraints: tim-1, tim-2, tim-4, tim-5, tim-6, tim-7, tim-8, tim-9, tim-10
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... bounds[x] Σ 0..1 Length/Range of lengths, or (Start and/or end) limits
........ boundsDuration Duration
........ boundsRange Range
........ boundsPeriod Period
....... count Σ 0..1 positiveInt Number of times to repeat
....... countMax Σ 0..1 positiveInt Maximum number of times to repeat
....... duration Σ 0..1 decimal How long when it happens
....... durationMax Σ 0..1 decimal How long when it happens (Max)
....... durationUnit Σ 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).
....... frequency Σ 0..1 positiveInt Event occurs frequency times per period
....... frequencyMax Σ 0..1 positiveInt Event occurs up to frequencyMax times per period
....... period Σ 0..1 decimal Event occurs frequency times per period
....... periodMax Σ 0..1 decimal Upper limit of period (3-4 hours)
....... periodUnit Σ 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).
....... dayOfWeek Σ 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
....... timeOfDay Σ 0..* time Time of day for action
....... when Σ 0..* code Code for time period of occurrence
Binding: EventTiming (required): Real world event relating to the schedule.
....... offset Σ 0..1 unsignedInt Minutes from event (before or after)
...... code Σ 0..1 CodeableConcept BID | TID | QID | AM | PM | QD | QOD | +
Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern.
.... 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] S 0..1 イベント（EPathPlanDefinitionEvent）、質問（EPathQuestionnaire）への正規URLを指定する。
..... definitionCanonical canonical(EPath PlanDefinition Event | EPath 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PlanDefinition.meta.​security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
PlanDefinition.meta.​tag Base example Common Tags 📍4.0.1 FHIR Std.
PlanDefinition.language Base preferred Common Languages 📍4.0.1 FHIR Std.
PlanDefinition.identifier:ePathIdentificationFacility.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
PlanDefinition.identifier:ePathIdentificationFacility.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
PlanDefinition.identifier:ePathIdentificationFacility.​assigner.type Base extensible ResourceType 📍4.0.1 FHIR Std.
PlanDefinition.identifier:ePathIdentificationFacility.​assigner.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
PlanDefinition.identifier:ePathIdentificationFacility.​assigner.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
PlanDefinition.type Base extensible PlanDefinitionType 📍4.0.1 FHIR Std.
PlanDefinition.status Base required PublicationStatus 📍4.0.1 FHIR Std.
PlanDefinition.subject[x] Base extensible Subject type 📍4.0.1 FHIR Std.
PlanDefinition.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
PlanDefinition.topic Base example DefinitionTopic 📍4.0.1 FHIR Std.
PlanDefinition.goal.​category Base example Goal category 📍4.0.1 FHIR Std.
PlanDefinition.goal.​description Base example SNOMED CT Clinical Findings 📍4.0.1 FHIR Std.
PlanDefinition.goal.​priority Base preferred Goal priority 📍4.0.1 FHIR Std.
PlanDefinition.goal.​start Base example Goal start event 📍4.0.1 FHIR Std.
PlanDefinition.goal.​addresses Base example Condition/Problem/Diagnosis Codes 📍4.0.1 FHIR Std.
PlanDefinition.goal.​addresses.coding Base example JP Core Condition Disease Code MEDIS RecordNo ValueSet 📦1.1.0 jpfhir-terminology v1.5
PlanDefinition.goal.​addresses.coding:masterDiseaseKeyNumber Base preferred JP Core Condition Disease Code MEDIS RecordNo ValueSet 📦1.1.0 jpfhir-terminology v1.5
PlanDefinition.goal.​addresses.coding:ICD10-2013-full Base preferred MHLW 厚生労働省ICD102013版 📦1.1.0 jpfhir-terminology v1.5
PlanDefinition.goal.​target.measure Base example LOINC Codes 📍4.0.1 FHIR Std.
PlanDefinition.action.​priority Base required Request priority 📍4.0.1 FHIR Std.
PlanDefinition.action.​subject[x] Base extensible Subject type 📍4.0.1 FHIR Std.
PlanDefinition.action.​condition.kind Base required ActionConditionKind 📍4.0.1 FHIR Std.
PlanDefinition.action.​relatedAction.relationship Base required ActionRelationshipType 📍4.0.1 FHIR Std.
PlanDefinition.action.​timing[x]:timingTiming.​repeat.durationUnit Base required UnitsOfTime 📍4.0.1 FHIR Std.
PlanDefinition.action.​timing[x]:timingTiming.​repeat.periodUnit Base required UnitsOfTime 📍4.0.1 FHIR Std.
PlanDefinition.action.​timing[x]:timingTiming.​repeat.dayOfWeek Base required DaysOfWeek 📍4.0.1 FHIR Std.
PlanDefinition.action.​timing[x]:timingTiming.​repeat.when Base required EventTiming 📍4.0.1 FHIR Std.
PlanDefinition.action.​timing[x]:timingTiming.​code Base preferred TimingAbbreviation 📍4.0.1 FHIR Std.
PlanDefinition.action.​participant.type Base required ActionParticipantType 📍4.0.1 FHIR Std.
PlanDefinition.action.​participant.role Base example Action participant role 📍4.0.1 FHIR Std.
PlanDefinition.action.​type Base extensible ActionType 📍4.0.1 FHIR Std.
PlanDefinition.action.​groupingBehavior Base required ActionGroupingBehavior 📍4.0.1 FHIR Std.
PlanDefinition.action.​selectionBehavior Base required ActionSelectionBehavior 📍4.0.1 FHIR Std.
PlanDefinition.action.​requiredBehavior Base required ActionRequiredBehavior 📍4.0.1 FHIR Std.
PlanDefinition.action.​precheckBehavior Base required ActionPrecheckBehavior 📍4.0.1 FHIR Std.
PlanDefinition.action.​cardinalityBehavior Base required ActionCardinalityBehavior 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-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()
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()
pdf-0 warning PlanDefinition Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
tim-1 error PlanDefinition.action.timing[x]:timingTiming.repeat if there's a duration, there needs to be duration units duration.empty() or durationUnit.exists()
tim-2 error PlanDefinition.action.timing[x]:timingTiming.repeat if there's a period, there needs to be period units period.empty() or periodUnit.exists()
tim-4 error PlanDefinition.action.timing[x]:timingTiming.repeat duration SHALL be a non-negative value duration.exists() implies duration >= 0
tim-5 error PlanDefinition.action.timing[x]:timingTiming.repeat period SHALL be a non-negative value period.exists() implies period >= 0
tim-6 error PlanDefinition.action.timing[x]:timingTiming.repeat If there's a periodMax, there must be a period periodMax.empty() or period.exists()
tim-7 error PlanDefinition.action.timing[x]:timingTiming.repeat If there's a durationMax, there must be a duration durationMax.empty() or duration.exists()
tim-8 error PlanDefinition.action.timing[x]:timingTiming.repeat If there's a countMax, there must be a count countMax.empty() or count.exists()
tim-9 error PlanDefinition.action.timing[x]:timingTiming.repeat If there's an offset, there must be a when (and not C, CM, CD, CV) offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not()))
tim-10 error PlanDefinition.action.timing[x]:timingTiming.repeat If there's a timeOfDay, there cannot be a when, or vice versa timeOfDay.empty() or when.empty()

This structure is derived from PlanDefinition

Summary

Mandatory: 14 elements(8 nested mandatory elements)
Must-Support: 21 elements
Fixed: 4 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the values of PlanDefinition.identifier
  • The element 1 is sliced based on the values of PlanDefinition.goal.addresses.coding
  • The element 1 is sliced based on the values of PlanDefinition.action.timing[x]

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PlanDefinition C 0..* PlanDefinition The definition of a plan for a series of actions, independent of any specific patient or context
Constraints: pdf-0
... meta Σ 1..1 Meta Metadata about the resource
.... profile SΣ 1..* canonical(StructureDefinition) 本プロファイルを識別するURLとバージョンを指定する。http://e-path.jp/fhir/ePath/StructureDefinition/EPathPlanDefinitionEP02|x.y.z を設定する。
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ePathPlanDefinitionProtocolBase S 0..1 canonical(), uri EPath PlanDefinition ProtocolBase
URL: http://e-path.jp/fhir/ePath/StructureDefinition/EPathPlanDefinitionProtocolBase
.... extension:ePathPlanDefinitionAdaptiveCriteriaText S 1..1 string 適応基準テキスト
URL: http://e-path.jp/fhir/ePath/StructureDefinition/EPathPlanDefinitionAdaptiveCriteriaText
.... extension:ePathPlanDefinitionScheduledDays 0..1 integer パス予定日数
URL: http://e-path.jp/fhir/ePath/StructureDefinition/EPathPlanDefinitionScheduledDays
.... extension:ePathPlanDefinitionClinicalDepartment 0..* CodeableConcept EPath PlanDefinition ClinicalDepartment
URL: http://e-path.jp/fhir/ePath/StructureDefinition/EPathPlanDefinitionClinicalDepartment
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url SΣ 1..1 uri ベースURL/PlanDefinition/EP02.医療機関コード.施設パス識別を設定する。
... Slices for identifier Σ 1..* Identifier Additional identifier for the plan definition
Slice: Unordered, Open by value:system
.... identifier:ePathIdentificationFacility SΣ 1..1 Identifier パス識別（ひな型パス識別）
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri 固定値 http://e-path.jp/fhir/ePath/IdSystem/facility-path-id を設定する。
Fixed Value: http://e-path.jp/fhir/ePath/IdSystem/facility-path-id
..... value SΣ 1..1 string 施設（ローカル）パスコード
Example General: 123456
..... assigner SΣ 1..1 Reference(Organization) 施設パスを管理する医療機関情報（Organization）への参照
...... identifier SΣ 1..1 Identifier Logical reference, when literal reference is not known
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: http://jpfhir.jp/fhir/core/IdSystem/insurance-medical-institution-no
....... value SΣ 1..1 string The value that is unique
Example General: 123456
... version Σ 0..1 string 施設パスのバージョン
... title SΣ 1..1 string 施設パス名称
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... goal S 0..* BackboneElement What the plan is trying to accomplish
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... description 1..1 CodeableConcept Code or text describing the goal
Binding: SNOMEDCTClinicalFindings (example): Describes goals that can be achieved.
.... addresses S 0..* CodeableConcept 病名
Binding: Condition/Problem/DiagnosisCodes (example): Identifies problems, conditions, issues, or concerns that goals may address.
..... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
Binding: JP Core Condition Disease Code MEDIS RecordNo ValueSet (example)
...... coding:masterDiseaseKeyNumber Σ 0..* Coding MEDIS ICD10対応標準病名マスター(管理番号)
Binding: JP Core Condition Disease Code MEDIS RecordNo ValueSet (preferred)
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://medis.or.jp/CodeSystem/master-disease-keyNumber
....... code SΣ 1..1 code Symbol in syntax defined by the system
....... display SΣ 1..1 string Representation defined by the system
...... coding:ICD10-2013-full Σ 0..* Coding MHLW 厚生労働省ICD102013版
Binding: MHLW 厚生労働省ICD102013版 (preferred)
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://jpfhir.jp/fhir/core/mhlw/CodeSystem/ICD10-2013-full
....... code SΣ 1..1 code Symbol in syntax defined by the system
....... display SΣ 1..1 string Representation defined by the system
... action S 0..* BackboneElement 病日・イベント情報
.... id S 1..1 string 病日[-パスステップ]を設定する。
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... title S 1..1 string 病日、またはイベント名称
.... Slices for timing[x] 0..1 フォーム（Questionnaire）などを入力するタイミングを設定する。
Slice: Unordered, Open by type:$this
..... timingDateTime dateTime
..... timingAge Age
..... timingPeriod Period
..... timingDuration Duration
..... timingRange Range
..... timingTiming Timing
..... timing[x]:timingTiming 0..1 Timing When the action should take place
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... repeat SΣC 0..1 Element 繰り返しの定義。例えば、「月水金」や「X年Y月Z日からX年Y月Z日まで」など。id（病日[-パスステップ]）で表現できる場合は設定しなくてもよい。
Constraints: tim-1, tim-2, tim-4, tim-5, tim-6, tim-7, tim-8, tim-9, tim-10
.... definition[x] S 0..1 イベント（EPathPlanDefinitionEvent）、質問（EPathQuestionnaire）への正規URLを指定する。
..... definitionCanonical canonical(EPath PlanDefinition Event | EPath Questionnaire)
..... definitionUri uri

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PlanDefinition.identifier:ePathIdentificationFacility.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
PlanDefinition.identifier:ePathIdentificationFacility.​assigner.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
PlanDefinition.status Base required PublicationStatus 📍4.0.1 FHIR Std.
PlanDefinition.goal.​description Base example SNOMED CT Clinical Findings 📍4.0.1 FHIR Std.
PlanDefinition.goal.​addresses Base example Condition/Problem/Diagnosis Codes 📍4.0.1 FHIR Std.
PlanDefinition.goal.​addresses.coding Base example JP Core Condition Disease Code MEDIS RecordNo ValueSet 📦1.1.0 jpfhir-terminology v1.5
PlanDefinition.goal.​addresses.coding:masterDiseaseKeyNumber Base preferred JP Core Condition Disease Code MEDIS RecordNo ValueSet 📦1.1.0 jpfhir-terminology v1.5
PlanDefinition.goal.​addresses.coding:ICD10-2013-full Base preferred MHLW 厚生労働省ICD102013版 📦1.1.0 jpfhir-terminology v1.5

Constraints

Id Grade Path(s) Description Expression
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 in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-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()
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()
pdf-0 warning PlanDefinition Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
tim-1 error PlanDefinition.action.timing[x]:timingTiming.repeat if there's a duration, there needs to be duration units duration.empty() or durationUnit.exists()
tim-2 error PlanDefinition.action.timing[x]:timingTiming.repeat if there's a period, there needs to be period units period.empty() or periodUnit.exists()
tim-4 error PlanDefinition.action.timing[x]:timingTiming.repeat duration SHALL be a non-negative value duration.exists() implies duration >= 0
tim-5 error PlanDefinition.action.timing[x]:timingTiming.repeat period SHALL be a non-negative value period.exists() implies period >= 0
tim-6 error PlanDefinition.action.timing[x]:timingTiming.repeat If there's a periodMax, there must be a period periodMax.empty() or period.exists()
tim-7 error PlanDefinition.action.timing[x]:timingTiming.repeat If there's a durationMax, there must be a duration durationMax.empty() or duration.exists()
tim-8 error PlanDefinition.action.timing[x]:timingTiming.repeat If there's a countMax, there must be a count countMax.empty() or count.exists()
tim-9 error PlanDefinition.action.timing[x]:timingTiming.repeat If there's an offset, there must be a when (and not C, CM, CD, CV) offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not()))
tim-10 error PlanDefinition.action.timing[x]:timingTiming.repeat If there's a timeOfDay, there cannot be a when, or vice versa timeOfDay.empty() or when.empty()

Differential View

This structure is derived from PlanDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PlanDefinition PlanDefinition
... meta 1..1 Meta Metadata about the resource
.... profile S 1..* canonical(StructureDefinition) 本プロファイルを識別するURLとバージョンを指定する。http://e-path.jp/fhir/ePath/StructureDefinition/EPathPlanDefinitionEP02|x.y.z を設定する。
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ePathPlanDefinitionProtocolBase S 0..1 canonical(), uri EPath PlanDefinition ProtocolBase
URL: http://e-path.jp/fhir/ePath/StructureDefinition/EPathPlanDefinitionProtocolBase
.... extension:ePathPlanDefinitionAdaptiveCriteriaText S 1..1 string 適応基準テキスト
URL: http://e-path.jp/fhir/ePath/StructureDefinition/EPathPlanDefinitionAdaptiveCriteriaText
.... extension:ePathPlanDefinitionScheduledDays 0..1 integer パス予定日数
URL: http://e-path.jp/fhir/ePath/StructureDefinition/EPathPlanDefinitionScheduledDays
.... extension:ePathPlanDefinitionClinicalDepartment 0..* CodeableConcept EPath PlanDefinition ClinicalDepartment
URL: http://e-path.jp/fhir/ePath/StructureDefinition/EPathPlanDefinitionClinicalDepartment
... url S 1..1 uri ベースURL/PlanDefinition/EP02.医療機関コード.施設パス識別を設定する。
... Slices for identifier 1..* Identifier Additional identifier for the plan definition
Slice: Unordered, Open by value:system
.... identifier:ePathIdentificationFacility S 1..1 Identifier パス識別（ひな型パス識別）
..... system 1..1 uri 固定値 http://e-path.jp/fhir/ePath/IdSystem/facility-path-id を設定する。
Fixed Value: http://e-path.jp/fhir/ePath/IdSystem/facility-path-id
..... value S 1..1 string 施設（ローカル）パスコード
..... assigner S 1..1 Reference(Organization) 施設パスを管理する医療機関情報（Organization）への参照
...... identifier S 1..1 Identifier Logical reference, when literal reference is not known
....... system 1..1 uri The namespace for the identifier value
Fixed Value: http://jpfhir.jp/fhir/core/IdSystem/insurance-medical-institution-no
....... value S 1..1 string The value that is unique
... version 0..1 string 施設パスのバージョン
... title S 1..1 string 施設パス名称
... goal S 0..* BackboneElement What the plan is trying to accomplish
.... addresses S 0..* CodeableConcept 病名
..... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
Binding: JP Core Condition Disease Code MEDIS RecordNo ValueSet (example)
...... coding:masterDiseaseKeyNumber 0..* Coding MEDIS ICD10対応標準病名マスター(管理番号)
Binding: JP Core Condition Disease Code MEDIS RecordNo ValueSet (preferred)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://medis.or.jp/CodeSystem/master-disease-keyNumber
....... code S 1..1 code Symbol in syntax defined by the system
....... display S 1..1 string Representation defined by the system
...... coding:ICD10-2013-full 0..* Coding MHLW 厚生労働省ICD102013版
Binding: MHLW 厚生労働省ICD102013版 (preferred)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://jpfhir.jp/fhir/core/mhlw/CodeSystem/ICD10-2013-full
....... code S 1..1 code Symbol in syntax defined by the system
....... display S 1..1 string Representation defined by the system
... action S 0..* BackboneElement 病日・イベント情報
.... id S 1..1 string 病日[-パスステップ]を設定する。
.... title S 1..1 string 病日、またはイベント名称
.... Slices for timing[x] 0..1 dateTime, Age, Period, Duration, Range, Timing フォーム（Questionnaire）などを入力するタイミングを設定する。
Slice: Unordered, Open by type:$this
..... timing[x]:timingTiming 0..1 Timing When the action should take place
...... repeat S 0..1 Element 繰り返しの定義。例えば、「月水金」や「X年Y月Z日からX年Y月Z日まで」など。id（病日[-パスステップ]）で表現できる場合は設定しなくてもよい。
.... definition[x] S 0..1 イベント（EPathPlanDefinitionEvent）、質問（EPathQuestionnaire）への正規URLを指定する。
..... definitionCanonical canonical(EPath PlanDefinition Event | EPath Questionnaire)
..... definitionUri uri

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
PlanDefinition.goal.​addresses.coding Base example JP Core Condition Disease Code MEDIS RecordNo ValueSet 📦1.1.0 jpfhir-terminology v1.5
PlanDefinition.goal.​addresses.coding:masterDiseaseKeyNumber Base preferred JP Core Condition Disease Code MEDIS RecordNo ValueSet 📦1.1.0 jpfhir-terminology v1.5
PlanDefinition.goal.​addresses.coding:ICD10-2013-full Base preferred MHLW 厚生労働省ICD102013版 📦1.1.0 jpfhir-terminology v1.5

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PlanDefinition C 0..* PlanDefinition The definition of a plan for a series of actions, independent of any specific patient or context
Constraints: pdf-0
... id Σ 0..1 id Logical id of this artifact
... meta Σ 1..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile SΣ 1..* canonical(StructureDefinition) 本プロファイルを識別するURLとバージョンを指定する。http://e-path.jp/fhir/ePath/StructureDefinition/EPathPlanDefinitionEP02|x.y.z を設定する。
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... 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.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ePathPlanDefinitionProtocolBase S 0..1 canonical(), uri EPath PlanDefinition ProtocolBase
URL: http://e-path.jp/fhir/ePath/StructureDefinition/EPathPlanDefinitionProtocolBase
.... extension:ePathPlanDefinitionAdaptiveCriteriaText S 1..1 string 適応基準テキスト
URL: http://e-path.jp/fhir/ePath/StructureDefinition/EPathPlanDefinitionAdaptiveCriteriaText
.... extension:ePathPlanDefinitionScheduledDays 0..1 integer パス予定日数
URL: http://e-path.jp/fhir/ePath/StructureDefinition/EPathPlanDefinitionScheduledDays
.... extension:ePathPlanDefinitionClinicalDepartment 0..* CodeableConcept EPath PlanDefinition ClinicalDepartment
URL: http://e-path.jp/fhir/ePath/StructureDefinition/EPathPlanDefinitionClinicalDepartment
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url SΣ 1..1 uri ベースURL/PlanDefinition/EP02.医療機関コード.施設パス識別を設定する。
... Slices for identifier Σ 1..* Identifier Additional identifier for the plan definition
Slice: Unordered, Open by value:system
.... identifier:ePathIdentificationFacility SΣ 1..1 Identifier パス識別（ひな型パス識別）
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 1..1 uri 固定値 http://e-path.jp/fhir/ePath/IdSystem/facility-path-id を設定する。
Fixed Value: http://e-path.jp/fhir/ePath/IdSystem/facility-path-id
..... value SΣ 1..1 string 施設（ローカル）パスコード
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner SΣ 1..1 Reference(Organization) 施設パスを管理する医療機関情報（Organization）への参照
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier SΣ 1..1 Identifier Logical reference, when literal reference is not known
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
....... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: http://jpfhir.jp/fhir/core/IdSystem/insurance-medical-institution-no
....... value SΣ 1..1 string The value that is unique
Example General: 123456
....... period Σ 0..1 Period Time period when id is/was valid for use
....... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
...... display Σ 0..1 string Text alternative for the resource
... version Σ 0..1 string 施設パスのバージョン
... name ΣC 0..1 string Name for this plan definition (computer friendly)
... title SΣ 1..1 string 施設パス名称
... 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.
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... 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
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for plan definition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
... 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
... reviewer 0..* ContactDetail Who reviewed the content
... endorser 0..* ContactDetail Who endorsed the content
... relatedArtifact 0..* RelatedArtifact Additional documentation, citations
... library 0..* canonical(Library) Logic used by the plan definition
... goal S 0..* BackboneElement What the plan is trying to accomplish
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... category 0..1 CodeableConcept E.g. Treatment, dietary, behavioral
Binding: GoalCategory (example): Example codes for grouping goals for filtering or presentation.
.... description 1..1 CodeableConcept Code or text describing the goal
Binding: SNOMEDCTClinicalFindings (example): Describes goals that can be achieved.
.... priority 0..1 CodeableConcept high-priority | medium-priority | low-priority
Binding: GoalPriority (preferred): Indicates the level of importance associated with reaching or sustaining a goal.
.... start 0..1 CodeableConcept When goal pursuit begins
Binding: GoalStartEvent (example): Identifies the types of events that might trigger the start of a goal.
.... addresses S 0..* CodeableConcept 病名
Binding: Condition/Problem/DiagnosisCodes (example): Identifies problems, conditions, issues, or concerns that goals may address.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
Binding: JP Core Condition Disease Code MEDIS RecordNo ValueSet (example)
...... coding:masterDiseaseKeyNumber Σ 0..* Coding MEDIS ICD10対応標準病名マスター(管理番号)
Binding: JP Core Condition Disease Code MEDIS RecordNo ValueSet (preferred)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://medis.or.jp/CodeSystem/master-disease-keyNumber
....... version Σ 0..1 string Version of the system - if relevant
....... code SΣ 1..1 code Symbol in syntax defined by the system
....... display SΣ 1..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... coding:ICD10-2013-full Σ 0..* Coding MHLW 厚生労働省ICD102013版
Binding: MHLW 厚生労働省ICD102013版 (preferred)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://jpfhir.jp/fhir/core/mhlw/CodeSystem/ICD10-2013-full
....... version Σ 0..1 string Version of the system - if relevant
....... code SΣ 1..1 code Symbol in syntax defined by the system
....... display SΣ 1..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
.... documentation 0..* RelatedArtifact Supporting documentation for the goal
.... target 0..* BackboneElement Target outcome for the goal
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... measure 0..1 CodeableConcept The parameter whose value is to be tracked
Binding: LOINCCodes (example): Identifies types of parameters that can be tracked to determine goal achievement.
..... detail[x] 0..1 The target value to be achieved
...... detailQuantity Quantity
...... detailRange Range
...... detailCodeableConcept CodeableConcept
..... due 0..1 Duration Reach goal within
... action S 0..* BackboneElement 病日・イベント情報
.... id S 1..1 string 病日[-パスステップ]を設定する。
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... prefix 0..1 string User-visible prefix for the action (e.g. 1. or A.)
.... title S 1..1 string 病日、またはイベント名称
.... 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
.... Slices for timing[x] 0..1 フォーム（Questionnaire）などを入力するタイミングを設定する。
Slice: Unordered, Open by type:$this
..... timingDateTime dateTime
..... timingAge Age
..... timingPeriod Period
..... timingDuration Duration
..... timingRange Range
..... timingTiming Timing
..... timing[x]:timingTiming 0..1 Timing When the action should take place
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... event Σ 0..* dateTime When the event occurs
...... repeat SΣC 0..1 Element 繰り返しの定義。例えば、「月水金」や「X年Y月Z日からX年Y月Z日まで」など。id（病日[-パスステップ]）で表現できる場合は設定しなくてもよい。
Constraints: tim-1, tim-2, tim-4, tim-5, tim-6, tim-7, tim-8, tim-9, tim-10
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... bounds[x] Σ 0..1 Length/Range of lengths, or (Start and/or end) limits
........ boundsDuration Duration
........ boundsRange Range
........ boundsPeriod Period
....... count Σ 0..1 positiveInt Number of times to repeat
....... countMax Σ 0..1 positiveInt Maximum number of times to repeat
....... duration Σ 0..1 decimal How long when it happens
....... durationMax Σ 0..1 decimal How long when it happens (Max)
....... durationUnit Σ 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).
....... frequency Σ 0..1 positiveInt Event occurs frequency times per period
....... frequencyMax Σ 0..1 positiveInt Event occurs up to frequencyMax times per period
....... period Σ 0..1 decimal Event occurs frequency times per period
....... periodMax Σ 0..1 decimal Upper limit of period (3-4 hours)
....... periodUnit Σ 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).
....... dayOfWeek Σ 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
....... timeOfDay Σ 0..* time Time of day for action
....... when Σ 0..* code Code for time period of occurrence
Binding: EventTiming (required): Real world event relating to the schedule.
....... offset Σ 0..1 unsignedInt Minutes from event (before or after)
...... code Σ 0..1 CodeableConcept BID | TID | QID | AM | PM | QD | QOD | +
Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern.
.... 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] S 0..1 イベント（EPathPlanDefinitionEvent）、質問（EPathQuestionnaire）への正規URLを指定する。
..... definitionCanonical canonical(EPath PlanDefinition Event | EPath 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PlanDefinition.meta.​security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
PlanDefinition.meta.​tag Base example Common Tags 📍4.0.1 FHIR Std.
PlanDefinition.language Base preferred Common Languages 📍4.0.1 FHIR Std.
PlanDefinition.identifier:ePathIdentificationFacility.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
PlanDefinition.identifier:ePathIdentificationFacility.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
PlanDefinition.identifier:ePathIdentificationFacility.​assigner.type Base extensible ResourceType 📍4.0.1 FHIR Std.
PlanDefinition.identifier:ePathIdentificationFacility.​assigner.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
PlanDefinition.identifier:ePathIdentificationFacility.​assigner.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
PlanDefinition.type Base extensible PlanDefinitionType 📍4.0.1 FHIR Std.
PlanDefinition.status Base required PublicationStatus 📍4.0.1 FHIR Std.
PlanDefinition.subject[x] Base extensible Subject type 📍4.0.1 FHIR Std.
PlanDefinition.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
PlanDefinition.topic Base example DefinitionTopic 📍4.0.1 FHIR Std.
PlanDefinition.goal.​category Base example Goal category 📍4.0.1 FHIR Std.
PlanDefinition.goal.​description Base example SNOMED CT Clinical Findings 📍4.0.1 FHIR Std.
PlanDefinition.goal.​priority Base preferred Goal priority 📍4.0.1 FHIR Std.
PlanDefinition.goal.​start Base example Goal start event 📍4.0.1 FHIR Std.
PlanDefinition.goal.​addresses Base example Condition/Problem/Diagnosis Codes 📍4.0.1 FHIR Std.
PlanDefinition.goal.​addresses.coding Base example JP Core Condition Disease Code MEDIS RecordNo ValueSet 📦1.1.0 jpfhir-terminology v1.5
PlanDefinition.goal.​addresses.coding:masterDiseaseKeyNumber Base preferred JP Core Condition Disease Code MEDIS RecordNo ValueSet 📦1.1.0 jpfhir-terminology v1.5
PlanDefinition.goal.​addresses.coding:ICD10-2013-full Base preferred MHLW 厚生労働省ICD102013版 📦1.1.0 jpfhir-terminology v1.5
PlanDefinition.goal.​target.measure Base example LOINC Codes 📍4.0.1 FHIR Std.
PlanDefinition.action.​priority Base required Request priority 📍4.0.1 FHIR Std.
PlanDefinition.action.​subject[x] Base extensible Subject type 📍4.0.1 FHIR Std.
PlanDefinition.action.​condition.kind Base required ActionConditionKind 📍4.0.1 FHIR Std.
PlanDefinition.action.​relatedAction.relationship Base required ActionRelationshipType 📍4.0.1 FHIR Std.
PlanDefinition.action.​timing[x]:timingTiming.​repeat.durationUnit Base required UnitsOfTime 📍4.0.1 FHIR Std.
PlanDefinition.action.​timing[x]:timingTiming.​repeat.periodUnit Base required UnitsOfTime 📍4.0.1 FHIR Std.
PlanDefinition.action.​timing[x]:timingTiming.​repeat.dayOfWeek Base required DaysOfWeek 📍4.0.1 FHIR Std.
PlanDefinition.action.​timing[x]:timingTiming.​repeat.when Base required EventTiming 📍4.0.1 FHIR Std.
PlanDefinition.action.​timing[x]:timingTiming.​code Base preferred TimingAbbreviation 📍4.0.1 FHIR Std.
PlanDefinition.action.​participant.type Base required ActionParticipantType 📍4.0.1 FHIR Std.
PlanDefinition.action.​participant.role Base example Action participant role 📍4.0.1 FHIR Std.
PlanDefinition.action.​type Base extensible ActionType 📍4.0.1 FHIR Std.
PlanDefinition.action.​groupingBehavior Base required ActionGroupingBehavior 📍4.0.1 FHIR Std.
PlanDefinition.action.​selectionBehavior Base required ActionSelectionBehavior 📍4.0.1 FHIR Std.
PlanDefinition.action.​requiredBehavior Base required ActionRequiredBehavior 📍4.0.1 FHIR Std.
PlanDefinition.action.​precheckBehavior Base required ActionPrecheckBehavior 📍4.0.1 FHIR Std.
PlanDefinition.action.​cardinalityBehavior Base required ActionCardinalityBehavior 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-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()
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()
pdf-0 warning PlanDefinition Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
tim-1 error PlanDefinition.action.timing[x]:timingTiming.repeat if there's a duration, there needs to be duration units duration.empty() or durationUnit.exists()
tim-2 error PlanDefinition.action.timing[x]:timingTiming.repeat if there's a period, there needs to be period units period.empty() or periodUnit.exists()
tim-4 error PlanDefinition.action.timing[x]:timingTiming.repeat duration SHALL be a non-negative value duration.exists() implies duration >= 0
tim-5 error PlanDefinition.action.timing[x]:timingTiming.repeat period SHALL be a non-negative value period.exists() implies period >= 0
tim-6 error PlanDefinition.action.timing[x]:timingTiming.repeat If there's a periodMax, there must be a period periodMax.empty() or period.exists()
tim-7 error PlanDefinition.action.timing[x]:timingTiming.repeat If there's a durationMax, there must be a duration durationMax.empty() or duration.exists()
tim-8 error PlanDefinition.action.timing[x]:timingTiming.repeat If there's a countMax, there must be a count countMax.empty() or count.exists()
tim-9 error PlanDefinition.action.timing[x]:timingTiming.repeat If there's an offset, there must be a when (and not C, CM, CD, CV) offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not()))
tim-10 error PlanDefinition.action.timing[x]:timingTiming.repeat If there's a timeOfDay, there cannot be a when, or vice versa timeOfDay.empty() or when.empty()

This structure is derived from PlanDefinition

Summary

Mandatory: 14 elements(8 nested mandatory elements)
Must-Support: 21 elements
Fixed: 4 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the values of PlanDefinition.identifier
  • The element 1 is sliced based on the values of PlanDefinition.goal.addresses.coding
  • The element 1 is sliced based on the values of PlanDefinition.action.timing[x]

 

Other representations of profile: CSV, Excel, Schematron