This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical and non-clinical artifacts such as clinical decision support rules, order sets, protocols, and drug quality specifications.

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

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.

An Extension

STU3: PlanDefinition.contributor (new:Contributor)

Element PlanDefinition.contributor has a context of PlanDefinition based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.contributor has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

The 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.

STU3: PlanDefinition.meta additional types (Meta) additional types from child elements (lastUpdated, profile, security, tag, versionId)

Element PlanDefinition.meta is mapped to FHIR R4B element PlanDefinition.meta as SourceIsBroaderThanTarget. The mappings for PlanDefinition.meta do not cover the following types: Meta. The mappings for PlanDefinition.meta do not cover the following types based on type expansion: lastUpdated, profile, security, tag, versionId.

STU3: PlanDefinition.text additional types (Narrative) additional types from child elements (div, status)

Element PlanDefinition.text is mapped to FHIR R4B element PlanDefinition.text as SourceIsBroaderThanTarget. The mappings for PlanDefinition.text do not cover the following types: Narrative. The mappings for PlanDefinition.text do not cover the following types based on type expansion: div, status. 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.

STU3: PlanDefinition.contributor (new:Contributor)

Element PlanDefinition.contributor has a context of PlanDefinition based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.contributor has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

STU3: PlanDefinition.identifier additional types (Identifier) additional types from child elements (assigner, period, system, type, use, value)

Element PlanDefinition.identifier is mapped to FHIR R4B element PlanDefinition.identifier as SourceIsBroaderThanTarget. The mappings for PlanDefinition.identifier do not cover the following types: Identifier. The mappings for PlanDefinition.identifier do not cover the following types based on type expansion: assigner, period, system, type, use, value. 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.

STU3: PlanDefinition.contact additional types (ContactDetail) additional types from child elements (name, telecom)

Element PlanDefinition.contact is mapped to FHIR R4B element PlanDefinition.contact as SourceIsBroaderThanTarget. The mappings for PlanDefinition.contact do not cover the following types: ContactDetail. The mappings for PlanDefinition.contact do not cover the following types based on type expansion: name, telecom. May be a web site, an email address, a telephone number, etc.

STU3: PlanDefinition.useContext additional types (UsageContext) additional types from child elements (code, value[x])

Element PlanDefinition.useContext is mapped to FHIR R4B element PlanDefinition.useContext as SourceIsBroaderThanTarget. The mappings for PlanDefinition.useContext do not cover the following types: UsageContext. The mappings for PlanDefinition.useContext do not cover the following types based on type expansion: code, value[x]. When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.

STU3: PlanDefinition.effectivePeriod additional types (Period) additional types from child elements (end, start)

Element PlanDefinition.effectivePeriod is mapped to FHIR R4B element PlanDefinition.effectivePeriod as SourceIsBroaderThanTarget. The mappings for PlanDefinition.effectivePeriod do not cover the following types: Period. The mappings for PlanDefinition.effectivePeriod do not cover the following types based on type expansion: end, start. 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.

STU3: PlanDefinition.relatedArtifact additional types (RelatedArtifact) additional types from child elements (citation, display, document, resource, type, url)

Element PlanDefinition.relatedArtifact is mapped to FHIR R4B element PlanDefinition.relatedArtifact as SourceIsBroaderThanTarget. The mappings for PlanDefinition.relatedArtifact do not cover the following types: RelatedArtifact. The mappings for PlanDefinition.relatedArtifact do not cover the following types based on type expansion: citation, display, document, resource, type, url. Each related artifact is either an attachment, or a reference to another resource, but not both.

STU3: PlanDefinition.library additional types (Reference(http://hl7.org/fhir/StructureDefinition/Library)) additional types from child elements (display, identifier, reference)

Element PlanDefinition.library is mapped to FHIR R4B element PlanDefinition.library as SourceIsBroaderThanTarget. The mappings for PlanDefinition.library do not cover the following types: Reference. The mappings for PlanDefinition.library do not cover the following types based on type expansion: display, identifier, reference.

STU3: PlanDefinition.goal.documentation additional types (RelatedArtifact) additional types from child elements (citation, display, document, resource, type, url)

Element PlanDefinition.goal.documentation is mapped to FHIR R4B element PlanDefinition.goal.documentation as SourceIsBroaderThanTarget. The mappings for PlanDefinition.goal.documentation do not cover the following types: RelatedArtifact. The mappings for PlanDefinition.goal.documentation do not cover the following types based on type expansion: citation, display, document, resource, type, url.

STU3: PlanDefinition.goal.target.detail[x] additional types (Range)

Element PlanDefinition.goal.target.detail[x] is mapped to FHIR R4B element PlanDefinition.goal.target.detail[x] as SourceIsBroaderThanTarget. The mappings for PlanDefinition.goal.target.detail[x] do not cover the following types: Range. The target context PlanDefinition.goal.target.detail[x] is a choice-type element and cannot directly hold extensions. The context is moved up to parent element PlanDefinition.goal.target.

STU3: PlanDefinition.action.timing[x] additional types (Period, Range, Timing)

Element PlanDefinition.action.timing[x] is mapped to FHIR R4B element PlanDefinition.action.timing[x] as SourceIsBroaderThanTarget. The mappings for PlanDefinition.action.timing[x] do not cover the following types: Period, Range, Timing. The target context PlanDefinition.action.timing[x] is a choice-type element and cannot directly hold extensions. The context is moved up to parent element PlanDefinition.action.

STU3: PlanDefinition.action.definition additional types (Reference(http://hl7.org/fhir/StructureDefinition/ActivityDefinition), Reference(http://hl7.org/fhir/StructureDefinition/PlanDefinition)) additional types from child elements (display, identifier, reference)

Element PlanDefinition.action.definition is mapped to FHIR R4B element PlanDefinition.action.definition[x] as SourceIsBroaderThanTarget. The mappings for PlanDefinition.action.definition do not cover the following types: Reference. The mappings for PlanDefinition.action.definition do not cover the following types based on type expansion: display, identifier, reference. The target context PlanDefinition.action.definition[x] is a choice-type element and cannot directly hold extensions. The context is moved up to parent element PlanDefinition.action. 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.

STU3: PlanDefinition.action.documentation additional types (RelatedArtifact) additional types from child elements (citation, display, document, resource, type, url)

Element PlanDefinition.action.documentation is mapped to FHIR R4B element PlanDefinition.action.documentation as SourceIsBroaderThanTarget. The mappings for PlanDefinition.action.documentation do not cover the following types: RelatedArtifact. The mappings for PlanDefinition.action.documentation do not cover the following types based on type expansion: citation, display, document, resource, type, url.

STU3: PlanDefinition.action.triggerDefinition additional types (TriggerDefinition) additional types from child elements (eventData, eventName, eventTiming[x], type)

Element PlanDefinition.action.triggerDefinition is mapped to FHIR R4B element PlanDefinition.action.trigger as SourceIsBroaderThanTarget. The mappings for PlanDefinition.action.triggerDefinition do not cover the following types: TriggerDefinition. The mappings for PlanDefinition.action.triggerDefinition do not cover the following types based on type expansion: eventData, eventName, eventTiming[x], type.

STU3: PlanDefinition.action.condition.description additional types (string) additional types from child elements (value)

Element PlanDefinition.action.condition.description is mapped to FHIR R4B element PlanDefinition.action.condition.expression as SourceIsBroaderThanTarget. The mappings for PlanDefinition.action.condition.description do not cover the following types: string. The mappings for PlanDefinition.action.condition.description do not cover the following types based on type expansion: value.

STU3: PlanDefinition.action.condition.language additional types (string) additional types from child elements (value)

Element PlanDefinition.action.condition.language is mapped to FHIR R4B element PlanDefinition.action.condition.expression as SourceIsBroaderThanTarget. The mappings for PlanDefinition.action.condition.language do not cover the following types: string. The mappings for PlanDefinition.action.condition.language do not cover the following types based on type expansion: value.

STU3: PlanDefinition.action.condition.expression additional types (string) additional types from child elements (value)

Element PlanDefinition.action.condition.expression is mapped to FHIR R4B element PlanDefinition.action.condition.expression as SourceIsBroaderThanTarget. The mappings for PlanDefinition.action.condition.expression do not cover the following types: string. The mappings for PlanDefinition.action.condition.expression do not cover the following types based on type expansion: value. The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element.

STU3: PlanDefinition.action.input additional types (DataRequirement) additional types from child elements (codeFilter, path, valueCode, valueCodeableConcept, valueCoding, valueSet[x], dateFilter, value[x], mustSupport, profile, type)

Element PlanDefinition.action.input is mapped to FHIR R4B element PlanDefinition.action.input as SourceIsBroaderThanTarget. The mappings for PlanDefinition.action.input do not cover the following types: DataRequirement. The mappings for PlanDefinition.action.input do not cover the following types based on type expansion: codeFilter, dateFilter, mustSupport, path, profile, type, value[x], valueCode, valueCodeableConcept, valueCoding, valueSet[x].

STU3: PlanDefinition.action.output additional types (DataRequirement) additional types from child elements (codeFilter, path, valueCode, valueCodeableConcept, valueCoding, valueSet[x], dateFilter, value[x], mustSupport, profile, type)

Element PlanDefinition.action.output is mapped to FHIR R4B element PlanDefinition.action.output as SourceIsBroaderThanTarget. The mappings for PlanDefinition.action.output do not cover the following types: DataRequirement. The mappings for PlanDefinition.action.output do not cover the following types based on type expansion: codeFilter, dateFilter, mustSupport, path, profile, type, value[x], valueCode, valueCodeableConcept, valueCoding, valueSet[x].

STU3: PlanDefinition.action.relatedAction.offset[x] additional types (Range) additional types from child elements (high, low)

Element PlanDefinition.action.relatedAction.offset[x] is mapped to FHIR R4B element PlanDefinition.action.relatedAction.offset[x] as SourceIsBroaderThanTarget. The mappings for PlanDefinition.action.relatedAction.offset[x] do not cover the following types: Range. The mappings for PlanDefinition.action.relatedAction.offset[x] do not cover the following types based on type expansion: high, low. The target context PlanDefinition.action.relatedAction.offset[x] is a choice-type element and cannot directly hold extensions. The context is moved up to parent element PlanDefinition.action.relatedAction.

STU3: PlanDefinition.action.type

Element PlanDefinition.action.type is mapped to FHIR R4B element PlanDefinition.action.type as SourceIsNarrowerThanTarget.

STU3: PlanDefinition.action.transform additional types (Reference(http://hl7.org/fhir/StructureDefinition/StructureMap)) additional types from child elements (display, identifier, reference)

Element PlanDefinition.action.transform is mapped to FHIR R4B element PlanDefinition.action.transform as SourceIsBroaderThanTarget. The mappings for PlanDefinition.action.transform do not cover the following types: Reference. The mappings for PlanDefinition.action.transform do not cover the following types based on type expansion: display, identifier, reference.

STU3: PlanDefinition.action.dynamicValue.description additional types (string) additional types from child elements (value)

Element PlanDefinition.action.dynamicValue.description is mapped to FHIR R4B element PlanDefinition.action.dynamicValue.expression as SourceIsBroaderThanTarget. The mappings for PlanDefinition.action.dynamicValue.description do not cover the following types: string. The mappings for PlanDefinition.action.dynamicValue.description do not cover the following types based on type expansion: value.

STU3: PlanDefinition.action.dynamicValue.language additional types (string) additional types from child elements (value)

Element PlanDefinition.action.dynamicValue.language is mapped to FHIR R4B element PlanDefinition.action.dynamicValue.expression as SourceIsBroaderThanTarget. The mappings for PlanDefinition.action.dynamicValue.language do not cover the following types: string. The mappings for PlanDefinition.action.dynamicValue.language do not cover the following types based on type expansion: value.

STU3: PlanDefinition.action.dynamicValue.expression additional types (string) additional types from child elements (value)

Element PlanDefinition.action.dynamicValue.expression is mapped to FHIR R4B element PlanDefinition.action.dynamicValue.expression as SourceIsBroaderThanTarget. The mappings for PlanDefinition.action.dynamicValue.expression do not cover the following types: string. The mappings for PlanDefinition.action.dynamicValue.expression do not cover the following types based on type expansion: value. The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element.

This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical and non-clinical artifacts such as clinical decision support rules, order sets, protocols, and drug quality specifications.

The 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.

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

An Extension

STU3: PlanDefinition.meta additional types (Meta) additional types from child elements (lastUpdated, profile, security, tag, versionId)

Element PlanDefinition.meta is mapped to FHIR R4B element PlanDefinition.meta as SourceIsBroaderThanTarget. The mappings for PlanDefinition.meta do not cover the following types: Meta. The mappings for PlanDefinition.meta do not cover the following types based on type expansion: lastUpdated, profile, security, tag, versionId.

The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

When the resource last changed - e.g. when the version changed.

This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

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.

The 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).

IETF language tag

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

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.

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

An Extension

STU3: PlanDefinition.text additional types (Narrative) additional types from child elements (div, status)

Element PlanDefinition.text is mapped to FHIR R4B element PlanDefinition.text as SourceIsBroaderThanTarget. The mappings for PlanDefinition.text do not cover the following types: Narrative. The mappings for PlanDefinition.text do not cover the following types based on type expansion: div, status. 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.

The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.

The actual narrative content, a stripped down version of XHTML.

The contents of the html element are an XHTML fragment containing only the basic html formatting elements described in chapters 7-11 and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained stylesheets. The XHTML content SHALL NOT contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects.

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.

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.

An Extension

STU3: PlanDefinition.contributor (new:Contributor)

Element PlanDefinition.contributor has a context of PlanDefinition based on following the parent source element upwards and mapping to PlanDefinition. Element PlanDefinition.contributor has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this plan definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the plan definition is stored on different servers.

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.

Allows the plan definition to be referenced by a single globally unique identifier.

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.

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.

Allows externally provided and/or usable business identifiers to be easily associated with the module.

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

An Extension

STU3: PlanDefinition.identifier additional types (Identifier) additional types from child elements (assigner, period, system, type, use, value)

Element PlanDefinition.identifier is mapped to FHIR R4B element PlanDefinition.identifier as SourceIsBroaderThanTarget. The mappings for PlanDefinition.identifier do not cover the following types: Identifier. The mappings for PlanDefinition.identifier do not cover the following types based on type expansion: assigner, period, system, type, use, value. 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.

The purpose of this identifier.

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Allows users to make use of identifiers when the identifier system is not known.

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Identifier.system is always case sensitive.

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Time period during which identifier is/was valid for use.

Organization that issued/manages the identifier.

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

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.

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].

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.

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.

Support human navigation and code generation.

A 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.

An explanatory or alternate title for the plan definition giving additional information about its content.

A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition.

The type of PlanDefinition.

The 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.

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.

Allows filtering of plan definitions that are appropriate for use versus not.

Enables experimental content to be developed following the same lifecycle that would be used for a production-level plan definition.

A code, group definition, or canonical reference that describes or identifies the intended subject of the plan definition. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.

Note that the choice of canonical for the subject element was introduced in R4B to support pharmaceutical quality use cases. To ensure as much backwards-compatibility as possible, it is recommended to only use the new canonical type with these use cases.

The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).

The date (and optionally time) when the plan definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the plan definition changes.

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.

The name of the organization or individual that published the plan definition.

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.

Helps establish the "authority/credibility" of the plan definition. May also allow for contact.

Contact details to assist a user in finding and communicating with the publisher.

May be a web site, an email address, a telephone number, etc.

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

An Extension

STU3: PlanDefinition.contact additional types (ContactDetail) additional types from child elements (name, telecom)

Element PlanDefinition.contact is mapped to FHIR R4B element PlanDefinition.contact as SourceIsBroaderThanTarget. The mappings for PlanDefinition.contact do not cover the following types: ContactDetail. The mappings for PlanDefinition.contact do not cover the following types based on type expansion: name, telecom. May be a web site, an email address, a telephone number, etc.

The name of an individual to contact.

If there is no named individual, the telecom information is for the organization as a whole.

The contact details for the individual (if a name was provided) or the organization.

A 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).

The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances.

When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

Assist in searching for appropriate content.

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

An Extension

STU3: PlanDefinition.useContext additional types (UsageContext) additional types from child elements (code, value[x])

Element PlanDefinition.useContext is mapped to FHIR R4B element PlanDefinition.useContext as SourceIsBroaderThanTarget. The mappings for PlanDefinition.useContext do not cover the following types: UsageContext. The mappings for PlanDefinition.useContext do not cover the following types based on type expansion: code, value[x]. When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.

A code that identifies the type of context being specified by this usage context.

A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.

A 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.

Explanation 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.

A detailed description of how the plan definition is used from a clinical perspective.

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.

Consumers must be able to determine any legal restrictions on the use of the plan definition and/or its content.

The 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.

The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

If specified, this date follows 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.

The period during which the plan definition content was or is planned to be in active use.

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.

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.

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

An Extension

STU3: PlanDefinition.effectivePeriod additional types (Period) additional types from child elements (end, start)

Element PlanDefinition.effectivePeriod is mapped to FHIR R4B element PlanDefinition.effectivePeriod as SourceIsBroaderThanTarget. The mappings for PlanDefinition.effectivePeriod do not cover the following types: Period. The mappings for PlanDefinition.effectivePeriod do not cover the following types based on type expansion: end, start. 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.

The start of the period. The boundary is inclusive.

If the low element is missing, the meaning is that the low boundary is not known.

The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

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.

High-level categorization of the definition, used for searching, sorting, and filtering.

Repositories must be able to determine how to categorize the plan definition so that it can be found by topical searches.

An individiual or organization primarily involved in the creation and maintenance of the content.

An individual or organization primarily responsible for internal coherence of the content.

An individual or organization primarily responsible for review of some aspect of the content.

An individual or organization responsible for officially endorsing the content for use in some setting.

Related artifacts such as additional documentation, justification, or bibliographic references.

Each related artifact is either an attachment, or a reference to another resource, but not both.

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.

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

An Extension

STU3: PlanDefinition.relatedArtifact additional types (RelatedArtifact) additional types from child elements (citation, display, document, resource, type, url)

Element PlanDefinition.relatedArtifact is mapped to FHIR R4B element PlanDefinition.relatedArtifact as SourceIsBroaderThanTarget. The mappings for PlanDefinition.relatedArtifact do not cover the following types: RelatedArtifact. The mappings for PlanDefinition.relatedArtifact do not cover the following types based on type expansion: citation, display, document, resource, type, url. Each related artifact is either an attachment, or a reference to another resource, but not both.

The type of relationship to the related artifact.

A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.

A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.

A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.

Additional structured information about citations should be captured as extensions.

A url for the artifact that can be followed to access the actual content.

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).

The document being referenced, represented as an attachment. This is exclusive with the resource element.

The related resource, such as a library, value set, profile, or other knowledge resource.

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.

A reference to a Library resource containing any formal logic used by the plan definition.

unique id for the element within a resource (for internal references)

An Extension

STU3: PlanDefinition.library additional types (Reference(http://hl7.org/fhir/StructureDefinition/Library)) additional types from child elements (display, identifier, reference)

Element PlanDefinition.library is mapped to FHIR R4B element PlanDefinition.library as SourceIsBroaderThanTarget. The mappings for PlanDefinition.library do not cover the following types: Reference. The mappings for PlanDefinition.library do not cover the following types based on type expansion: display, identifier, reference.

Primitive value for canonical

A goal describes an expected outcome that 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, meeting the acceptance criteria for a test as specified by a quality specification, 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.

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Indicates a category the goal falls within.

Example codes for grouping goals for filtering or presentation.

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".

If no code is available, use CodeableConcept.text.

Describes goals that can be achieved.

Identifies the expected level of importance associated with reaching/sustaining the defined goal.

Indicates the level of importance associated with reaching or sustaining a goal.

The event after which the goal should begin being pursued.

Identifies the types of events that might trigger the start of a goal.

Identifies problems, conditions, issues, or concerns the goal is intended to address.

Identifies problems, conditions, issues, or concerns that goals may address.

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.

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

An Extension

STU3: PlanDefinition.goal.documentation additional types (RelatedArtifact) additional types from child elements (citation, display, document, resource, type, url)

Element PlanDefinition.goal.documentation is mapped to FHIR R4B element PlanDefinition.goal.documentation as SourceIsBroaderThanTarget. The mappings for PlanDefinition.goal.documentation do not cover the following types: RelatedArtifact. The mappings for PlanDefinition.goal.documentation do not cover the following types based on type expansion: citation, display, document, resource, type, url.

The type of relationship to the related artifact.

A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.

A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.

A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.

Additional structured information about citations should be captured as extensions.

A url for the artifact that can be followed to access the actual content.

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).

The document being referenced, represented as an attachment. This is exclusive with the resource element.

The related resource, such as a library, value set, profile, or other knowledge resource.

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.

Indicates what should be done and within what timeframe.

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

An Extension

STU3: PlanDefinition.goal.target.detail[x] additional types (Range)

Element PlanDefinition.goal.target.detail[x] is mapped to FHIR R4B element PlanDefinition.goal.target.detail[x] as SourceIsBroaderThanTarget. The mappings for PlanDefinition.goal.target.detail[x] do not cover the following types: Range. The target context PlanDefinition.goal.target.detail[x] is a choice-type element and cannot directly hold extensions. The context is moved up to parent element PlanDefinition.goal.target.

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

The parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.

Identifies types of parameters that can be tracked to determine goal achievement.