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: EPathPlanDefinitionEP02 - Detailed Descriptions

Active as of 2026-02-19

Definitions for the EPathPlanDefinitionEP02 resource profile.

- Key Elements Table
- Differential Elements Table
- Snapshot Elements Table

Guidance on how to interpret the contents of this table can be foundhere

0. PlanDefinition
Definition | This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.
Short | The definition of a plan for a series of actions, independent of any specific patient or context
Control | 0..*
Is Modifier | false
Summary | false
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) 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 (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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) pdf-0: 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}')`) pdf-0: 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}'))
2. PlanDefinition.meta
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Short | Metadata about the resource
Control | 10..1
Type | Meta
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. PlanDefinition.meta.profile
Definition | 本プロファイルを識別するURLとバージョンを指定する。http://e-path.jp/fhir/ePath/StructureDefinition/EPathPlanDefinitionEP02|x.y.z を設定する。 A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.
Short | 本プロファイルを識別するURLとバージョンを指定する。http://e-path.jp/fhir/ePath/StructureDefinition/EPathPlanDefinitionEP02|x.y.z を設定する。Profiles this resource claims to conform to
Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.
Control | 10..*
Type | canonical(StructureDefinition)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. PlanDefinition.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Short | A set of rules under which this content was created
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Control | 0..1
Type | uri
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. PlanDefinition.extension
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | ExtensionAdditional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 10..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing | This element introduces a set of slices on `PlanDefinition.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
10. PlanDefinition.extension:ePathPlanDefinitionProtocolBase
Slice Name | ePathPlanDefinitionProtocolBase
Definition | ひな型パス正規URL
Short | EPath PlanDefinition ProtocolBase
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(EPath PlanDefinition ProtocolBase) (Extension Type: Choice of: canonical, uri)
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
12. PlanDefinition.extension:ePathPlanDefinitionAdaptiveCriteriaText
Slice Name | ePathPlanDefinitionAdaptiveCriteriaText
Definition | 適応基準テキスト（ひな型）
Short | 適応基準テキスト
Control | 1..1 This element is affected by the following invariants: ele-1
Type | Extension(EPath PlanDefinition AdaptiveCriteriaText) (Extension Type: string)
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
14. PlanDefinition.extension:ePathPlanDefinitionScheduledDays
Slice Name | ePathPlanDefinitionScheduledDays
Definition | パス予定日数
Short | パス予定日数
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(EPath PlanDefinition ScheduledDays) (Extension Type: integer)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
16. PlanDefinition.extension:ePathPlanDefinitionClinicalDepartment
Slice Name | ePathPlanDefinitionClinicalDepartment
Definition | 診療科コード・名称（ひな型）
Short | EPath PlanDefinition ClinicalDepartment
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(EPath PlanDefinition ClinicalDepartment) (Extension Type: CodeableConcept)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
18. PlanDefinition.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summary | false
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
20. PlanDefinition.url
Definition | ベースURL/PlanDefinition/EP02.医療機関コード.施設パス識別を設定する。token型で許容される値を用いること。\r\n例）http://e-path.jp/fhir/ePath/PlanDefinition/EP02.2211234567.CN05I00511-L An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this plan definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the plan definition is stored on different servers.
Short | ベースURL/PlanDefinition/EP02.医療機関コード.施設パス識別を設定する。Canonical identifier for this plan definition, represented as a URI (globally unique)
Comments | Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.
Control | 10..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Allows the plan definition to be referenced by a single globally unique identifier.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. PlanDefinition.identifier
Definition | A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
Short | Additional identifier for the plan definition
Comments | Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this plan definition outside of FHIR, where it is not possible to use the logical URI.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 10..*
Type | Identifier
Is Modifier | false
Summary | true
Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the module.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `PlanDefinition.identifier`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ system
24. PlanDefinition.identifier:ePathIdentificationFacility
Slice Name | ePathIdentificationFacility
Definition | パス識別（ひな型パス識別）疾病別ひな型パスを識別するコード、付録1. コード一覧「標準クリニカルパスコード」より設定する。 パスコード・名称・コード体系は、コード一覧「標準クリニカルパスコード」を要素繰り返しの1番目に設定することを必須とし、さらに状態が施設パスとなった以降は、2番目に施設等のローカル内で定めたローカルコード・名称・コード体系を設定することを必須とする。 A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
Short | パス識別（ひな型パス識別）Additional identifier for the plan definition
Comments | Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this plan definition outside of FHIR, where it is not possible to use the logical URI.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 10..1*
Type | Identifier
Is Modifier | false
Must Support | true
Summary | true
Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the module.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. PlanDefinition.identifier:ePathIdentificationFacility.use
Definition | The purpose of this identifier.
Short | usual | official | temp | secondary | old (If known)
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 (required to `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` ) Identifies the purpose for this identifier, if known .
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. PlanDefinition.identifier:ePathIdentificationFacility.system
Definition | 固定値 http://e-path.jp/fhir/ePath/IdSystem/facility-path-id を設定する。注）ePathMassege XML では urn:oid:1.2.392.200250.2.2.50.20 が設定されていた。 Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Short | 固定値 http://e-path.jp/fhir/ePath/IdSystem/facility-path-id を設定する。The namespace for the identifier value
Comments | Identifier.system is always case sensitive.
Control | 10..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Fixed Value | `http://e-path.jp/fhir/ePath/IdSystem/facility-path-id`
Example | General: http://www.acme.com/identifiers/patient
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. PlanDefinition.identifier:ePathIdentificationFacility.value
Definition | 施設（ローカル）パスコード The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Short | 施設（ローカル）パスコードThe value that is unique
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Control | 10..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Example | General: 123456
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. PlanDefinition.identifier:ePathIdentificationFacility.assigner
Definition | 施設パスを管理する医療機関情報（Organization）への参照 Organization that issued/manages the identifier.
Short | 施設パスを管理する医療機関情報（Organization）への参照Organization that issued id (may be just text)
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Control | 10..1
Type | Reference(Organization)
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. PlanDefinition.identifier:ePathIdentificationFacility.assigner.identifier
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Short | Logical reference, when literal reference is not known
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 10..1
Type | Identifier
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. PlanDefinition.identifier:ePathIdentificationFacility.assigner.identifier.use
Definition | The purpose of this identifier.
Short | usual | official | temp | secondary | old (If known)
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 (required to `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` ) Identifies the purpose for this identifier, if known .
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. PlanDefinition.identifier:ePathIdentificationFacility.assigner.identifier.system
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Short | The namespace for the identifier value
Comments | Identifier.system is always case sensitive.
Control | 10..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Fixed Value | `http://jpfhir.jp/fhir/core/IdSystem/insurance-medical-institution-no`
Example | General: http://www.acme.com/identifiers/patient
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. PlanDefinition.identifier:ePathIdentificationFacility.assigner.identifier.value
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Short | The value that is unique
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Control | 10..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Example | General: 123456
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. PlanDefinition.version
Definition | 施設パスのバージョン。X.Yの形式で表す (Xはメジャーバージョン、Yはマイナーバージョン）。マイナーバージョンを表す「.Y」部分は省略してもよい。\r\n当メッセージの「パス状態区分」が「02：施設パス」の場合は、自身のバージョンを、それ以外の場合は継承元の施設パスのバージョンを設定する。設定値は施設パスの管理者が改訂に従い定めること。 The identifier that is used to identify this version of the plan definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the plan definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.
Short | 施設パスのバージョンBusiness version of the plan definition
Comments | There may be different plan definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the plan definition with the format [url]|[version].
Note | This is a business version Id, not a resource version Id (see discussion)
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. PlanDefinition.title
Definition | 施設パス名称 A short, descriptive, user-friendly title for the plan definition.
Short | 施設パス名称Name for this plan definition (human friendly)
Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
Control | 10..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. PlanDefinition.status
Definition | The status of this plan definition. Enables tracking the life-cycle of the content.
Short | draft | active | retired | unknown
Comments | Allows filtering of plan definitions that are appropriate for use versus not.
Control | 1..1
Binding | The codes SHALL be taken from PublicationStatus http://hl7.org/fhir/ValueSet/publication-status|4.0.1 (required to `http://hl7.org/fhir/ValueSet/publication-status|4.0.1` ) The lifecycle status of an artifact.
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. PlanDefinition.goal
Definition | Goals that describe what the activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.
Short | What the plan is trying to accomplish
Control | 0..*
Type | BackboneElement
Is Modifier | false
Must Support | true
Summary | false
Requirements | Goal information needs to be captured for order sets, protocols, and care plan definitions to better describe the objectives of the protocol activities and to guide the creation of specific goals within the derived care plans and orders.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. PlanDefinition.goal.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
52. PlanDefinition.goal.description
Definition | Human-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding".
Short | Code or text describing the goal
Comments | If no code is available, use CodeableConcept.text.
Control | 1..1
Binding | For example codes, see SNOMEDCTClinicalFindings http://hl7.org/fhir/ValueSet/clinical-findings|4.0.1 (example to `http://hl7.org/fhir/ValueSet/clinical-findings|4.0.1` ) Describes goals that can be achieved.
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. PlanDefinition.goal.addresses
Definition | Identifies problems, conditions, issues, or concerns the goal is intended to address.
Short | 病名What does the goal address
Control | 0..*
Binding | For example codes, see Condition/Problem/DiagnosisCodes http://hl7.org/fhir/ValueSet/condition-code|4.0.1 (example to `http://hl7.org/fhir/ValueSet/condition-code|4.0.1` ) Identifies problems, conditions, issues, or concerns that goals may address.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
56. PlanDefinition.goal.addresses.coding
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..*
Binding | For example codes, see For codes, see JP Core Condition Disease Code MEDIS RecordNo ValueSet (example to `http://medis.or.jp/ValueSet/master-disease-keyNumber` )
Type | Coding
Is Modifier | false
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `PlanDefinition.goal.addresses.coding`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ system
58. PlanDefinition.goal.addresses.coding:masterDiseaseKeyNumber
Slice Name | masterDiseaseKeyNumber
Definition | MEDIS ICD10対応標準病名マスター(管理番号) A reference to a code defined by a terminology system.
Short | MEDIS ICD10対応標準病名マスター(管理番号)Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..*
Binding | The codes SHOULD be taken from For codes, see JP Core Condition Disease Code MEDIS RecordNo ValueSet (preferred to `http://medis.or.jp/ValueSet/master-disease-keyNumber` )
Type | Coding
Is Modifier | false
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
60. PlanDefinition.goal.addresses.coding:masterDiseaseKeyNumber.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Control | 10..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Fixed Value | `http://medis.or.jp/CodeSystem/master-disease-keyNumber`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
62. PlanDefinition.goal.addresses.coding:masterDiseaseKeyNumber.code
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Short | Symbol in syntax defined by the system
Control | 10..1
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to refer to a particular code in the system.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
64. PlanDefinition.goal.addresses.coding:masterDiseaseKeyNumber.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Short | Representation defined by the system
Control | 10..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
66. PlanDefinition.goal.addresses.coding:ICD10-2013-full
Slice Name | ICD10-2013-full
Definition | MHLW 厚生労働省ICD102013版 A reference to a code defined by a terminology system.
Short | MHLW 厚生労働省ICD102013版Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..*
Binding | The codes SHOULD be taken from For codes, see MHLW 厚生労働省ICD102013版 (preferred to `http://jpfhir.jp/fhir/core/mhlw/ValueSet/ICD10-2013-full` )
Type | Coding
Is Modifier | false
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
68. PlanDefinition.goal.addresses.coding:ICD10-2013-full.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Control | 10..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Fixed Value | `http://jpfhir.jp/fhir/core/mhlw/CodeSystem/ICD10-2013-full`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
70. PlanDefinition.goal.addresses.coding:ICD10-2013-full.code
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Short | Symbol in syntax defined by the system
Control | 10..1
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to refer to a particular code in the system.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
72. PlanDefinition.goal.addresses.coding:ICD10-2013-full.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Short | Representation defined by the system
Control | 10..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
74. PlanDefinition.action
Definition | 1階層目に病日・イベントを設定する。OATユニット、観察項目はひな型・施設パス 病日・イベント情報（EPathPlanDefinitionEvent）に設定し、definition[x]から参照する。ePathメッセージ構造における繰り返し回数は最小1であるが、適用後パスバンドルに格納する際に省略できるよう最小0とした。 An action or group of actions to be taken as part of the plan.
Short | 病日・イベント情報Action defined by the plan
Comments | Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.
Control | 0..*
Type | BackboneElement
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
76. PlanDefinition.action.id
Definition | 病日[-パスステップ]を設定する。 Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | 病日[-パスステップ]を設定する。Unique id for inter-element referencing
Control | 10..1
Type | string
Is Modifier | false
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
78. PlanDefinition.action.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
80. PlanDefinition.action.title
Definition | 病日、またはイベント名称 The title of the action displayed to a user.
Short | 病日、またはイベント名称User-visible title
Control | 10..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
82. PlanDefinition.action.timing[x]
Definition | フォーム（Questionnaire）などを入力するタイミングを設定する。 An optional value describing when the action should be performed.
Short | フォーム（Questionnaire）などを入力するタイミングを設定する。When the action should take place
Control | 0..1
Type | Choice of: dateTime, Age, Period, Duration, Range, Timing
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `PlanDefinition.action.timing[x]`. The slices areUnordered and Open, and can be differentiated using the following discriminators: type @ $this
84. PlanDefinition.action.timing[x]:timingTiming
Slice Name | timingTiming
Definition | An optional value describing when the action should be performed.
Short | When the action should take place
Control | 0..1
Type | Timing, dateTime, Period, Duration, Range, Age
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
86. PlanDefinition.action.timing[x]:timingTiming.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
88. PlanDefinition.action.timing[x]:timingTiming.repeat
Definition | 繰り返しの定義。例えば、「月水金」や「X年Y月Z日からX年Y月Z日まで」など。id（病日[-パスステップ]）で表現できる場合は設定しなくてもよい。 A set of rules that describe when the event is scheduled.
Short | 繰り返しの定義。例えば、「月水金」や「X年Y月Z日からX年Y月Z日まで」など。id（病日[-パスステップ]）で表現できる場合は設定しなくてもよい。When the event is to occur
Control | 0..1
Type | Element
Is Modifier | false
Must Support | true
Summary | true
Requirements | Many timing schedules are determined by regular repetitions.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) tim-1: if there's a duration, there needs to be duration units (`duration.empty() or durationUnit.exists()`) tim-2: if there's a period, there needs to be period units (`period.empty() or periodUnit.exists()`) tim-4: duration SHALL be a non-negative value (`duration.exists() implies duration >= 0`) tim-5: period SHALL be a non-negative value (`period.exists() implies period >= 0`) tim-6: If there's a periodMax, there must be a period (`periodMax.empty() or period.exists()`) tim-7: If there's a durationMax, there must be a duration (`durationMax.empty() or duration.exists()`) tim-8: If there's a countMax, there must be a count (`countMax.empty() or count.exists()`) tim-9: 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: If there's a timeOfDay, there cannot be a when, or vice versa (`timeOfDay.empty() or when.empty()`) tim-1: if there's a duration, there needs to be duration units (duration.empty() or durationUnit.exists()) tim-2: if there's a period, there needs to be period units (period.empty() or periodUnit.exists()) tim-4: duration SHALL be a non-negative value (duration.exists() implies duration >= 0) tim-5: period SHALL be a non-negative value (period.exists() implies period >= 0) tim-6: If there's a periodMax, there must be a period (periodMax.empty() or period.exists()) tim-7: If there's a durationMax, there must be a duration (durationMax.empty() or duration.exists()) tim-8: If there's a countMax, there must be a count (countMax.empty() or count.exists()) tim-9: 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: If there's a timeOfDay, there cannot be a when, or vice versa (timeOfDay.empty() or when.empty())
90. PlanDefinition.action.definition[x]
Definition | イベント（EPathPlanDefinitionEvent）、質問（EPathQuestionnaire）への正規URLを指定する。 A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken.
Short | イベント（EPathPlanDefinitionEvent）、質問（EPathQuestionnaire）への正規URLを指定する。Description of the activity to be performed
Comments | Note that the definition is optional, and if no definition is specified, a dynamicValue with a root ($this) path can be used to define the entire resource dynamically.
Control | 0..1
Type | Choice of: canonical(EPath PlanDefinition Event, EPath Questionnaire, ActivityDefinition, PlanDefinition, Questionnaire), uri
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be foundhere

0. PlanDefinition
2. PlanDefinition.meta
Control | 1..?
4. PlanDefinition.meta.profile
Definition | 本プロファイルを識別するURLとバージョンを指定する。http://e-path.jp/fhir/ePath/StructureDefinition/EPathPlanDefinitionEP02|x.y.z を設定する。
Short | 本プロファイルを識別するURLとバージョンを指定する。http://e-path.jp/fhir/ePath/StructureDefinition/EPathPlanDefinitionEP02|x.y.z を設定する。
Control | 1..?
Must Support | true
6. PlanDefinition.extension
Control | 1..?
Slicing | This element introduces a set of slices on `PlanDefinition.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
8. PlanDefinition.extension:ePathPlanDefinitionProtocolBase
Slice Name | ePathPlanDefinitionProtocolBase
Control | 0..1
Type | Extension(EPath PlanDefinition ProtocolBase) (Extension Type: Choice of: canonical, uri)
Must Support | true
10. PlanDefinition.extension:ePathPlanDefinitionAdaptiveCriteriaText
Slice Name | ePathPlanDefinitionAdaptiveCriteriaText
Short | 適応基準テキスト
Control | 1..1
Type | Extension(EPath PlanDefinition AdaptiveCriteriaText) (Extension Type: string)
Must Support | true
12. PlanDefinition.extension:ePathPlanDefinitionScheduledDays
Slice Name | ePathPlanDefinitionScheduledDays
Definition | パス予定日数
Short | パス予定日数
Control | 0..1
Type | Extension(EPath PlanDefinition ScheduledDays) (Extension Type: integer)
14. PlanDefinition.extension:ePathPlanDefinitionClinicalDepartment
Slice Name | ePathPlanDefinitionClinicalDepartment
Control | 0..*
Type | Extension(EPath PlanDefinition ClinicalDepartment) (Extension Type: CodeableConcept)
16. PlanDefinition.url
Definition | ベースURL/PlanDefinition/EP02.医療機関コード.施設パス識別を設定する。token型で許容される値を用いること。\r\n例）http://e-path.jp/fhir/ePath/PlanDefinition/EP02.2211234567.CN05I00511-L
Short | ベースURL/PlanDefinition/EP02.医療機関コード.施設パス識別を設定する。
Control | 1..?
Must Support | true
18. PlanDefinition.identifier
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 1..?
Slicing | This element introduces a set of slices on `PlanDefinition.identifier`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ system
20. PlanDefinition.identifier:ePathIdentificationFacility
Slice Name | ePathIdentificationFacility
Definition | パス識別（ひな型パス識別）疾病別ひな型パスを識別するコード、付録1. コード一覧「標準クリニカルパスコード」より設定する。 パスコード・名称・コード体系は、コード一覧「標準クリニカルパスコード」を要素繰り返しの1番目に設定することを必須とし、さらに状態が施設パスとなった以降は、2番目に施設等のローカル内で定めたローカルコード・名称・コード体系を設定することを必須とする。
Short | パス識別（ひな型パス識別）
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 1..1
Must Support | true
22. PlanDefinition.identifier:ePathIdentificationFacility.system
Definition | 固定値 http://e-path.jp/fhir/ePath/IdSystem/facility-path-id を設定する。注）ePathMassege XML では urn:oid:1.2.392.200250.2.2.50.20 が設定されていた。
Short | 固定値 http://e-path.jp/fhir/ePath/IdSystem/facility-path-id を設定する。
Control | 1..?
Must Support | false
Fixed Value | `http://e-path.jp/fhir/ePath/IdSystem/facility-path-id`
24. PlanDefinition.identifier:ePathIdentificationFacility.value
Definition | 施設（ローカル）パスコード
Short | 施設（ローカル）パスコード
Control | 1..?
Must Support | true
26. PlanDefinition.identifier:ePathIdentificationFacility.assigner
Definition | 施設パスを管理する医療機関情報（Organization）への参照
Short | 施設パスを管理する医療機関情報（Organization）への参照
Control | 1..?
Must Support | true
28. PlanDefinition.identifier:ePathIdentificationFacility.assigner.identifier
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 1..?
Must Support | true
30. PlanDefinition.identifier:ePathIdentificationFacility.assigner.identifier.system
Control | 1..?
Fixed Value | `http://jpfhir.jp/fhir/core/IdSystem/insurance-medical-institution-no`
32. PlanDefinition.identifier:ePathIdentificationFacility.assigner.identifier.value
Control | 1..?
Must Support | true
34. PlanDefinition.version
Definition | 施設パスのバージョン。X.Yの形式で表す (Xはメジャーバージョン、Yはマイナーバージョン）。マイナーバージョンを表す「.Y」部分は省略してもよい。\r\n当メッセージの「パス状態区分」が「02：施設パス」の場合は、自身のバージョンを、それ以外の場合は継承元の施設パスのバージョンを設定する。設定値は施設パスの管理者が改訂に従い定めること。
Short | 施設パスのバージョン
Note | This is a business version Id, not a resource version Id (see discussion)
36. PlanDefinition.title
Definition | 施設パス名称
Short | 施設パス名称
Control | 1..?
Must Support | true
38. PlanDefinition.goal
Must Support | true
40. PlanDefinition.goal.addresses
Short | 病名
Must Support | true
42. PlanDefinition.goal.addresses.coding
Binding | For example codes, see JP Core Condition Disease Code MEDIS RecordNo ValueSet (example to `http://medis.or.jp/ValueSet/master-disease-keyNumber` )
Slicing | This element introduces a set of slices on `PlanDefinition.goal.addresses.coding`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ system
44. PlanDefinition.goal.addresses.coding:masterDiseaseKeyNumber
Slice Name | masterDiseaseKeyNumber
Definition | MEDIS ICD10対応標準病名マスター(管理番号)
Short | MEDIS ICD10対応標準病名マスター(管理番号)
Control | 0..*
Binding | The codes SHOULD be taken from JP Core Condition Disease Code MEDIS RecordNo ValueSet (preferred to `http://medis.or.jp/ValueSet/master-disease-keyNumber` )
46. PlanDefinition.goal.addresses.coding:masterDiseaseKeyNumber.system
Control | 1..?
Fixed Value | `http://medis.or.jp/CodeSystem/master-disease-keyNumber`
48. PlanDefinition.goal.addresses.coding:masterDiseaseKeyNumber.code
Control | 1..?
Must Support | true
50. PlanDefinition.goal.addresses.coding:masterDiseaseKeyNumber.display
Control | 1..?
Must Support | true
52. PlanDefinition.goal.addresses.coding:ICD10-2013-full
Slice Name | ICD10-2013-full
Definition | MHLW 厚生労働省ICD102013版
Short | MHLW 厚生労働省ICD102013版
Control | 0..*
Binding | The codes SHOULD be taken from MHLW 厚生労働省ICD102013版 (preferred to `http://jpfhir.jp/fhir/core/mhlw/ValueSet/ICD10-2013-full` )
54. PlanDefinition.goal.addresses.coding:ICD10-2013-full.system
Control | 1..?
Fixed Value | `http://jpfhir.jp/fhir/core/mhlw/CodeSystem/ICD10-2013-full`
56. PlanDefinition.goal.addresses.coding:ICD10-2013-full.code
Control | 1..?
Must Support | true
58. PlanDefinition.goal.addresses.coding:ICD10-2013-full.display
Control | 1..?
Must Support | true
60. PlanDefinition.action
Definition | 1階層目に病日・イベントを設定する。OATユニット、観察項目はひな型・施設パス 病日・イベント情報（EPathPlanDefinitionEvent）に設定し、definition[x]から参照する。ePathメッセージ構造における繰り返し回数は最小1であるが、適用後パスバンドルに格納する際に省略できるよう最小0とした。
Short | 病日・イベント情報
Must Support | true
62. PlanDefinition.action.id
Definition | 病日[-パスステップ]を設定する。
Short | 病日[-パスステップ]を設定する。
Control | 1..?
Must Support | true
64. PlanDefinition.action.title
Definition | 病日、またはイベント名称
Short | 病日、またはイベント名称
Control | 1..?
Must Support | true
66. PlanDefinition.action.timing[x]
Definition | フォーム（Questionnaire）などを入力するタイミングを設定する。
Short | フォーム（Questionnaire）などを入力するタイミングを設定する。
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Slicing | This element introduces a set of slices on `PlanDefinition.action.timing[x]`. The slices areUnordered and Open, and can be differentiated using the following discriminators: type @ $this
68. PlanDefinition.action.timing[x]:timingTiming
Slice Name | timingTiming
Control | 0..1
Type | Timing
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
70. PlanDefinition.action.timing[x]:timingTiming.repeat
Definition | 繰り返しの定義。例えば、「月水金」や「X年Y月Z日からX年Y月Z日まで」など。id（病日[-パスステップ]）で表現できる場合は設定しなくてもよい。
Short | 繰り返しの定義。例えば、「月水金」や「X年Y月Z日からX年Y月Z日まで」など。id（病日[-パスステップ]）で表現できる場合は設定しなくてもよい。
Must Support | true
72. PlanDefinition.action.definition[x]
Definition | イベント（EPathPlanDefinitionEvent）、質問（EPathQuestionnaire）への正規URLを指定する。
Short | イベント（EPathPlanDefinitionEvent）、質問（EPathQuestionnaire）への正規URLを指定する。
Type | Choice of: canonical(EPath PlanDefinition Event, EPath Questionnaire), uri
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles

Guidance on how to interpret the contents of this table can be foundhere

0. PlanDefinition
Definition | This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.
Short | The definition of a plan for a series of actions, independent of any specific patient or context
Control | 0..*
Is Modifier | false
Summary | false
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (`contained.contained.empty()`) 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 (`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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (`contained.meta.security.empty()`) dom-6: A resource should have narrative for robust management (`text.`div`.exists()`) pdf-0: 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}')`)
2. PlanDefinition.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Short | Logical id of this artifact
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Control | 0..1
Type | id
Is Modifier | false
Summary | true
4. PlanDefinition.meta
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Short | Metadata about the resource
Control | 1..1
Type | Meta
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
6. PlanDefinition.meta.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
8. PlanDefinition.meta.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `PlanDefinition.meta.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
10. PlanDefinition.meta.versionId
Definition | The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.
Short | Version specific identifier
Comments | The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
Control | 0..1
Type | id
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
12. PlanDefinition.meta.lastUpdated
Definition | When the resource last changed - e.g. when the version changed.
Short | When the resource version last changed
Comments | This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.
Control | 0..1
Type | instant
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
14. PlanDefinition.meta.source
Definition | A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.
Short | Identifies where the resource comes from
Comments | In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.
Control | 0..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
16. PlanDefinition.meta.profile
Definition | 本プロファイルを識別するURLとバージョンを指定する。http://e-path.jp/fhir/ePath/StructureDefinition/EPathPlanDefinitionEP02|x.y.z を設定する。
Short | 本プロファイルを識別するURLとバージョンを指定する。http://e-path.jp/fhir/ePath/StructureDefinition/EPathPlanDefinitionEP02|x.y.z を設定する。
Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.
Control | 1..*
Type | canonical(StructureDefinition)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
18. PlanDefinition.meta.security
Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
Short | Security Labels applied to this resource
Comments | The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.
Control | 0..*
Binding | Unless not suitable, these codes SHALL be taken from All Security Labels (extensible to `http://hl7.org/fhir/ValueSet/security-labels|4.0.1` ) Security Labels from the Healthcare Privacy and Security Classification System.
Type | Coding
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
20. PlanDefinition.meta.tag
Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
Short | Tags applied to this resource
Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.
Control | 0..*
Binding | For example codes, see CommonTags (example to `http://hl7.org/fhir/ValueSet/common-tags|4.0.1` ) Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
Type | Coding
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
22. PlanDefinition.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Short | A set of rules under which this content was created
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Control | 0..1
Type | uri
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
24. PlanDefinition.language
Definition | The base language in which the resource is written.
Short | Language of the resource content
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Control | 0..1
Binding | The codes SHOULD be taken from CommonLanguages (preferred to `http://hl7.org/fhir/ValueSet/languages|4.0.1` ) A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
26. PlanDefinition.text
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Short | Text summary of the resource, for human interpretation
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Control | 0..1
Type | Narrative
Is Modifier | false
Summary | false
Alternate Names | narrative, html, xhtml, display
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
28. PlanDefinition.contained
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Short | Contained, inline Resources
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Control | 0..*
Type | Resource
Is Modifier | false
Summary | false
Alternate Names | inline resources, anonymous resources, contained resources
30. PlanDefinition.extension
Definition | An Extension
Short | Extension
Control | 1..*
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `PlanDefinition.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
32. PlanDefinition.extension:ePathPlanDefinitionProtocolBase
Slice Name | ePathPlanDefinitionProtocolBase
Definition | ひな型パス正規URL
Short | EPath PlanDefinition ProtocolBase
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(EPath PlanDefinition ProtocolBase) (Extension Type: Choice of: canonical, uri)
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
34. PlanDefinition.extension:ePathPlanDefinitionAdaptiveCriteriaText
Slice Name | ePathPlanDefinitionAdaptiveCriteriaText
Definition | 適応基準テキスト（ひな型）
Short | 適応基準テキスト
Control | 1..1 This element is affected by the following invariants: ele-1
Type | Extension(EPath PlanDefinition AdaptiveCriteriaText) (Extension Type: string)
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
36. PlanDefinition.extension:ePathPlanDefinitionScheduledDays
Slice Name | ePathPlanDefinitionScheduledDays
Definition | パス予定日数
Short | パス予定日数
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(EPath PlanDefinition ScheduledDays) (Extension Type: integer)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
38. PlanDefinition.extension:ePathPlanDefinitionClinicalDepartment
Slice Name | ePathPlanDefinitionClinicalDepartment
Definition | 診療科コード・名称（ひな型）
Short | EPath PlanDefinition ClinicalDepartment
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(EPath PlanDefinition ClinicalDepartment) (Extension Type: CodeableConcept)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
40. PlanDefinition.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summary | false
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
42. PlanDefinition.url
Definition | ベースURL/PlanDefinition/EP02.医療機関コード.施設パス識別を設定する。token型で許容される値を用いること。\r\n例）http://e-path.jp/fhir/ePath/PlanDefinition/EP02.2211234567.CN05I00511-L
Short | ベースURL/PlanDefinition/EP02.医療機関コード.施設パス識別を設定する。
Comments | Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.
Control | 1..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Allows the plan definition to be referenced by a single globally unique identifier.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
44. PlanDefinition.identifier
Definition | A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
Short | Additional identifier for the plan definition
Comments | Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this plan definition outside of FHIR, where it is not possible to use the logical URI.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 1..*
Type | Identifier
Is Modifier | false
Summary | true
Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the module.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `PlanDefinition.identifier`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ system
46. PlanDefinition.identifier:ePathIdentificationFacility
Slice Name | ePathIdentificationFacility
Definition | パス識別（ひな型パス識別）疾病別ひな型パスを識別するコード、付録1. コード一覧「標準クリニカルパスコード」より設定する。 パスコード・名称・コード体系は、コード一覧「標準クリニカルパスコード」を要素繰り返しの1番目に設定することを必須とし、さらに状態が施設パスとなった以降は、2番目に施設等のローカル内で定めたローカルコード・名称・コード体系を設定することを必須とする。
Short | パス識別（ひな型パス識別）
Comments | Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this plan definition outside of FHIR, where it is not possible to use the logical URI.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 1..1
Type | Identifier
Is Modifier | false
Must Support | true
Summary | true
Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the module.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
48. PlanDefinition.identifier:ePathIdentificationFacility.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
50. PlanDefinition.identifier:ePathIdentificationFacility.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `PlanDefinition.identifier.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
52. PlanDefinition.identifier:ePathIdentificationFacility.use
Definition | The purpose of this identifier.
Short | usual | official | temp | secondary | old (If known)
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse (required to `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` ) Identifies the purpose for this identifier, if known .
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
54. PlanDefinition.identifier:ePathIdentificationFacility.type
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Short | Description of identifier
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from Identifier Type Codes (extensible to `http://hl7.org/fhir/ValueSet/identifier-type|4.0.1` ) A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Type | CodeableConcept
Is Modifier | false
Summary | true
Requirements | Allows users to make use of identifiers when the identifier system is not known.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
56. PlanDefinition.identifier:ePathIdentificationFacility.system
Definition | 固定値 http://e-path.jp/fhir/ePath/IdSystem/facility-path-id を設定する。注）ePathMassege XML では urn:oid:1.2.392.200250.2.2.50.20 が設定されていた。
Short | 固定値 http://e-path.jp/fhir/ePath/IdSystem/facility-path-id を設定する。
Comments | Identifier.system is always case sensitive.
Control | 1..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Fixed Value | `http://e-path.jp/fhir/ePath/IdSystem/facility-path-id`
Example | General: http://www.acme.com/identifiers/patient
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
58. PlanDefinition.identifier:ePathIdentificationFacility.value
Definition | 施設（ローカル）パスコード
Short | 施設（ローカル）パスコード
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Example | General: 123456
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
60. PlanDefinition.identifier:ePathIdentificationFacility.period
Definition | Time period during which identifier is/was valid for use.
Short | Time period when id is/was valid for use
Control | 0..1
Type | Period
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
62. PlanDefinition.identifier:ePathIdentificationFacility.assigner
Definition | 施設パスを管理する医療機関情報（Organization）への参照
Short | 施設パスを管理する医療機関情報（Organization）への参照
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Control | 1..1
Type | Reference(Organization)
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
64. PlanDefinition.identifier:ePathIdentificationFacility.assigner.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
66. PlanDefinition.identifier:ePathIdentificationFacility.assigner.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `PlanDefinition.identifier.assigner.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
68. PlanDefinition.identifier:ePathIdentificationFacility.assigner.reference
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Short | Literal reference, Relative, internal or absolute URL
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Control | 0..1 This element is affected by the following invariants: ref-1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
70. PlanDefinition.identifier:ePathIdentificationFacility.assigner.type
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Short | Type the reference refers to (e.g. "Patient")
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from ResourceType (extensible to `http://hl7.org/fhir/ValueSet/resource-types|4.0.1` ) Aa resource (or, for logical models, the URI of the logical model).
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
72. PlanDefinition.identifier:ePathIdentificationFacility.assigner.identifier
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Short | Logical reference, when literal reference is not known
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 1..1
Type | Identifier
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
74. PlanDefinition.identifier:ePathIdentificationFacility.assigner.identifier.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
76. PlanDefinition.identifier:ePathIdentificationFacility.assigner.identifier.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `PlanDefinition.identifier.assigner.identifier.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
78. PlanDefinition.identifier:ePathIdentificationFacility.assigner.identifier.use
Definition | The purpose of this identifier.
Short | usual | official | temp | secondary | old (If known)
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse (required to `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` ) Identifies the purpose for this identifier, if known .
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
80. PlanDefinition.identifier:ePathIdentificationFacility.assigner.identifier.type
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Short | Description of identifier
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from Identifier Type Codes (extensible to `http://hl7.org/fhir/ValueSet/identifier-type|4.0.1` ) A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Type | CodeableConcept
Is Modifier | false
Summary | true
Requirements | Allows users to make use of identifiers when the identifier system is not known.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
82. PlanDefinition.identifier:ePathIdentificationFacility.assigner.identifier.system
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Short | The namespace for the identifier value
Comments | Identifier.system is always case sensitive.
Control | 1..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Fixed Value | `http://jpfhir.jp/fhir/core/IdSystem/insurance-medical-institution-no`
Example | General: http://www.acme.com/identifiers/patient
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
84. PlanDefinition.identifier:ePathIdentificationFacility.assigner.identifier.value
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Short | The value that is unique
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Example | General: 123456
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
86. PlanDefinition.identifier:ePathIdentificationFacility.assigner.identifier.period
Definition | Time period during which identifier is/was valid for use.
Short | Time period when id is/was valid for use
Control | 0..1
Type | Period
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
88. PlanDefinition.identifier:ePathIdentificationFacility.assigner.identifier.assigner
Definition | Organization that issued/manages the identifier.
Short | Organization that issued id (may be just text)
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Control | 0..1
Type | Reference(Organization)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
90. PlanDefinition.identifier:ePathIdentificationFacility.assigner.display
Definition | Plain text narrative that identifies the resource in addition to the resource reference.
Short | Text alternative for the resource
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
92. PlanDefinition.version
Definition | 施設パスのバージョン。X.Yの形式で表す (Xはメジャーバージョン、Yはマイナーバージョン）。マイナーバージョンを表す「.Y」部分は省略してもよい。\r\n当メッセージの「パス状態区分」が「02：施設パス」の場合は、自身のバージョンを、それ以外の場合は継承元の施設パスのバージョンを設定する。設定値は施設パスの管理者が改訂に従い定めること。
Short | 施設パスのバージョン
Comments | There may be different plan definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the plan definition with the format [url]|[version].
Note | This is a business version Id, not a resource version Id (see discussion)
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
94. PlanDefinition.name
Definition | A natural language name identifying the plan definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
Short | Name for this plan definition (computer friendly)
Comments | The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.
Control | 0..1 This element is affected by the following invariants: inv-0
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Support human navigation and code generation.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
96. PlanDefinition.title
Definition | 施設パス名称
Short | 施設パス名称
Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
98. PlanDefinition.subtitle
Definition | An explanatory or alternate title for the plan definition giving additional information about its content.
Short | Subordinate title of the plan definition
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
100. PlanDefinition.type
Definition | A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition.
Short | order-set | clinical-protocol | eca-rule | workflow-definition
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from PlanDefinitionType (extensible to `http://hl7.org/fhir/ValueSet/plan-definition-type|4.0.1` ) The type of PlanDefinition.
Type | CodeableConcept
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
102. PlanDefinition.status
Definition | The status of this plan definition. Enables tracking the life-cycle of the content.
Short | draft | active | retired | unknown
Comments | Allows filtering of plan definitions that are appropriate for use versus not.
Control | 1..1
Binding | The codes SHALL be taken from PublicationStatus (required to `http://hl7.org/fhir/ValueSet/publication-status|4.0.1` ) The lifecycle status of an artifact.
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
104. PlanDefinition.experimental
Definition | A Boolean value to indicate that this plan definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
Short | For testing purposes, not real usage
Comments | Allows filtering of plan definitions that are appropriate for use versus not.
Control | 0..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Enables experimental content to be developed following the same lifecycle that would be used for a production-level plan definition.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
106. PlanDefinition.subject[x]
Definition | A code or group definition that describes the intended subject of the plan definition.
Short | Type of individual the plan definition is focused on
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from SubjectType (extensible to `http://hl7.org/fhir/ValueSet/subject-type|4.0.1` ) The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
Type | Choice of: CodeableConcept, Reference(Group)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | false
Meaning if Missing | Patient
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
108. PlanDefinition.date
Definition | The date (and optionally time) when the plan definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the plan definition changes.
Short | Date last changed
Comments | Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the plan definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
Control | 0..1
Type | dateTime
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Alternate Names | Revision Date
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
110. PlanDefinition.publisher
Definition | The name of the organization or individual that published the plan definition.
Short | Name of the publisher (organization or individual)
Comments | Usually an organization but may be an individual. The publisher (or steward) of the plan definition is the organization or individual primarily responsible for the maintenance and upkeep of the plan definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the plan definition. This item SHOULD be populated unless the information is available from context.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Helps establish the "authority/credibility" of the plan definition. May also allow for contact.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
112. PlanDefinition.contact
Definition | Contact details to assist a user in finding and communicating with the publisher.
Short | Contact details for the publisher
Comments | May be a web site, an email address, a telephone number, etc.
Control | 0..*
Type | ContactDetail
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
114. PlanDefinition.description
Definition | A free text natural language description of the plan definition from a consumer's perspective.
Short | Natural language description of the plan definition
Comments | This description can be used to capture details such as why the plan definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the plan definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the plan definition is presumed to be the predominant language in the place the plan definition was created).
Control | 0..1
Type | markdown
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
116. PlanDefinition.useContext
Definition | The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances.
Short | The context that the content is intended to support
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
Control | 0..*
Type | UsageContext
Is Modifier | false
Summary | true
Requirements | Assist in searching for appropriate content.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
118. PlanDefinition.jurisdiction
Definition | A legal or geographic region in which the plan definition is intended to be used.
Short | Intended jurisdiction for plan definition (if applicable)
Comments | It may be possible for the plan definition to be used in jurisdictions other than those for which it was originally designed or intended.
Control | 0..*
Binding | Unless not suitable, these codes SHALL be taken from Jurisdiction ValueSet (extensible to `http://hl7.org/fhir/ValueSet/jurisdiction|4.0.1` ) Countries and regions within which this artifact is targeted for use.
Type | CodeableConcept
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
120. PlanDefinition.purpose
Definition | Explanation of why this plan definition is needed and why it has been designed as it has.
Short | Why this plan definition is defined
Comments | This element does not describe the usage of the plan definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this plan definition.
Control | 0..1
Type | markdown
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
122. PlanDefinition.usage
Definition | A detailed description of how the plan definition is used from a clinical perspective.
Short | Describes the clinical usage of the plan
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
124. PlanDefinition.copyright
Definition | A copyright statement relating to the plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan definition.
Short | Use and/or publishing restrictions
Control | 0..1
Type | markdown
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Consumers must be able to determine any legal restrictions on the use of the plan definition and/or its content.
Alternate Names | License, Restrictions
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
126. PlanDefinition.approvalDate
Definition | The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
Short | When the plan definition was approved by publisher
Comments | The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
Control | 0..1
Type | date
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
128. PlanDefinition.lastReviewDate
Definition | The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
Short | When the plan definition was last reviewed
Comments | If specified, this date follows the original approval date.
Control | 0..1
Type | date
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
130. PlanDefinition.effectivePeriod
Definition | The period during which the plan definition content was or is planned to be in active use.
Short | When the plan definition is expected to be used
Comments | The effective period for a plan definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.
Control | 0..1
Type | Period
Is Modifier | false
Summary | true
Requirements | Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the plan definition are or are expected to be used instead.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
132. PlanDefinition.topic
Definition | Descriptive topics related to the content of the plan definition. Topics provide a high-level categorization of the definition that can be useful for filtering and searching.
Short | E.g. Education, Treatment, Assessment
Control | 0..*
Binding | For example codes, see DefinitionTopic (example to `http://hl7.org/fhir/ValueSet/definition-topic|4.0.1` ) High-level categorization of the definition, used for searching, sorting, and filtering.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Repositories must be able to determine how to categorize the plan definition so that it can be found by topical searches.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
134. PlanDefinition.author
Definition | An individiual or organization primarily involved in the creation and maintenance of the content.
Short | Who authored the content
Control | 0..*
Type | ContactDetail
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
136. PlanDefinition.editor
Definition | An individual or organization primarily responsible for internal coherence of the content.
Short | Who edited the content
Control | 0..*
Type | ContactDetail
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
138. PlanDefinition.reviewer
Definition | An individual or organization primarily responsible for review of some aspect of the content.
Short | Who reviewed the content
Control | 0..*
Type | ContactDetail
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
140. PlanDefinition.endorser
Definition | An individual or organization responsible for officially endorsing the content for use in some setting.
Short | Who endorsed the content
Control | 0..*
Type | ContactDetail
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
142. PlanDefinition.relatedArtifact
Definition | Related artifacts such as additional documentation, justification, or bibliographic references.
Short | Additional documentation, citations
Comments | Each related artifact is either an attachment, or a reference to another resource, but not both.
Control | 0..*
Type | RelatedArtifact
Is Modifier | false
Summary | false
Requirements | Plan definitions must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
144. PlanDefinition.library
Definition | A reference to a Library resource containing any formal logic used by the plan definition.
Short | Logic used by the plan definition
Control | 0..*
Type | canonical(Library)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
146. PlanDefinition.goal
Definition | Goals that describe what the activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.
Short | What the plan is trying to accomplish
Control | 0..*
Type | BackboneElement
Is Modifier | false
Must Support | true
Summary | false
Requirements | Goal information needs to be captured for order sets, protocols, and care plan definitions to better describe the objectives of the protocol activities and to guide the creation of specific goals within the derived care plans and orders.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
148. PlanDefinition.goal.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
150. PlanDefinition.goal.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
152. PlanDefinition.goal.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
154. PlanDefinition.goal.category
Definition | Indicates a category the goal falls within.
Short | E.g. Treatment, dietary, behavioral
Control | 0..1
Binding | For example codes, see GoalCategory (example to `http://hl7.org/fhir/ValueSet/goal-category|4.0.1` ) Example codes for grouping goals for filtering or presentation.
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
156. PlanDefinition.goal.description
Definition | Human-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding".
Short | Code or text describing the goal
Comments | If no code is available, use CodeableConcept.text.
Control | 1..1
Binding | For example codes, see SNOMEDCTClinicalFindings (example to `http://hl7.org/fhir/ValueSet/clinical-findings|4.0.1` ) Describes goals that can be achieved.
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
158. PlanDefinition.goal.priority
Definition | Identifies the expected level of importance associated with reaching/sustaining the defined goal.
Short | high-priority | medium-priority | low-priority
Control | 0..1
Binding | The codes SHOULD be taken from GoalPriority (preferred to `http://hl7.org/fhir/ValueSet/goal-priority|4.0.1` ) Indicates the level of importance associated with reaching or sustaining a goal.
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
160. PlanDefinition.goal.start
Definition | The event after which the goal should begin being pursued.
Short | When goal pursuit begins
Control | 0..1
Binding | For example codes, see GoalStartEvent (example to `http://hl7.org/fhir/ValueSet/goal-start-event|4.0.1` ) Identifies the types of events that might trigger the start of a goal.
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
162. PlanDefinition.goal.addresses
Definition | Identifies problems, conditions, issues, or concerns the goal is intended to address.
Short | 病名
Control | 0..*
Binding | For example codes, see Condition/Problem/DiagnosisCodes (example to `http://hl7.org/fhir/ValueSet/condition-code|4.0.1` ) Identifies problems, conditions, issues, or concerns that goals may address.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
164. PlanDefinition.goal.addresses.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
166. PlanDefinition.goal.addresses.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `PlanDefinition.goal.addresses.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
168. PlanDefinition.goal.addresses.coding
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..*
Binding | For example codes, see JP Core Condition Disease Code MEDIS RecordNo ValueSet (example to `http://medis.or.jp/ValueSet/master-disease-keyNumber` )
Type | Coding
Is Modifier | false
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `PlanDefinition.goal.addresses.coding`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ system
170. PlanDefinition.goal.addresses.coding:masterDiseaseKeyNumber
Slice Name | masterDiseaseKeyNumber
Definition | MEDIS ICD10対応標準病名マスター(管理番号)
Short | MEDIS ICD10対応標準病名マスター(管理番号)
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..*
Binding | The codes SHOULD be taken from JP Core Condition Disease Code MEDIS RecordNo ValueSet (preferred to `http://medis.or.jp/ValueSet/master-disease-keyNumber` )
Type | Coding
Is Modifier | false
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
172. PlanDefinition.goal.addresses.coding:masterDiseaseKeyNumber.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
174. PlanDefinition.goal.addresses.coding:masterDiseaseKeyNumber.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `PlanDefinition.goal.addresses.coding.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
176. PlanDefinition.goal.addresses.coding:masterDiseaseKeyNumber.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Control | 1..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Fixed Value | `http://medis.or.jp/CodeSystem/master-disease-keyNumber`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
178. PlanDefinition.goal.addresses.coding:masterDiseaseKeyNumber.version
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Short | Version of the system - if relevant
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Note | This is a business version Id, not a resource version Id (see discussion)
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
180. PlanDefinition.goal.addresses.coding:masterDiseaseKeyNumber.code
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Short | Symbol in syntax defined by the system
Control | 1..1
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to refer to a particular code in the system.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
182. PlanDefinition.goal.addresses.coding:masterDiseaseKeyNumber.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Short | Representation defined by the system
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
184. PlanDefinition.goal.addresses.coding:masterDiseaseKeyNumber.userSelected
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Short | If this coding was chosen directly by the user
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Control | 0..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
186. PlanDefinition.goal.addresses.coding:ICD10-2013-full
Slice Name | ICD10-2013-full
Definition | MHLW 厚生労働省ICD102013版
Short | MHLW 厚生労働省ICD102013版
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..*
Binding | The codes SHOULD be taken from MHLW 厚生労働省ICD102013版 (preferred to `http://jpfhir.jp/fhir/core/mhlw/ValueSet/ICD10-2013-full` )
Type | Coding
Is Modifier | false
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
188. PlanDefinition.goal.addresses.coding:ICD10-2013-full.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
190. PlanDefinition.goal.addresses.coding:ICD10-2013-full.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `PlanDefinition.goal.addresses.coding.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
192. PlanDefinition.goal.addresses.coding:ICD10-2013-full.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Control | 1..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Fixed Value | `http://jpfhir.jp/fhir/core/mhlw/CodeSystem/ICD10-2013-full`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
194. PlanDefinition.goal.addresses.coding:ICD10-2013-full.version
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Short | Version of the system - if relevant
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Note | This is a business version Id, not a resource version Id (see discussion)
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
196. PlanDefinition.goal.addresses.coding:ICD10-2013-full.code
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Short | Symbol in syntax defined by the system
Control | 1..1
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to refer to a particular code in the system.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
198. PlanDefinition.goal.addresses.coding:ICD10-2013-full.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Short | Representation defined by the system
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
200. PlanDefinition.goal.addresses.coding:ICD10-2013-full.userSelected
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Short | If this coding was chosen directly by the user
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Control | 0..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
202. PlanDefinition.goal.addresses.text
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Short | Plain text representation of the concept
Comments | Very often the text is the same as a displayName of one of the codings.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
204. PlanDefinition.goal.documentation
Definition | Didactic or other informational resources associated with the goal that provide further supporting information about the goal. Information resources can include inline text commentary and links to web resources.
Short | Supporting documentation for the goal
Control | 0..*
Type | RelatedArtifact
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
206. PlanDefinition.goal.target
Definition | Indicates what should be done and within what timeframe.
Short | Target outcome for the goal
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
208. PlanDefinition.goal.target.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
210. PlanDefinition.goal.target.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
212. PlanDefinition.goal.target.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
214. PlanDefinition.goal.target.measure
Definition | The parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.
Short | The parameter whose value is to be tracked
Control | 0..1
Binding | For example codes, see LOINCCodes (example to `http://hl7.org/fhir/ValueSet/observation-codes|4.0.1` ) Identifies types of parameters that can be tracked to determine goal achievement.
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
216. PlanDefinition.goal.target.detail[x]
Definition | The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.
Short | The target value to be achieved
Control | 0..1
Type | Choice of: Quantity, Range, CodeableConcept
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
218. PlanDefinition.goal.target.due
Definition | Indicates the timeframe after the start of the goal in which the goal should be met.
Short | Reach goal within
Control | 0..1
Type | Duration
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
220. PlanDefinition.action
Definition | 1階層目に病日・イベントを設定する。OATユニット、観察項目はひな型・施設パス 病日・イベント情報（EPathPlanDefinitionEvent）に設定し、definition[x]から参照する。ePathメッセージ構造における繰り返し回数は最小1であるが、適用後パスバンドルに格納する際に省略できるよう最小0とした。
Short | 病日・イベント情報
Comments | Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.
Control | 0..*
Type | BackboneElement
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
222. PlanDefinition.action.id
Definition | 病日[-パスステップ]を設定する。
Short | 病日[-パスステップ]を設定する。
Control | 1..1
Type | string
Is Modifier | false
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
224. PlanDefinition.action.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
226. PlanDefinition.action.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
228. PlanDefinition.action.prefix
Definition | A user-visible prefix for the action.
Short | User-visible prefix for the action (e.g. 1. or A.)
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
230. PlanDefinition.action.title
Definition | 病日、またはイベント名称
Short | 病日、またはイベント名称
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
232. PlanDefinition.action.description
Definition | A brief description of the action used to provide a summary to display to the user.
Short | Brief description of the action
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
234. PlanDefinition.action.textEquivalent
Definition | A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.
Short | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
236. PlanDefinition.action.priority
Definition | Indicates how quickly the action should be addressed with respect to other actions.
Short | routine | urgent | asap | stat
Control | 0..1
Binding | The codes SHALL be taken from RequestPriority (required to `http://hl7.org/fhir/ValueSet/request-priority|4.0.1` ) Identifies the level of importance to be assigned to actioning the request.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
238. PlanDefinition.action.code
Definition | A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.
Short | Code representing the meaning of the action or sub-actions
Control | 0..*
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
240. PlanDefinition.action.reason
Definition | A description of why this action is necessary or appropriate.
Short | Why the action should be performed
Comments | This is different than the clinical evidence documentation, it's an actual business description of the reason for performing the action.
Control | 0..*
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
242. PlanDefinition.action.documentation
Definition | Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.
Short | Supporting documentation for the intended performer of the action
Control | 0..*
Type | RelatedArtifact
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
244. PlanDefinition.action.goalId
Definition | Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition.
Short | What goals this action supports
Control | 0..*
Type | id
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
246. PlanDefinition.action.subject[x]
Definition | A code or group definition that describes the intended subject of the action and its children, if any.
Short | Type of individual the action is focused on
Comments | The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified. In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from SubjectType (extensible to `http://hl7.org/fhir/ValueSet/subject-type|4.0.1` ) The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
Type | Choice of: CodeableConcept, Reference(Group)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | false
Requirements | Multiple steps in a protocol often have different groups of steps that are focused on testing different things. The subject of an action specifies the focus of the action and any child actions.
Meaning if Missing | Patient
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
248. PlanDefinition.action.trigger
Definition | A description of when the action should be triggered.
Short | When the action should be triggered
Control | 0..*
Type | TriggerDefinition
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
250. PlanDefinition.action.condition
Definition | An expression that describes applicability criteria or start/stop conditions for the action.
Short | Whether or not the action is applicable
Comments | When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
252. PlanDefinition.action.condition.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
254. PlanDefinition.action.condition.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
256. PlanDefinition.action.condition.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
258. PlanDefinition.action.condition.kind
Definition | The kind of condition.
Short | applicability | start | stop
Comments | Applicability criteria are used to determine immediate applicability when a plan definition is applied to a given context. Start and stop criteria are carried through application and used to describe enter/exit criteria for an action.
Control | 1..1
Binding | The codes SHALL be taken from ActionConditionKind (required to `http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1` ) Defines the kinds of conditions that can appear on actions.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
260. PlanDefinition.action.condition.expression
Definition | An expression that returns true or false, indicating whether the condition is satisfied.
Short | Boolean-valued expression
Comments | The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.
Control | 0..1
Type | Expression
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
262. PlanDefinition.action.input
Definition | Defines input data requirements for the action.
Short | Input data requirements
Control | 0..*
Type | DataRequirement
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
264. PlanDefinition.action.output
Definition | Defines the outputs of the action, if any.
Short | Output data definition
Control | 0..*
Type | DataRequirement
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
266. PlanDefinition.action.relatedAction
Definition | A relationship to another action such as "before" or "30-60 minutes after start of".
Short | Relationship to another action
Comments | When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
268. PlanDefinition.action.relatedAction.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
270. PlanDefinition.action.relatedAction.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
272. PlanDefinition.action.relatedAction.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
274. PlanDefinition.action.relatedAction.actionId
Definition | The element id of the related action.
Short | What action is this related to
Control | 1..1
Type | id
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
276. PlanDefinition.action.relatedAction.relationship
Definition | The relationship of this action to the related action.
Short | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control | 1..1
Binding | The codes SHALL be taken from ActionRelationshipType (required to `http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1` ) Defines the types of relationships between actions.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
278. PlanDefinition.action.relatedAction.offset[x]
Definition | A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.
Short | Time offset for the relationship
Control | 0..1
Type | Choice of: Duration, Range
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
280. PlanDefinition.action.timing[x]
Definition | フォーム（Questionnaire）などを入力するタイミングを設定する。
Short | フォーム（Questionnaire）などを入力するタイミングを設定する。
Control | 0..1
Type | Choice of: dateTime, Age, Period, Duration, Range, Timing
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `PlanDefinition.action.timing[x]`. The slices areUnordered and Open, and can be differentiated using the following discriminators: type @ $this
282. PlanDefinition.action.timing[x]:timingTiming
Slice Name | timingTiming
Definition | An optional value describing when the action should be performed.
Short | When the action should take place
Control | 0..1
Type | Timing
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
284. PlanDefinition.action.timing[x]:timingTiming.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
286. PlanDefinition.action.timing[x]:timingTiming.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `PlanDefinition.action.timing[x].extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
288. PlanDefinition.action.timing[x]:timingTiming.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
290. PlanDefinition.action.timing[x]:timingTiming.event
Definition | Identifies specific times when the event occurs.
Short | When the event occurs
Control | 0..*
Type | dateTime
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | In a Medication Administration Record, for instance, you need to take a general specification, and turn it into a precise specification.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
292. PlanDefinition.action.timing[x]:timingTiming.repeat
Definition | 繰り返しの定義。例えば、「月水金」や「X年Y月Z日からX年Y月Z日まで」など。id（病日[-パスステップ]）で表現できる場合は設定しなくてもよい。
Short | 繰り返しの定義。例えば、「月水金」や「X年Y月Z日からX年Y月Z日まで」など。id（病日[-パスステップ]）で表現できる場合は設定しなくてもよい。
Control | 0..1
Type | Element
Is Modifier | false
Must Support | true
Summary | true
Requirements | Many timing schedules are determined by regular repetitions.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) tim-1: if there's a duration, there needs to be duration units (`duration.empty() or durationUnit.exists()`) tim-2: if there's a period, there needs to be period units (`period.empty() or periodUnit.exists()`) tim-4: duration SHALL be a non-negative value (`duration.exists() implies duration >= 0`) tim-5: period SHALL be a non-negative value (`period.exists() implies period >= 0`) tim-6: If there's a periodMax, there must be a period (`periodMax.empty() or period.exists()`) tim-7: If there's a durationMax, there must be a duration (`durationMax.empty() or duration.exists()`) tim-8: If there's a countMax, there must be a count (`countMax.empty() or count.exists()`) tim-9: 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: If there's a timeOfDay, there cannot be a when, or vice versa (`timeOfDay.empty() or when.empty()`)
294. PlanDefinition.action.timing[x]:timingTiming.repeat.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
296. PlanDefinition.action.timing[x]:timingTiming.repeat.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `PlanDefinition.action.timing[x].repeat.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
298. PlanDefinition.action.timing[x]:timingTiming.repeat.bounds[x]
Definition | Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.
Short | Length/Range of lengths, or (Start and/or end) limits
Control | 0..1
Type | Choice of: Duration, Range, Period
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
300. PlanDefinition.action.timing[x]:timingTiming.repeat.count
Definition | A total count of the desired number of repetitions across the duration of the entire timing specification. If countMax is present, this element indicates the lower bound of the allowed range of count values.
Short | Number of times to repeat
Comments | If you have both bounds and count, then this should be understood as within the bounds period, until count times happens.
Control | 0..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Repetitions may be limited by end time or total occurrences.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
302. PlanDefinition.action.timing[x]:timingTiming.repeat.countMax
Definition | If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times.
Short | Maximum number of times to repeat
Control | 0..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
304. PlanDefinition.action.timing[x]:timingTiming.repeat.duration
Definition | How long this thing happens for when it happens. If durationMax is present, this element indicates the lower bound of the allowed range of the duration.
Short | How long when it happens
Comments | For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).
Control | 0..1
Type | decimal
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Some activities are not instantaneous and need to be maintained for a period of time.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
306. PlanDefinition.action.timing[x]:timingTiming.repeat.durationMax
Definition | If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length.
Short | How long when it happens (Max)
Comments | For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).
Control | 0..1
Type | decimal
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Some activities are not instantaneous and need to be maintained for a period of time.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
308. PlanDefinition.action.timing[x]:timingTiming.repeat.durationUnit
Definition | The units of time for the duration, in UCUM units.
Short | s | min | h | d | wk | mo | a - unit of time (UCUM)
Control | 0..1
Binding | The codes SHALL be taken from UnitsOfTime (required to `http://hl7.org/fhir/ValueSet/units-of-time|4.0.1` ) A unit of time (units from UCUM).
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
310. PlanDefinition.action.timing[x]:timingTiming.repeat.frequency
Definition | The number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequency.
Short | Event occurs frequency times per period
Control | 0..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Meaning if Missing | If no frequency is stated, the assumption is that the event occurs once per period, but systems SHOULD always be specific about this
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
312. PlanDefinition.action.timing[x]:timingTiming.repeat.frequencyMax
Definition | If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range.
Short | Event occurs up to frequencyMax times per period
Control | 0..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
314. PlanDefinition.action.timing[x]:timingTiming.repeat.period
Definition | Indicates the duration of time over which repetitions are to occur; e.g. to express "3 times per day", 3 would be the frequency and "1 day" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period length.
Short | Event occurs frequency times per period
Control | 0..1
Type | decimal
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
316. PlanDefinition.action.timing[x]:timingTiming.repeat.periodMax
Definition | If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days.
Short | Upper limit of period (3-4 hours)
Control | 0..1
Type | decimal
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
318. PlanDefinition.action.timing[x]:timingTiming.repeat.periodUnit
Definition | The units of time for the period in UCUM units.
Short | s | min | h | d | wk | mo | a - unit of time (UCUM)
Control | 0..1
Binding | The codes SHALL be taken from UnitsOfTime (required to `http://hl7.org/fhir/ValueSet/units-of-time|4.0.1` ) A unit of time (units from UCUM).
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
320. PlanDefinition.action.timing[x]:timingTiming.repeat.dayOfWeek
Definition | If one or more days of week is provided, then the action happens only on the specified day(s).
Short | mon | tue | wed | thu | fri | sat | sun
Comments | If no days are specified, the action is assumed to happen every day as otherwise specified. The elements frequency and period cannot be used as well as dayOfWeek.
Control | 0..*
Binding | The codes SHALL be taken from DaysOfWeek (required to `http://hl7.org/fhir/ValueSet/days-of-week|4.0.1` )
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
322. PlanDefinition.action.timing[x]:timingTiming.repeat.timeOfDay
Definition | Specified time of day for action to take place.
Short | Time of day for action
Comments | When time of day is specified, it is inferred that the action happens every day (as filtered by dayofWeek) on the specified times. The elements when, frequency and period cannot be used as well as timeOfDay.
Control | 0..*
Type | time
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
324. PlanDefinition.action.timing[x]:timingTiming.repeat.when
Definition | An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur.
Short | Code for time period of occurrence
Comments | When more than one event is listed, the event is tied to the union of the specified events.
Control | 0..*
Binding | The codes SHALL be taken from EventTiming (required to `http://hl7.org/fhir/ValueSet/event-timing|4.0.1` ) Real world event relating to the schedule.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Timings are frequently determined by occurrences such as waking, eating and sleep.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
326. PlanDefinition.action.timing[x]:timingTiming.repeat.offset
Definition | The number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event.
Short | Minutes from event (before or after)
Control | 0..1
Type | unsignedInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
328. PlanDefinition.action.timing[x]:timingTiming.code
Definition | A code for the timing schedule (or just text in code.text). Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code).
Short | BID | TID | QID | AM | PM | QD | QOD | +
Comments | BID etc. are defined as 'at institutionally specified times'. For example, an institution may choose that BID is "always at 7am and 6pm". If it is inappropriate for this choice to be made, the code BID should not be used. Instead, a distinct organization-specific code should be used in place of the HL7-defined BID code and/or a structured representation should be used (in this case, specifying the two event times).
Control | 0..1
Binding | The codes SHOULD be taken from TimingAbbreviation (preferred to `http://hl7.org/fhir/ValueSet/timing-abbreviation|4.0.1` ) Code for a known / defined timing pattern.
Type | CodeableConcept
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
330. PlanDefinition.action.participant
Definition | Indicates who should participate in performing the action described.
Short | Who should participate in the action
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
332. PlanDefinition.action.participant.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
334. PlanDefinition.action.participant.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
336. PlanDefinition.action.participant.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
338. PlanDefinition.action.participant.type
Definition | The type of participant in the action.
Short | patient | practitioner | related-person | device
Control | 1..1
Binding | The codes SHALL be taken from ActionParticipantType (required to `http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1` ) The type of participant for the action.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
340. PlanDefinition.action.participant.role
Definition | The role the participant should play in performing the described action.
Short | E.g. Nurse, Surgeon, Parent
Control | 0..1
Binding | For example codes, see ActionParticipantRole (example to `http://hl7.org/fhir/ValueSet/action-participant-role|4.0.1` ) Defines roles played by participants for the action.
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
342. PlanDefinition.action.type
Definition | The type of action to perform (create, update, remove).
Short | create | update | remove | fire-event
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from ActionType (extensible to `http://hl7.org/fhir/ValueSet/action-type|4.0.1` ) The type of action to be performed.
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
344. PlanDefinition.action.groupingBehavior
Definition | Defines the grouping behavior for the action and its children.
Short | visual-group | logical-group | sentence-group
Control | 0..1
Binding | The codes SHALL be taken from ActionGroupingBehavior (required to `http://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.1` ) Defines organization behavior of a group.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
346. PlanDefinition.action.selectionBehavior
Definition | Defines the selection behavior for the action and its children.
Short | any | all | all-or-none | exactly-one | at-most-one | one-or-more
Control | 0..1
Binding | The codes SHALL be taken from ActionSelectionBehavior (required to `http://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.1` ) Defines selection behavior of a group.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
348. PlanDefinition.action.requiredBehavior
Definition | Defines the required behavior for the action.
Short | must | could | must-unless-documented
Control | 0..1
Binding | The codes SHALL be taken from ActionRequiredBehavior (required to `http://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1` ) Defines expectations around whether an action or action group is required.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
350. PlanDefinition.action.precheckBehavior
Definition | Defines whether the action should usually be preselected.
Short | yes | no
Control | 0..1
Binding | The codes SHALL be taken from ActionPrecheckBehavior (required to `http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1` ) Defines selection frequency behavior for an action or group.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
352. PlanDefinition.action.cardinalityBehavior
Definition | Defines whether the action can be selected multiple times.
Short | single | multiple
Control | 0..1
Binding | The codes SHALL be taken from ActionCardinalityBehavior (required to `http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1` ) Defines behavior for an action or a group for how many times that item may be repeated.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
354. PlanDefinition.action.definition[x]
Definition | イベント（EPathPlanDefinitionEvent）、質問（EPathQuestionnaire）への正規URLを指定する。
Short | イベント（EPathPlanDefinitionEvent）、質問（EPathQuestionnaire）への正規URLを指定する。
Comments | Note that the definition is optional, and if no definition is specified, a dynamicValue with a root ($this) path can be used to define the entire resource dynamically.
Control | 0..1
Type | Choice of: canonical(EPath PlanDefinition Event, EPath Questionnaire), uri
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
356. PlanDefinition.action.transform
Definition | A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.
Short | Transform to apply the template
Comments | Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.
Control | 0..1
Type | canonical(StructureMap)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
358. PlanDefinition.action.dynamicValue
Definition | Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result.
Short | Dynamic aspects of the definition
Comments | Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
360. PlanDefinition.action.dynamicValue.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
362. PlanDefinition.action.dynamicValue.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
364. PlanDefinition.action.dynamicValue.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
366. PlanDefinition.action.dynamicValue.path
Definition | The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details).
Short | The path to the element to be set dynamically
Comments | To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
368. PlanDefinition.action.dynamicValue.expression
Definition | An expression specifying the value of the customized element.
Short | An expression that provides the dynamic value for the customization
Comments | The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.
Control | 0..1
Type | Expression
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
370. PlanDefinition.action.action
Definition | Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.
Short | A sub-action
Control | 0..*
Type | Seettp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)