MobilePlan
MobilePlan is a profile of the resource PlanDefinition and holds for example the url for the questionnaire to be sent. It also holds all texts and labels that are included in a SMS and that are displayed when the questionnaire is rendered. It could for example be headers, help texts, button labels and error messages
PlanDefinition | I | PlanDefinition | There are no (further) constraints on this element Element idPlanDefinition The definition of a plan for a series of actions, independent of any specific patient or context DefinitionThis 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.
| |
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idPlanDefinition.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idPlanDefinition.meta Metadata about the resource DefinitionThe 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.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idPlanDefinition.implicitRules A set of rules under which this content was created DefinitionA 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. 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.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idPlanDefinition.language Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idPlanDefinition.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. 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.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idPlanDefinition.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPlanDefinition.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idPlanDefinition.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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). 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | Σ | 0..1 | uri | There are no (further) constraints on this element Element idPlanDefinition.url Canonical identifier for this plan definition, represented as a URI (globally unique) DefinitionAn 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. Allows the plan definition to be referenced by a single globally unique identifier. 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.
|
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idPlanDefinition.identifier Additional identifier for the plan definition DefinitionA 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. Allows externally provided and/or usable business identifiers to be easily associated with the module. 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.
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idPlanDefinition.version Business version of the plan definition DefinitionThe 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. 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].
|
name | Σ I | 0..1 | string | There are no (further) constraints on this element Element idPlanDefinition.name Name for this plan definition (computer friendly) DefinitionA 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. Support human navigation and code generation. 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.
|
title | Σ | 0..1 | string | There are no (further) constraints on this element Element idPlanDefinition.title Name for this plan definition (human friendly) DefinitionA short, descriptive, user-friendly title for the plan definition. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
|
subtitle | 0..0 | string | There are no (further) constraints on this element Element idPlanDefinition.subtitle Subordinate title of the plan definition DefinitionAn explanatory or alternate title for the plan definition giving additional information about its content. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
type | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idPlanDefinition.type order-set | clinical-protocol | eca-rule | workflow-definition DefinitionA high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The type of PlanDefinition.
|
status | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idPlanDefinition.status draft | active | retired | unknown DefinitionThe status of this plan definition. Enables tracking the life-cycle of the content. Allows filtering of plan definitions that are appropriate for use versus not. The lifecycle status of an artifact.
|
experimental | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idPlanDefinition.experimental For testing purposes, not real usage DefinitionA 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. Enables experimental content to be developed following the same lifecycle that would be used for a production-level plan definition. Allows filtering of plan definitions that are appropriate for use versus not.
|
subject[x] | 0..0 | Binding | There are no (further) constraints on this element Element idPlanDefinition.subject[x] Type of individual the plan definition is focused on DefinitionA code or group definition that describes the intended subject of the plan definition. Patient The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
| |
date | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idPlanDefinition.date Date last changed Alternate namesRevision Date DefinitionThe 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. 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.
|
publisher | Σ | 0..1 | string | There are no (further) constraints on this element Element idPlanDefinition.publisher Name of the publisher (organization or individual) DefinitionThe name of the organization or individual that published the plan definition. Helps establish the "authority/credibility" of the plan definition. May also allow for contact. 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.
|
contact | Σ | 0..0 | ContactDetail | There are no (further) constraints on this element Element idPlanDefinition.contact Contact details for the publisher DefinitionContact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
|
description | Σ | 0..1 | markdown | There are no (further) constraints on this element Element idPlanDefinition.description Natural language description of the plan definition DefinitionA free text natural language description of the plan definition from a consumer's perspective. 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).
|
useContext | Σ | 0..0 | UsageContext | There are no (further) constraints on this element Element idPlanDefinition.useContext The context that the content is intended to support DefinitionThe 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. Assist in searching for appropriate content. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
|
jurisdiction | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idPlanDefinition.jurisdiction Intended jurisdiction for plan definition (if applicable) DefinitionA legal or geographic region in which the plan definition is intended to be used. It may be possible for the plan definition to be used in jurisdictions other than those for which it was originally designed or intended. Countries and regions within which this artifact is targeted for use.
|
purpose | 0..0 | markdown | There are no (further) constraints on this element Element idPlanDefinition.purpose Why this plan definition is defined DefinitionExplanation of why this plan definition is needed and why it has been designed as it has. 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.
| |
usage | 0..0 | string | There are no (further) constraints on this element Element idPlanDefinition.usage Describes the clinical usage of the plan DefinitionA detailed description of how the plan definition is used from a clinical perspective. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
copyright | 0..0 | markdown | There are no (further) constraints on this element Element idPlanDefinition.copyright Use and/or publishing restrictions Alternate namesLicense, Restrictions DefinitionA 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. Consumers must be able to determine any legal restrictions on the use of the plan definition and/or its content. Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/
| |
approvalDate | 0..0 | date | There are no (further) constraints on this element Element idPlanDefinition.approvalDate When the plan definition was approved by publisher DefinitionThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
| |
lastReviewDate | 0..0 | date | There are no (further) constraints on this element Element idPlanDefinition.lastReviewDate When the plan definition was last reviewed DefinitionThe date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. 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. If specified, this date follows the original approval date.
| |
effectivePeriod | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idPlanDefinition.effectivePeriod When the plan definition is expected to be used DefinitionThe period during which the plan definition content was or is planned to be in active use. 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. 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.
|
topic | 0..0 | CodeableConcept | There are no (further) constraints on this element Element idPlanDefinition.topic E.g. Education, Treatment, Assessment DefinitionDescriptive 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. Repositories must be able to determine how to categorize the plan definition so that it can be found by topical searches. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. High-level categorization of the definition, used for searching, sorting, and filtering.
| |
author | 0..0 | ContactDetail | There are no (further) constraints on this element Element idPlanDefinition.author Who authored the content DefinitionAn individiual or organization primarily involved in the creation and maintenance of the content.
| |
editor | 0..* | ContactDetail | There are no (further) constraints on this element Element idPlanDefinition.editor Who edited the content DefinitionAn individual or organization primarily responsible for internal coherence of the content.
| |
reviewer | 0..0 | ContactDetail | There are no (further) constraints on this element Element idPlanDefinition.reviewer Who reviewed the content DefinitionAn individual or organization primarily responsible for review of some aspect of the content.
| |
endorser | 0..0 | ContactDetail | There are no (further) constraints on this element Element idPlanDefinition.endorser Who endorsed the content DefinitionAn individual or organization responsible for officially endorsing the content for use in some setting.
| |
relatedArtifact | 0..0 | RelatedArtifact | There are no (further) constraints on this element Element idPlanDefinition.relatedArtifact Additional documentation, citations DefinitionRelated artifacts such as additional documentation, justification, or bibliographic references. 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. Each related artifact is either an attachment, or a reference to another resource, but not both.
| |
library | 0..0 | canonical(Library) | There are no (further) constraints on this element Element idPlanDefinition.library Logic used by the plan definition DefinitionA reference to a Library resource containing any formal logic used by the plan definition.
| |
goal | 0..0 | BackboneElement | There are no (further) constraints on this element Element idPlanDefinition.goal What the plan is trying to accomplish DefinitionGoals 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. 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.
| |
action | 0..* | BackboneElement | There are no (further) constraints on this element Element idPlanDefinition.action Action defined by the plan DefinitionAn action or group of actions to be taken as part of the plan. 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.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idPlanDefinition.action.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPlanDefinition.action.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idPlanDefinition.action.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
prefix | 0..0 | string | There are no (further) constraints on this element Element idPlanDefinition.action.prefix User-visible prefix for the action (e.g. 1. or A.) DefinitionA user-visible prefix for the action. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
title | 0..0 | string | There are no (further) constraints on this element Element idPlanDefinition.action.title User-visible title DefinitionThe title of the action displayed to a user. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
description | 0..1 | string | There are no (further) constraints on this element Element idPlanDefinition.action.description Brief description of the action DefinitionA brief description of the action used to provide a summary to display to the user. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
textEquivalent | 0..0 | string | There are no (further) constraints on this element Element idPlanDefinition.action.textEquivalent Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system DefinitionA 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. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
priority | 0..0 | codeBinding | There are no (further) constraints on this element Element idPlanDefinition.action.priority routine | urgent | asap | stat DefinitionIndicates how quickly the action should be addressed with respect to other actions. Note that FHIR strings SHALL NOT exceed 1MB in size Identifies the level of importance to be assigned to actioning the request.
| |
code | 0..0 | CodeableConcept | There are no (further) constraints on this element Element idPlanDefinition.action.code Code representing the meaning of the action or sub-actions DefinitionA 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. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
| |
reason | 0..0 | CodeableConcept | There are no (further) constraints on this element Element idPlanDefinition.action.reason Why the action should be performed DefinitionA description of why this action is necessary or appropriate. This is different than the clinical evidence documentation, it's an actual business description of the reason for performing the action.
| |
documentation | 0..0 | RelatedArtifact | There are no (further) constraints on this element Element idPlanDefinition.action.documentation Supporting documentation for the intended performer of the action DefinitionDidactic 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. Each related artifact is either an attachment, or a reference to another knowledge resource, but not both.
| |
goalId | 0..0 | id | There are no (further) constraints on this element Element idPlanDefinition.action.goalId What goals this action supports DefinitionIdentifies goals that this action supports. The reference must be to a goal element defined within this plan definition. RFC 4122
| |
subject[x] | 0..0 | Binding | There are no (further) constraints on this element Element idPlanDefinition.action.subject[x] Type of individual the action is focused on DefinitionA code or group definition that describes the intended subject of the action and its children, if any. 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. 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). Patient The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
| |
trigger | I | 0..0 | TriggerDefinition | There are no (further) constraints on this element Element idPlanDefinition.action.trigger When the action should be triggered DefinitionA description of when the action should be triggered. If an event is a named-event, it means the event is completely pre-coordinated, and no other information can be specified for the event. If the event is one of the data- events, the data and condition elements specify the triggering criteria. The data element specifies the structured component, and the condition element provides additional optional refinement of that structured component. If the event is periodic, the timing element defines when the event is triggered. For both data- and periodic events, a name can be provided as a shorthand for the formal semantics provided by the other elements.
|
condition | 0..0 | BackboneElement | There are no (further) constraints on this element Element idPlanDefinition.action.condition Whether or not the action is applicable DefinitionAn expression that describes applicability criteria or start/stop conditions for the action. 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.
| |
input | 1..* | DataRequirement | Element idPlanDefinition.action.input Input data requirements DefinitionDefines input data requirements for the action. Unordered, Open, by extension.url(Value) Constraints
| |
(All Slices) | There are no (further) constraints on this element | |||
id | 0..1 | string | There are no (further) constraints on this element Element idPlanDefinition.action.input.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPlanDefinition.action.input.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
type | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idPlanDefinition.action.input.type The type of the required data DefinitionThe type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile. Note that FHIR strings SHALL NOT exceed 1MB in size A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
|
profile | Σ | 0..0 | canonical(StructureDefinition) | There are no (further) constraints on this element Element idPlanDefinition.action.input.profile The profile of the required data DefinitionThe profile of the required data, specified as the uri of the profile definition. canonical(StructureDefinition) Constraints
|
subject[x] | Σ | 0..0 | Binding | There are no (further) constraints on this element Element idPlanDefinition.action.input.subject[x] E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device DefinitionThe intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed. The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration. Patient The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
|
mustSupport | Σ | 0..0 | string | There are no (further) constraints on this element Element idPlanDefinition.action.input.mustSupport Indicates specific structure elements that are referenced by the knowledge module DefinitionIndicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details). Note that FHIR strings SHALL NOT exceed 1MB in size
|
codeFilter | Σ I | 0..0 | Element | There are no (further) constraints on this element Element idPlanDefinition.action.input.codeFilter What codes are expected DefinitionCode filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.
|
dateFilter | Σ I | 0..0 | Element | There are no (further) constraints on this element Element idPlanDefinition.action.input.dateFilter What dates/date ranges are expected DefinitionDate filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.
|
limit | Σ | 0..0 | positiveInt | There are no (further) constraints on this element Element idPlanDefinition.action.input.limit Number of results DefinitionSpecifies a maximum number of results that are required (uses the _count search parameter). Enables the requirement "most recent 5 results" to be expressed. This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".
|
sort | Σ | 0..0 | Element | There are no (further) constraints on this element Element idPlanDefinition.action.input.sort Order of the results DefinitionSpecifies the order of the results to be returned. Enables the requirement "most recent 5 results" to be expressed. This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.
|
Render | 0..1 | DataRequirement | There are no (further) constraints on this element Element idPlanDefinition.action.input:Render Input data requirements DefinitionDefines input data requirements for the action.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idPlanDefinition.action.input:Render.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | Element idPlanDefinition.action.input:Render.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
rendererInput | I | 0..* | Extension | Element idPlanDefinition.action.input:Render.extension:rendererInput Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. http://mobileforms.purified.link/fhir/StructureDefinition/MFRSInputExtension Constraints
|
type | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idPlanDefinition.action.input:Render.type The type of the required data DefinitionThe type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile. Note that FHIR strings SHALL NOT exceed 1MB in size A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
|
profile | Σ | 0..0 | canonical(StructureDefinition) | There are no (further) constraints on this element Element idPlanDefinition.action.input:Render.profile The profile of the required data DefinitionThe profile of the required data, specified as the uri of the profile definition. canonical(StructureDefinition) Constraints
|
subject[x] | Σ | 0..0 | Binding | There are no (further) constraints on this element Element idPlanDefinition.action.input:Render.subject[x] E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device DefinitionThe intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed. The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration. Patient The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
|
mustSupport | Σ | 0..0 | string | There are no (further) constraints on this element Element idPlanDefinition.action.input:Render.mustSupport Indicates specific structure elements that are referenced by the knowledge module DefinitionIndicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details). Note that FHIR strings SHALL NOT exceed 1MB in size
|
codeFilter | Σ I | 0..0 | Element | There are no (further) constraints on this element Element idPlanDefinition.action.input:Render.codeFilter What codes are expected DefinitionCode filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.
|
dateFilter | Σ I | 0..0 | Element | There are no (further) constraints on this element Element idPlanDefinition.action.input:Render.dateFilter What dates/date ranges are expected DefinitionDate filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.
|
limit | Σ | 0..0 | positiveInt | There are no (further) constraints on this element Element idPlanDefinition.action.input:Render.limit Number of results DefinitionSpecifies a maximum number of results that are required (uses the _count search parameter). Enables the requirement "most recent 5 results" to be expressed. This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".
|
sort | Σ | 0..0 | Element | There are no (further) constraints on this element Element idPlanDefinition.action.input:Render.sort Order of the results DefinitionSpecifies the order of the results to be returned. Enables the requirement "most recent 5 results" to be expressed. This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.
|
SMS | 0..1 | DataRequirement | There are no (further) constraints on this element Element idPlanDefinition.action.input:SMS Input data requirements DefinitionDefines input data requirements for the action.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idPlanDefinition.action.input:SMS.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | Element idPlanDefinition.action.input:SMS.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
SMSGateWayInput | I | 0..* | Extension(Complex) | Element idPlanDefinition.action.input:SMS.extension:SMSGateWayInput Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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. Extension(Complex) Extension URLhttp://mobileforms.purified.link/StructureDefinition/SMSGatewayInputExtension Constraints
|
type | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idPlanDefinition.action.input:SMS.type The type of the required data DefinitionThe type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile. Note that FHIR strings SHALL NOT exceed 1MB in size A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
|
profile | Σ | 0..0 | canonical(StructureDefinition) | There are no (further) constraints on this element Element idPlanDefinition.action.input:SMS.profile The profile of the required data DefinitionThe profile of the required data, specified as the uri of the profile definition. canonical(StructureDefinition) Constraints
|
subject[x] | Σ | 0..0 | Binding | There are no (further) constraints on this element Element idPlanDefinition.action.input:SMS.subject[x] E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device DefinitionThe intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed. The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration. Patient The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
|
mustSupport | Σ | 0..0 | string | There are no (further) constraints on this element Element idPlanDefinition.action.input:SMS.mustSupport Indicates specific structure elements that are referenced by the knowledge module DefinitionIndicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details). Note that FHIR strings SHALL NOT exceed 1MB in size
|
codeFilter | Σ I | 0..0 | Element | There are no (further) constraints on this element Element idPlanDefinition.action.input:SMS.codeFilter What codes are expected DefinitionCode filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.
|
dateFilter | Σ I | 0..0 | Element | There are no (further) constraints on this element Element idPlanDefinition.action.input:SMS.dateFilter What dates/date ranges are expected DefinitionDate filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.
|
limit | Σ | 0..0 | positiveInt | There are no (further) constraints on this element Element idPlanDefinition.action.input:SMS.limit Number of results DefinitionSpecifies a maximum number of results that are required (uses the _count search parameter). Enables the requirement "most recent 5 results" to be expressed. This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".
|
sort | Σ | 0..0 | Element | There are no (further) constraints on this element Element idPlanDefinition.action.input:SMS.sort Order of the results DefinitionSpecifies the order of the results to be returned. Enables the requirement "most recent 5 results" to be expressed. This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.
|
output | 0..0 | DataRequirement | There are no (further) constraints on this element Element idPlanDefinition.action.output Output data definition DefinitionDefines the outputs of the action, if any.
| |
relatedAction | 0..0 | BackboneElement | There are no (further) constraints on this element Element idPlanDefinition.action.relatedAction Relationship to another action DefinitionA relationship to another action such as "before" or "30-60 minutes after start of". 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.
| |
timing[x] | 0..1 | There are no (further) constraints on this element Element idPlanDefinition.action.timing[x] When the action should take place DefinitionAn optional value describing when the action should be performed.
| ||
timingDateTime | dateTime | There are no (further) constraints on this element Data type | ||
timingAge | Age | There are no (further) constraints on this element Data type | ||
timingPeriod | Period | There are no (further) constraints on this element Data type | ||
timingDuration | Duration | There are no (further) constraints on this element Data type | ||
timingRange | Range | There are no (further) constraints on this element Data type | ||
timingTiming | Timing | There are no (further) constraints on this element Data type | ||
participant | 0..0 | BackboneElement | There are no (further) constraints on this element Element idPlanDefinition.action.participant Who should participate in the action DefinitionIndicates who should participate in performing the action described.
| |
type | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idPlanDefinition.action.type create | update | remove | fire-event DefinitionThe type of action to perform (create, update, remove). Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The type of action to be performed.
| |
groupingBehavior | 0..0 | codeBinding | There are no (further) constraints on this element Element idPlanDefinition.action.groupingBehavior visual-group | logical-group | sentence-group DefinitionDefines the grouping behavior for the action and its children. Note that FHIR strings SHALL NOT exceed 1MB in size Defines organization behavior of a group.
| |
selectionBehavior | 0..0 | codeBinding | There are no (further) constraints on this element Element idPlanDefinition.action.selectionBehavior any | all | all-or-none | exactly-one | at-most-one | one-or-more DefinitionDefines the selection behavior for the action and its children. Note that FHIR strings SHALL NOT exceed 1MB in size Defines selection behavior of a group.
| |
requiredBehavior | 0..0 | codeBinding | There are no (further) constraints on this element Element idPlanDefinition.action.requiredBehavior must | could | must-unless-documented DefinitionDefines the required behavior for the action. Note that FHIR strings SHALL NOT exceed 1MB in size Defines expectations around whether an action or action group is required.
| |
precheckBehavior | 0..0 | codeBinding | There are no (further) constraints on this element Element idPlanDefinition.action.precheckBehavior yes | no DefinitionDefines whether the action should usually be preselected. Note that FHIR strings SHALL NOT exceed 1MB in size Defines selection frequency behavior for an action or group.
| |
cardinalityBehavior | 0..0 | codeBinding | There are no (further) constraints on this element Element idPlanDefinition.action.cardinalityBehavior single | multiple DefinitionDefines whether the action can be selected multiple times. Note that FHIR strings SHALL NOT exceed 1MB in size Defines behavior for an action or a group for how many times that item may be repeated.
| |
definition[x] | 0..1 | There are no (further) constraints on this element Element idPlanDefinition.action.definition[x] Description of the activity to be performed DefinitionA 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. 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.
| ||
definitionUri | uri | Data type | ||
transform | 0..0 | canonical(StructureMap) | There are no (further) constraints on this element Element idPlanDefinition.action.transform Transform to apply the template DefinitionA 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. 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.
| |
dynamicValue | 0..0 | BackboneElement | There are no (further) constraints on this element Element idPlanDefinition.action.dynamicValue Dynamic aspects of the definition DefinitionCustomizations 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. 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.
| |
action | 0..0 | see (action) | There are no (further) constraints on this element Element idPlanDefinition.action.action A sub-action DefinitionSub 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.
|