This page is part of the electronic Case Reporting (eCR) (v0.2.0: STU 1 Ballot 2) based on FHIR R3. The current version which supercedes this version is 2.1.0. For a full list of available versions, see the Directory of published versions
Definitions for the StructureDefinition-rr-relevant-reportable-condition-plandefinition Profile.
PlanDefinition | |
Definition | This profile defines the represents reportability information for a condition-jurisdiction pair, based on the PHA in which is located the patient's home, the provider facility, or both locations. The Determination of Reportability, Determination of Reportability Reason, and Determination of Reportability Rule are contained in extensions. This profile also contains extensions for the Responsible Agency, the Rules Authoring Agency, and the Routing Entity. The Relevant Reportable Condition is contained in goal.addresses and any External Resources are contained in action (one action contains the information for one External Resource). |
Control | 0..* |
Must Support | true |
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 | An Extension |
Control | 0..* |
Type | Extension |
PlanDefinition.extension ([CanonicalType[http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-determination-of-reportability]]) | |
Definition | This extension represents the determination of reportability. Reportability is "the quality or state of being reportable or not". Reportability does not equate to the patient having a condition or meeting a case definition (definitively being “a case”). For each condition included in the eICR and the relevant public health agency(s), this element indicates the determination of whether the condition is reportable to public health. The values that can be used for the Determination of Reportability are described below. A possible condition is:
A possible condition:
A possible condition is:
Some decision support systems may not be able to fully differentiate between possible conditions that are Not Reportable and those that May be Reportable if additional information is provided. In these circumstances there may only be a reportability determination of:
The determination of No Reporting Rule Met may be provided for a possible condition or for all conditions in the eICR. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: CodeableConcept) |
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.extension ([CanonicalType[http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-determination-of-reportability-reason]]) | |
Definition | The reason for the determination of reportability. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Choice of: string, CodeableConcept) |
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.extension ([CanonicalType[http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-determination-of-reportability-rule]]) | |
Definition | A rule that was involved in the determination of the reportability status. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | (Extension Type: string) |
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.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. |
Fixed Value | active |
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 | 1..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 ([CanonicalType[http://hl7.org/fhir/us/ecr/StructureDefinition/extension-ecr-organization]]) | |
Definition | This extension represents an eCR Organization. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Reference(ecr-organization)) |
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.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.publisher.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.publisher.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://hl7.org/fhir/us/ecr/StructureDefinition/extension-ecr-organization |
PlanDefinition.publisher.extension.valueReference(valueReference) | |
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 | 1..1 |
Type | Reference(rr-rules-authoring-agency) |
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 |
Must Support | true |
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.jurisdiction.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.jurisdiction.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
PlanDefinition.jurisdiction.extension ([CanonicalType[http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-location-relevance]]) | |
Definition | A code indicating whether the responsible PHA is relevant because of the patient's home address, the provider facility address, or both. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: CodeableConcept) |
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.jurisdiction.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.jurisdiction.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.jurisdiction.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://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-location-relevance |
PlanDefinition.jurisdiction.extension.valueCodeableConcept(valueCodeableConcept) | |
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 | 1..1 |
Binding | The codes SHALL be taken from Location Relevance (eCR); other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Example | General:<valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="urn:oid:2.16.840.1.114222.4.5.274"/> <code value="RRVS5"/> <display value="Patient home address"/> </coding> </valueCodeableConcept> |
PlanDefinition.jurisdiction.extension ([CanonicalType[http://hl7.org/fhir/us/ecr/StructureDefinition/extension-ecr-organization]]) | |
Definition | This extension represents an eCR Organization. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Reference(ecr-organization)) |
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.jurisdiction.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.jurisdiction.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.jurisdiction.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://hl7.org/fhir/us/ecr/StructureDefinition/extension-ecr-organization |
PlanDefinition.jurisdiction.extension.valueReference(valueReference) | |
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 | 1..1 |
Type | Reference(rr-routing-entity) |
PlanDefinition.jurisdiction.extension ([CanonicalType[http://hl7.org/fhir/us/ecr/StructureDefinition/extension-ecr-organization]]) | |
Definition | This extension represents an eCR Organization. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Reference(ecr-organization)) |
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.jurisdiction.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.jurisdiction.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.jurisdiction.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://hl7.org/fhir/us/ecr/StructureDefinition/extension-ecr-organization |
PlanDefinition.jurisdiction.extension.valueReference(valueReference) | |
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 | 1..1 |
Type | Reference(rr-responsible-agency) |
PlanDefinition.jurisdiction.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 0..* |
Type | Coding |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
PlanDefinition.jurisdiction.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Control | 0..1 |
Type | string |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
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 | Related artifacts such as additional documentation, justification, or bibliographic references. |
Control | 0..* |
Type | RelatedArtifact |
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.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 | To give clinical feedback to the clinician is the goal of this plan. |
Control | 1..1 |
Type | BackboneElement |
Must Support | true |
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 |
Must Support | true |
Comments | If no code is available, use CodeableConcept.text. |
PlanDefinition.goal.description.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.description.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.description.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 0..0 |
Type | Coding |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
PlanDefinition.goal.description.text | |
Definition | Hard coded text description of the goal of the plan (clinical feedback) |
Control | 1..1 |
Type | string |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Example | General:Clinical feedback |
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 | The relevant reportable condition addressed by this plan. When the eICR is manually initiated or no reportable condition has been identified (e.g. when there is no rule met) neither coding nor text will be used. If there is no available condition code use text to specify the condition. |
Control | 1..1 |
Binding | Identifies problems, conditions, issues, or concerns that goals may address For example codes, see Condition/Problem/Diagnosis Codes |
Type | CodeableConcept |
Must Support | true |
PlanDefinition.goal.addresses.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
PlanDefinition.goal.addresses.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.addresses.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 0..1 |
Type | Coding |
Must Support | true |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
PlanDefinition.goal.addresses.coding.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.addresses.coding.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.addresses.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 0..1 |
Type | uri |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. |
Fixed Value | http://snomed.info/sct |
PlanDefinition.goal.addresses.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 |
Type | string |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
PlanDefinition.goal.addresses.coding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Control | 0..1 |
Type | code |
Requirements | Need to refer to a particular code in the system. |
PlanDefinition.goal.addresses.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Control | 0..1 |
Type | string |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
PlanDefinition.goal.addresses.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Control | 0..1 |
Type | boolean |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
PlanDefinition.goal.addresses.text | |
Definition | Use text if there is no available code for the relevant reportable condition. |
Control | 0..1 |
Type | string |
Must Support | true |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
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 | Contains one or more external resources and information related to that resource. |
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 | An external resources such as a text guidance, link to access forms for additional reporting needs, additional testing and/or laboratory testing needs, treatment and/or prevention resources, Public Health Agency contact information and general additional resources. The type/category of the external resource is contained in the External Resource Type extension located in extension-rr-external-resource-type, and the priority placed on the external resource is represented in the extension-rr-priority. |
Control | 1..* |
Type | RelatedArtifact |
Must Support | true |
PlanDefinition.action.documentation.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.documentation.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
PlanDefinition.action.documentation.extension ([CanonicalType[http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-external-resource-type]]) | |
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: CodeableConcept) |
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.action.documentation.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.action.documentation.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.action.documentation.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://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-external-resource-type |
PlanDefinition.action.documentation.extension.valueCodeableConcept(valueCodeableConcept) | |
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 | 1..1 |
Binding | The codes SHALL be taken from External Resource Type (eCR); other codes may be used where these codes are not suitable |
Type | CodeableConcept |
PlanDefinition.action.documentation.extension ([CanonicalType[http://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-priority]]) | |
Definition | Priority given to the communication or one or more external resources. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: CodeableConcept) |
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.action.documentation.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.action.documentation.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.action.documentation.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://hl7.org/fhir/us/ecr/StructureDefinition/extension-rr-priority |
PlanDefinition.action.documentation.extension.valueCodeableConcept(valueCodeableConcept) | |
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 | 1..1 |
Binding | Priority given to the whole communication or one or more external resources The codes SHALL be taken from Reportability Priority (eCR); other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Example | General:<valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="urn:oid:2.16.840.1.114222.4.5.232"/> <code value="RRVS17"/> <display value="Action required"/> </coding> </valueCodeableConcept> |
PlanDefinition.action.documentation.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.action.documentation.display | |
Definition | Text description of the external resource. |
Control | 1..1 |
Type | string |
Must Support | true |
PlanDefinition.action.documentation.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.action.documentation.url | |
Definition | Link to an external reference for supplemental information requests, public health contact information for the responsible agency(ies), and additional information of relevance to the relevant reportable condition. |
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.action.documentation.document | |
Definition | The document being referenced, represented as an attachment. This is exclusive with the resource element. |
Control | 0..1 |
Type | Attachment |
PlanDefinition.action.documentation.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.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.timingDuration(timingDuration) | |
Definition | The timeframe in which the receiver should take the actions specified. |
Control | 0..1 |
Type | Duration |
Must Support | true |
Example | General:null |
PlanDefinition.action.timingDuration.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.timingDuration.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.timingDuration.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Control | 1..1 |
Type | decimal |
Must Support | true |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). |
PlanDefinition.action.timingDuration.comparator | |
Definition | How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value. |
Control | 0..1 |
Binding | How the Quantity should be understood and represented. The codes SHALL be taken from QuantityComparator |
Type | code |
Is Modifier | true |
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
Comments | This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value. |
Meaning if Missing | If there is no comparator, then there is no modification of the value |
PlanDefinition.action.timingDuration.unit | |
Definition | A human-readable form of the unit. |
Control | 1..1 |
Type | string |
Must Support | true |
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
PlanDefinition.action.timingDuration.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Control | 0..1 This element is affected by the following invariants: qty-3 |
Type | uri |
Requirements | Need to know the system that defines the coded form of the unit. |
PlanDefinition.action.timingDuration.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Control | 0..1 |
Type | code |
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. |
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. |
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 | Reference(ActivityDefinition | 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 |