This page is part of the electronic Case Reporting (eCR) (v0.1.0: STU 1 Ballot 1) based on FHIR R3. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions
Definitions for the StructureDefinition-rr-plandefinition Profile.
PlanDefinition | |
Definition | This profile defines the case report definitions for reportable conditions. |
Control | 0..* |
Invariants | Defined on this element dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (: contained.text.empty()) 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 (: contained.where(('#'+id in %resource.descendants().reference).not()).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()) |
PlanDefinition.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Control | 0..1 |
Type | id |
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. |
PlanDefinition.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
Control | 0..1 |
Type | Meta |
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. |
Control | 0..1 |
Type | uri |
Is Modifier | true |
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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. |
PlanDefinition.language | |
Definition | The base language in which the resource is written. |
Control | 0..1 |
Binding | A human language. The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable |
Type | code |
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). |
PlanDefinition.text | |
Definition | A human-readable narrative that contains a summary of the resource, and may 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. |
Control | 0..1 This element is affected by the following invariants: dom-1 |
Type | Narrative |
Alternate Names | narrative, html, xhtml, display |
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 in formation is added later. |
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. |
Control | 0..* |
Type | Resource |
Alternate Names | inline resources, anonymous resources, contained 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. |
PlanDefinition.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. In order 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
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. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content |
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. |
PlanDefinition.url | |
Definition | An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this plan definition is (or will be) published. The URL SHOULD include the major version of the plan definition. For more information see Technical and Business Versions. |
Control | 0..1 |
Type | uri |
Requirements | Allows the plan definition to be referenced by a single globally unique identifier. |
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. |
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. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the module. |
Comments | Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, e.g., to identify this plan definition outside of FHIR, where it is not possible to use the logical URI. |
PlanDefinition.version | |
Definition | 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. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 |
Type | string |
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 refrence to a particular business version of the plan definition with the format [url]|[version]. |
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. |
Control | 0..1 |
Type | string |
Requirements | Support human navigation and code generation. |
Comments | The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure that it is computable friendly. |
PlanDefinition.title | |
Definition | A short, descriptive, user-friendly title for the plan definition. |
Control | 0..1 |
Type | string |
Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. |
PlanDefinition.type | |
Definition | The type of asset the plan definition represents, e.g. an order set, protocol, or event-condition-action rule. |
Control | 0..1 |
Binding | The type of PlanDefinition The codes SHALL be taken from PlanDefinitionType; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
PlanDefinition.status | |
Definition | The status of this plan definition. Enables tracking the life-cycle of the content. |
Control | 1..1 |
Binding | The lifecycle status of a Value Set or Concept Map. The codes SHALL be taken from PublicationStatus |
Type | code |
Is Modifier | true |
Comments | Allows filtering of plan definitions that are appropriate for use vs. not. |
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. |
Control | 0..1 |
Type | boolean |
Is Modifier | true |
Requirements | Enables experimental content to be developed following the same lifecycle that would be used for a production-level plan definition. |
Comments | Allows filtering of plan definition that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use an experimental plan definition in production. |
PlanDefinition.date | |
Definition | The date (and optionally time) when the plan definition was published. The date must change if and 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. |
Control | 0..1 |
Type | dateTime |
Alternate Names | Revision Date |
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. |
PlanDefinition.publisher | |
Definition | The name of the PHA that authored reporting specifications in the PHA system (or its intermediary). |
Control | 0..1 |
Type | string |
Must Support | true |
Requirements | Helps establish the "authority/credibility" of the plan definition. May also allow for contact. |
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. |
PlanDefinition.publisher.id | |
Definition | unique id for the element within a resource (for internal references) |
Control | 0..1 |
Type | string |
PlanDefinition.publisher.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
PlanDefinition.publisher.extension (http://fhir.hl7.org/us/ecr/StructureDefinition/extension-publisher-reference) | |
Definition | A reference to organization (for example, the PHA) that authored reporting specifications in the PHA system (or its intermediary). |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Reference(eCR Organization Profile)) |
Alternate Names | Authoring Agency |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
PlanDefinition.publisher.value | |
Definition | The actual value |
Control | 0..1 |
Max Length | 1048576 |
PlanDefinition.description | |
Definition | A free text natural language description of the plan definition from a consumer's perspective. |
Control | 0..1 |
Type | markdown |
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 profile is presumed to be the predominant language in the place the profile was created). |
PlanDefinition.purpose | |
Definition | Explaination of why this plan definition is needed and why it has been designed as it has. |
Control | 0..1 |
Type | markdown |
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. |
PlanDefinition.usage | |
Definition | A detailed description of how the asset is used from a clinical perspective. |
Control | 0..1 |
Type | string |
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. |
Control | 0..1 |
Type | date |
Comments | The 'date' element may be more recent than the approval date because of minor changes / editorial corrections. |
PlanDefinition.lastReviewDate | |
Definition | The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date. |
Control | 0..1 |
Type | date |
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. |
Comments | If specified, this is usually after the approval date. |
PlanDefinition.effectivePeriod | |
Definition | The period during which the plan definition content was or is planned to be in active use. |
Control | 0..1 |
Type | Period |
Requirements | Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of a the plan definition are or are expected to be used instead. |
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. |
PlanDefinition.useContext | |
Definition | The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate plan definition instances. |
Control | 0..* |
Type | UsageContext |
Requirements | Assist in searching for appropriate content. |
Comments | When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply. |
PlanDefinition.jurisdiction | |
Definition | A legal or geographic region in which the plan definition is intended to be used. |
Control | 0..* |
Binding | Countries and regions within which this artifact is targeted for use The codes SHALL be taken from Jurisdiction ValueSet; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
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. |
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. |
Control | 0..* |
Binding | High-level categorization of the definition, used for searching, sorting, and filtering For example codes, see DefinitionTopic |
Type | CodeableConcept |
Requirements | Repositories must be able to determine how to categorize the asset so that it can be found by topical searches. |
PlanDefinition.contributor | |
Definition | A contributor to the content of the asset, including authors, editors, reviewers, and endorsers. |
Control | 0..* |
Type | Contributor |
Requirements | Consumers of the content must be able to quickly determine who contributed to the content of the asset. |
PlanDefinition.contact | |
Definition | Contact details to assist a user in finding and communicating with the publisher. |
Control | 0..* |
Type | ContactDetail |
Comments | May be a web site, an email address, a telephone number, etc. |
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. |
Control | 0..1 |
Type | markdown |
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 |
PlanDefinition.relatedArtifact | |
Definition | The description of link which may assist “providers” or “reporters” in understanding or investigating conditions. |
Control | 0..* |
Type | RelatedArtifact |
Must Support | true |
Requirements | Assets 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. |
Comments | Each related artifact is either an attachment, or a reference to another resource, but not both. |
PlanDefinition.relatedArtifact.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
PlanDefinition.relatedArtifact.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
PlanDefinition.relatedArtifact.extension (http://fhir.hl7.org/us/ecr/StructureDefinition/extension-rel-artifact-category) | |
Definition | Type/category of one or more external resources. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: code) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
PlanDefinition.relatedArtifact.extension.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
PlanDefinition.relatedArtifact.extension.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
PlanDefinition.relatedArtifact.extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://fhir.hl7.org/us/ecr/StructureDefinition/extension-rel-artifact-category |
PlanDefinition.relatedArtifact.extension.valueCode | |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Control | 0..1 |
Binding | Type/category of one or more external resources The codes SHALL be taken from External Resource Type; other codes may be used where these codes are not suitable |
Type | code |
PlanDefinition.relatedArtifact.extension (http://fhir.hl7.org/us/ecr/StructureDefinition/extension-rel-artifact-priority) | |
Definition | Priority given to one or more external resources. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: code) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
PlanDefinition.relatedArtifact.extension.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
PlanDefinition.relatedArtifact.extension.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
PlanDefinition.relatedArtifact.extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://fhir.hl7.org/us/ecr/StructureDefinition/extension-rel-artifact-priority |
PlanDefinition.relatedArtifact.extension.valueCode | |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Control | 0..1 |
Binding | Priority given to one or more external resources The codes SHALL be taken from Reportability Priority; other codes may be used where these codes are not suitable |
Type | code |
PlanDefinition.relatedArtifact.type | |
Definition | The type of relationship to the related artifact. |
Control | 1..1 |
Binding | The type of relationship to the related artifact The codes SHALL be taken from RelatedArtifactType |
Type | code |
Must Support | true |
Fixed Value | documentation |
PlanDefinition.relatedArtifact.display | |
Definition | The description of link which may assist “providers” or “reporters” in understanding or investigating conditions deemed reportable by the PHA system (or its intermediary). |
Control | 0..1 |
Type | string |
Must Support | true |
PlanDefinition.relatedArtifact.citation | |
Definition | A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format. |
Control | 0..1 |
Type | string |
Comments | Additional structured information about citations should be captured as extensions. |
PlanDefinition.relatedArtifact.url | |
Definition | A link which may assist “providers” or “reporters” in understanding or investigating conditions deemed reportable by the PHA system (or its intermediary). |
Control | 0..1 |
Type | uri |
Must Support | true |
Comments | If a document or resource element is present, this element SHALL NOT be provided (use the url or reference in the Attachment or resource reference). |
PlanDefinition.relatedArtifact.document | |
Definition | The document being referenced, represented as an attachment. This is exclusive with the resource element. |
Control | 0..1 |
Type | Attachment |
PlanDefinition.relatedArtifact.resource | |
Definition | The related resource, such as a library, value set, profile, or other knowledge resource. |
Control | 0..1 |
Type | Reference(Resource) |
Comments | If the type is predecessor, this is a reference to the succeeding knowledge resource. If the type is successor, this is a reference to the prior knowledge resource. |
PlanDefinition.library | |
Definition | A reference to a Library resource containing any formal logic used by the plan definition. |
Control | 0..* |
Type | Reference(Library) |
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. |
Control | 0..* |
Type | BackboneElement |
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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
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. |
Control | 0..1 |
Type | string |
PlanDefinition.goal.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
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 that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
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. |
PlanDefinition.goal.category | |
Definition | Indicates a category the goal falls within. |
Control | 0..1 |
Binding | Example codes for grouping goals for filtering or presentation For example codes, see GoalCategory |
Type | CodeableConcept |
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". |
Control | 1..1 |
Binding | Describes goals that can be achieved For example codes, see SNOMED CT Clinical Findings |
Type | CodeableConcept |
Comments | If no code is available, use CodeableConcept.text. |
PlanDefinition.goal.priority | |
Definition | Identifies the expected level of importance associated with reaching/sustaining the defined goal. |
Control | 0..1 |
Binding | Indicates the level of importance associated with reaching or sustaining a goal The codes SHOULD be taken from GoalPriority |
Type | CodeableConcept |
PlanDefinition.goal.start | |
Definition | The event after which the goal should begin being pursued. |
Control | 0..1 |
Binding | Identifies the types of events that might trigger the start of a goal For example codes, see GoalStartEvent |
Type | CodeableConcept |
PlanDefinition.goal.addresses | |
Definition | Identifies problems, conditions, issues, or concerns the goal is intended to address. |
Control | 0..* |
Binding | Identifies problems, conditions, issues, or concerns that goals may address For example codes, see Condition/Problem/Diagnosis Codes |
Type | CodeableConcept |
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. |
Control | 0..* |
Type | RelatedArtifact |
PlanDefinition.goal.target | |
Definition | Indicates what should be done and within what timeframe. |
Control | 0..* |
Type | BackboneElement |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
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. |
Control | 0..1 |
Type | string |
PlanDefinition.goal.target.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
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 that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
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. |
PlanDefinition.goal.target.measure | |
Definition | The parameter whose value is to be tracked, e.g. body weigth, blood pressure, or hemoglobin A1c level. |
Control | 0..1 |
Binding | Identifies types of parameters that can be tracked to determine goal achievement For example codes, see LOINC Codes |
Type | CodeableConcept |
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. Whan 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. |
Control | 0..1 |
Type | Choice of: Quantity, Range, CodeableConcept |
[x] Note | See Choice of Data Types for further information about how to use [x] |
PlanDefinition.goal.target.due | |
Definition | Indicates the timeframe after the start of the goal in which the goal should be met. |
Control | 0..1 |
Type | Duration |
PlanDefinition.action | |
Definition | An action to be taken as part of the plan. |
Control | 0..* |
Type | BackboneElement |
Must Support | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
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. |
Control | 0..1 |
Type | string |
PlanDefinition.action.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
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 that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
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. |
PlanDefinition.action.label | |
Definition | A user-visible label for the action. |
Control | 0..1 |
Type | string |
PlanDefinition.action.title | |
Definition | The title of the action displayed to a user. |
Control | 0..1 |
Type | string |
PlanDefinition.action.description | |
Definition | A short description of the action used to provide a summary to display to the user. |
Control | 0..1 |
Type | string |
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 may not be capable of interpreting it dynamically. |
Control | 0..1 |
Type | string |
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 a the section of a documentation template. |
Control | 0..* |
Type | CodeableConcept |
PlanDefinition.action.reason | |
Definition | A description of why this action is necessary or appropriate. |
Control | 0..* |
Type | CodeableConcept |
Comments | This is different than the clinical evidence documentation, it's an actual business description of the reason for performing the action. |
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. |
Control | 0..* |
Type | RelatedArtifact |
PlanDefinition.action.goalId | |
Definition | Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition. |
Control | 0..* |
Type | id |
PlanDefinition.action.triggerDefinition | |
Definition | A description of when the action should be triggered. |
Control | 0..* |
Type | TriggerDefinition |
PlanDefinition.action.condition | |
Definition | An expression that describes applicability criteria, or start/stop conditions for the action. |
Control | 0..* |
Type | BackboneElement |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
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. |
Control | 0..1 |
Type | string |
PlanDefinition.action.condition.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
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 that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
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. |
PlanDefinition.action.condition.kind | |
Definition | The kind of condition. |
Control | 1..1 |
Binding | Defines the kinds of conditions that can appear on actions The codes SHALL be taken from ActionConditionKind |
Type | code |
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 when enter/exit criteria for an action. |
PlanDefinition.action.condition.description | |
Definition | A brief, natural language description of the condition that effectively communicates the intended semantics. |
Control | 0..1 |
Type | string |
PlanDefinition.action.condition.language | |
Definition | The media type of the language for the expression. |
Control | 0..1 |
Type | string |
PlanDefinition.action.condition.expression | |
Definition | An expression that returns true or false, indicating whether or not the condition is satisfied. |
Control | 0..1 |
Type | string |
Comments | The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element. |
PlanDefinition.action.input | |
Definition | Defines input data requirements for the action. |
Control | 0..* |
Type | DataRequirement |
PlanDefinition.action.output | |
Definition | Defines the outputs of the action, if any. |
Control | 0..* |
Type | DataRequirement |
PlanDefinition.action.relatedAction | |
Definition | A relationship to another action such as "before" or "30-60 minutes after start of". |
Control | 0..* |
Type | BackboneElement |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
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. |
Control | 0..1 |
Type | string |
PlanDefinition.action.relatedAction.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
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 that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
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. |
PlanDefinition.action.relatedAction.actionId | |
Definition | The element id of the related action. |
Control | 1..1 |
Type | id |
PlanDefinition.action.relatedAction.relationship | |
Definition | The relationship of this action to the related action. |
Control | 1..1 |
Binding | Defines the types of relationships between actions The codes SHALL be taken from ActionRelationshipType |
Type | code |
PlanDefinition.action.relatedAction.offset[x] | |
Definition | A duration or range of durations to apply to the relationship. For example, 30-60 minutes before. |
Control | 0..1 |
Type | Choice of: Duration, Range |
[x] Note | See Choice of Data Types for further information about how to use [x] |
PlanDefinition.action.timing[x] | |
Definition | An optional value describing when the action should be performed. |
Control | 0..1 |
Type | Timing |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
PlanDefinition.action.timing[x].id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
PlanDefinition.action.timing[x].extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
PlanDefinition.action.timing[x].event | |
Definition | Identifies specific times when the event occurs. |
Control | 0..* |
Type | dateTime |
Requirements | In an MAR, for instance, you need to take a general specification, and turn it into a precise specification. |
PlanDefinition.action.timing[x].repeat | |
Definition | A set of rules that describe when the event is scheduled. |
Control | 0..1 |
Type | Element |
Requirements | Many timing schedules are determined by regular repetitions. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) tim-1: if there's a duration, there needs to be duration units (: duration.empty() or durationUnit.exists()) tim-10: If there's a timeOfDay, there cannot be be a when, or vice versa (: timeOfDay.empty() or when.empty()) 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()))) |
PlanDefinition.action.timing[x].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. |
Control | 0..1 |
Type | string |
PlanDefinition.action.timing[x].repeat.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
PlanDefinition.action.timing[x].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. |
Control | 0..1 |
Type | Choice of: Duration, Range, Period |
[x] Note | See Choice of Data Types for further information about how to use [x] |
PlanDefinition.action.timing[x].repeat.count | |
Definition | A total count of the desired number of repetitions. |
Control | 0..1 |
Type | integer |
Requirements | Repetitions may be limited by end time or total occurrences. |
Comments | If you have both bounds and count, then this should be understood as within the bounds period, until count times happens. |
PlanDefinition.action.timing[x].repeat.countMax | |
Definition | A maximum value for the count of the desired repetitions (e.g. do something 6-8 times). |
Control | 0..1 |
Type | integer |
PlanDefinition.action.timing[x].repeat.duration | |
Definition | How long this thing happens for when it happens. |
Control | 0..1 |
Type | decimal |
Requirements | Some activities are not instantaneous and need to be maintained for a period of time. |
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). |
PlanDefinition.action.timing[x].repeat.durationMax | |
Definition | The upper limit of how long this thing happens for when it happens. |
Control | 0..1 |
Type | decimal |
Requirements | Some activities are not instantaneous and need to be maintained for a period of time. |
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). |
PlanDefinition.action.timing[x].repeat.durationUnit | |
Definition | The units of time for the duration, in UCUM units. |
Control | 0..1 |
Binding | A unit of time (units from UCUM). The codes SHALL be taken from UnitsOfTime |
Type | code |
PlanDefinition.action.timing[x].repeat.frequency | |
Definition | The number of times to repeat the action within the specified period / period range (i.e. both period and periodMax provided). |
Control | 0..1 |
Type | integer |
Default Value | 1 |
PlanDefinition.action.timing[x].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. |
Control | 0..1 |
Type | integer |
PlanDefinition.action.timing[x].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. |
Control | 0..1 |
Type | decimal |
PlanDefinition.action.timing[x].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. |
Control | 0..1 |
Type | decimal |
PlanDefinition.action.timing[x].repeat.periodUnit | |
Definition | The units of time for the period in UCUM units. |
Control | 0..1 |
Binding | A unit of time (units from UCUM). The codes SHALL be taken from UnitsOfTime |
Type | code |
PlanDefinition.action.timing[x].repeat.dayOfWeek | |
Definition | If one or more days of week is provided, then the action happens only on the specified day(s). |
Control | 0..* |
Binding | The codes SHALL be taken from DaysOfWeek |
Type | code |
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. |
PlanDefinition.action.timing[x].repeat.timeOfDay | |
Definition | Specified time of day for action to take place. |
Control | 0..* |
Type | time |
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. |
PlanDefinition.action.timing[x].repeat.when | |
Definition | Real world events that the occurrence of the event should be tied to. |
Control | 0..* |
Binding | Real world event relating to the schedule. The codes SHALL be taken from EventTiming |
Type | code |
Requirements | Timings are frequently determined by occurrences such as waking, eating and sleep. |
Comments | When more than one event is listed, the event is tied to the union of the specified events. |
PlanDefinition.action.timing[x].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. |
Control | 0..1 |
Type | unsignedInt |
PlanDefinition.action.timing[x].code | |
Definition | For a given condition within a jurisdiction, the mandated timeframe in which the condition should be reported to the PHA. |
Control | 1..1 |
Binding | Mandated timeframe in which the condition should be reported to the PHA The codes SHALL be taken from ReportingTimeframe; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Must Support | true |
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 the a structured representation should be used (in this case, specifying the two event times). |
PlanDefinition.action.participant | |
Definition | Indicates who should participate in performing the action described. |
Control | 0..* |
Type | BackboneElement |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
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. |
Control | 0..1 |
Type | string |
PlanDefinition.action.participant.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
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 that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
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. |
PlanDefinition.action.participant.type | |
Definition | The type of participant in the action. |
Control | 1..1 |
Binding | The type of participant for the action The codes SHALL be taken from ActionParticipantType |
Type | code |
PlanDefinition.action.participant.role | |
Definition | The role the participant should play in performing the described action. |
Control | 0..1 |
Binding | Defines roles played by participants for the action For example codes, see ActionParticipantRole |
Type | CodeableConcept |
PlanDefinition.action.type | |
Definition | The type of action to perform (create, update, remove). |
Control | 0..1 |
Binding | The type of action to be performed The codes SHALL be taken from ActionType |
Type | Coding |
PlanDefinition.action.groupingBehavior | |
Definition | Defines the grouping behavior for the action and its children. |
Control | 0..1 |
Binding | Defines organization behavior of a group The codes SHALL be taken from ActionGroupingBehavior |
Type | code |
PlanDefinition.action.selectionBehavior | |
Definition | Defines the selection behavior for the action and its children. |
Control | 0..1 |
Binding | Defines selection behavior of a group The codes SHALL be taken from ActionSelectionBehavior |
Type | code |
PlanDefinition.action.requiredBehavior | |
Definition | Defines the requiredness behavior for the action. |
Control | 0..1 |
Binding | Defines requiredness behavior for selecting an action or an action group The codes SHALL be taken from ActionRequiredBehavior |
Type | code |
PlanDefinition.action.precheckBehavior | |
Definition | Defines whether the action should usually be preselected. |
Control | 0..1 |
Binding | Defines selection frequency behavior for an action or group The codes SHALL be taken from ActionPrecheckBehavior |
Type | code |
PlanDefinition.action.cardinalityBehavior | |
Definition | Defines whether the action can be selected multiple times. |
Control | 0..1 |
Binding | Defines behavior for an action or a group for how many times that item may be repeated The codes SHALL be taken from ActionCardinalityBehavior |
Type | code |
PlanDefinition.action.definition | |
Definition | 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. |
Control | 0..1 |
Type | Choice of: Reference(ActivityDefinition), Reference(PlanDefinition) |
Comments | Note that the definition is optional, and if no definition is specified, a dynamicValue with a root (~) path can be used to define the entire resource dynamically. |
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. |
Control | 0..1 |
Type | Reference(StructureMap) |
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. |
Control | 0..* |
Type | BackboneElement |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
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. |
Control | 0..1 |
Type | string |
PlanDefinition.action.dynamicValue.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
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 that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
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. |
PlanDefinition.action.dynamicValue.description | |
Definition | A brief, natural language description of the intended semantics of the dynamic value. |
Control | 0..1 |
Type | string |
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. |
Control | 0..1 |
Type | string |
PlanDefinition.action.dynamicValue.language | |
Definition | The media type of the language for the expression. |
Control | 0..1 |
Type | string |
PlanDefinition.action.dynamicValue.expression | |
Definition | An expression specifying the value of the customized element. |
Control | 0..1 |
Type | string |
Comments | The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element. |
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. |
Control | 0..* |
Type | See PlanDefinition.action |