NCCN Templates® 1.0

StructureDefinition: - Detailed Descriptions

Definitions for the StructureDefinition-order-template Profile.

PlanDefinition(orderTemplate)
Definition

The NCCN Order Template Profile is based upon the core FHIR PlanDefinition Resource and designed to improve the safety and effectiveness of cancer treatment protocols.

Control0..*
InvariantsDefined 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

A unique identifier for this order template within the NCCN catalog.

Control1..1
Typeid
Comments

On the NCCN FHIR server, this will always match the value of the identifier.

Max Length64
Example
General:BRS1
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.

Control1..1
TypeMeta
PlanDefinition.meta.id
Definition

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

Control0..0
Typestring
PlanDefinition.meta.extension
Definition

An Extension

Control0..0
TypeExtension
PlanDefinition.meta.versionId
Definition

On the NCCN FHIR server, this will always be in a format like [external version].[internal version]. The external version number is incremented each time the template is duplicated into a new version. The internal version number will increment with each save. Only published versions will be available from the API.

Control1..1
Typeid
Comments

This version number can be used for finding and retrieving specific versions of an OrderTemplate via the API. However, data consumers should use PlanDefinition.version as the primary source of version information because FHIR servers may override the Meta.versionId when a resource is copied.

Example
General:1.1
PlanDefinition.meta.lastUpdated
Definition

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

Control1..1
Typeinstant
Comments

This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant.

PlanDefinition.meta.profile
Definition

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

Control1..1
Typeuri
Comments

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

Fixed Valuehttp://nccn.org/fhir/StructureDefinition/order-template
PlanDefinition.meta.security
Definition

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

Control0..0
BindingSecurity Labels from the Healthcare Privacy and Security Classification System.
The codes SHALL be taken from All Security Labels; other codes may be used where these codes are not suitable
TypeCoding
Comments

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

PlanDefinition.meta.tag
Definition

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

Control0..0
BindingCodes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
For example codes, see Common Tags
TypeCoding
Comments

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

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.

Control0..0
Typeuri
Is Modifiertrue
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 as much as possible.

PlanDefinition.language
Definition

The base language in which the resource is written.

Control0..0
BindingA human language.
The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable
Typecode
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.

Control1..1 This element is affected by the following invariants: dom-1
TypeNarrative
Must Supporttrue
Alternate Namesnarrative, 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

Medication entries with dosage instructions that are contained within the regimen.

Control1..*
TypeActivityDefinition(Regimen Entry Template)
Alternate Namesinline resources, anonymous resources, contained resources
Comments

Each regimen entry would typically become a separate order when the regimen is ordered for a patient.

PlanDefinition.extension (http://nccn.org/fhir/StructureDefinition/template-note)
Definition

Cautionary or informational notes for ensuring the safe and effective administration of the regimen.

Control0..* This element is affected by the following invariants: ele-1
Type (Extension Type: Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: children().count() > id.count())
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
PlanDefinition.modifierExtension
Definition

An Extension

Control0..0
TypeExtension
Is Modifiertrue
PlanDefinition.url
Definition

An absolute URL 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.

Control0..0
Typeuri
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.

PlanDefinition.identifier(templateId)
Definition

A unique identifier for this order template within the NCCN catalog.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control1..1
TypeIdentifier
Must Supporttrue
Requirements

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

Comments

This identifier persists across versions of the template.

PlanDefinition.identifier.id
Definition

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

Control0..0
Typestring
PlanDefinition.identifier.extension
Definition

An Extension

Control0..0
TypeExtension
PlanDefinition.identifier.use
Definition

The purpose of this identifier.

Control0..0
BindingIdentifies the purpose for this identifier, if known .
The codes SHALL be taken from IdentifierUse
Typecode
Is Modifiertrue
Requirements

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

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

PlanDefinition.identifier.type
Definition

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

Control0..0
BindingA coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
The codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable
TypeCodeableConcept
Requirements

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

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.

Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

PlanDefinition.identifier.system
Definition

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

Control1..1
Typeuri
Requirements

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

Fixed Valuehttp://nccn.org/fhir/ordertemplates/ID
Example
General:http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
PlanDefinition.identifier.value
Definition

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

Control1..1
Typestring
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.

Max Length64
Example
General:123456
General:BRS1
PlanDefinition.identifier.period
Definition

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

Control0..0
TypePeriod
PlanDefinition.identifier.assigner
Definition

Organization that issued/manages the identifier.

Control0..0
TypeReference(Organization)
Comments

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

PlanDefinition.version
Definition

The external version number of the Order Template.

NoteThis is a business versionId, not a resource version id (see discussion)
Control1..1
Typestring
Must Supporttrue
Comments

On the NCCN server, this will always match the first number of the meta.versionId.

Example
General:1
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.

Control0..0
Typestring
Requirements

Support human navigation & code generation.

Comments

The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure it is computable friendly.

PlanDefinition.title
Definition

A short, descriptive, user-friendly title for the plan definition.

Control1..1
Typestring
Must Supporttrue
Max Length516
PlanDefinition.type
Definition

The type of asset the plan definition represents, e.g. an order set, protocol, or event-condition-action rule.

Control1..1
BindingThe type of PlanDefinition
The codes SHALL be taken from PlanDefinitionType; other codes may be used where these codes are not suitable
TypeCodeableConcept
PlanDefinition.type.id
Definition

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

Control0..0
Typestring
PlanDefinition.type.extension
Definition

An Extension

Control0..0
TypeExtension
PlanDefinition.type.coding
Definition

A reference to a code defined by a terminology system.

Control1..1
TypeCoding
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 labelled as UserSelected = true.

PlanDefinition.type.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.

Control0..0
Typestring
PlanDefinition.type.coding.extension
Definition

An Extension

Control0..0
TypeExtension
PlanDefinition.type.coding.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control1..1
Typeuri
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 Valuehttp://hl7.org/fhir/plan-definition-type
PlanDefinition.type.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.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..0
Typestring
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.type.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).

Control1..1
Typecode
Requirements

Need to refer to a particular code in the system.

Fixed Valueprotocol
PlanDefinition.type.coding.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control0..0
Typestring
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

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

Control0..0
Typeboolean
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.type.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.

Control1..1
Typestring
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.

Fixed ValueChemotherapy Order Template
PlanDefinition.status
Definition

The status of this plan definition. Enables tracking the life-cycle of the content.

Control1..1
BindingThe lifecycle status of a Value Set or Concept Map.
The codes SHALL be taken from PublicationStatus
Typecode
Is Modifiertrue
Comments

Allows filtering of plan definition that are appropriate for use vs. not.

PlanDefinition.experimental
Definition

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

Control0..0
Typeboolean
Is Modifiertrue
Requirements

Enables experimental content to be developed following the same life-cycle as a production-level plan definition would.

Comments

Allows filtering of plan definition that are appropriate for use vs. not.

PlanDefinition.date
Definition

The publication date for this version of the order template.

Control1..1
TypedateTime
Comments

On the NCCN FHIR server, this should match the date portion of meta.lastUpdated.

PlanDefinition.publisher
Definition

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

Control1..1
Typestring
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.

Fixed ValueNational Comprehensive Cancer Network, Inc.
PlanDefinition.description
Definition

A free text natural language description of the plan definition from the consumer's perspective.

Control0..0
Typemarkdown
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

Explains why this plan definition is needed and why it has been designed as it has.

Control0..0
Typemarkdown
Comments

This element does not describe the usage of the plan definition (See, e.g, the comments element, or relatedArtifacts), rather it's for 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.

Control0..0
Typestring
PlanDefinition.approvalDate
Definition

The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.

Control0..0
Typedate
Comments

The date may be more recent than the approval date because of minor changes / editorial corrections.

PlanDefinition.lastReviewDate
Definition

The date on which the asset content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date.

Control0..0
Typedate
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 effective.

Control0..0
TypePeriod
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 would be published in 2015.

PlanDefinition.useContext
Definition

A component of the clinical indication for the regimen.

Control1..*
TypeUsageContext
Requirements

Assist in searching for appropriate content.

Comments

When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply.

PlanDefinition.useContext(disease)
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 of code system definitions.

Control1..1
TypeUsageContext
Requirements

Assist in searching for appropriate content.

Comments

NCCN does not have a ValueSet for their disease list at this time, but the allowed set of values can be observed from the template listing api: https://cott.ibmjstart.net/api/public/guidelines.

PlanDefinition.useContext.id
Definition

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

Control0..0
Typestring
PlanDefinition.useContext.extension (http://hl7.org/fhir/StructureDefinition/usagecontext-group)
Definition

Defines the group in which this usage context is a member. Multiple groups are "OR'ed", contexts within a group are "AND'ed".

Control0..1 This element is affected by the following invariants: ele-1
Type (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: children().count() > id.count())
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
PlanDefinition.useContext.code
Definition

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

Control1..1
BindingA code the specifies a type of context being specified by a usage context
The codes SHALL be taken from UsageContextType; other codes may be used where these codes are not suitable
TypeCoding
PlanDefinition.useContext.code.id
Definition

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

Control0..0
Typestring
PlanDefinition.useContext.code.extension
Definition

An Extension

Control0..0
TypeExtension
PlanDefinition.useContext.code.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control1..1
Typeuri
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 Valuehttp://hl7.org/fhir/usage-context-type
PlanDefinition.useContext.code.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.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..0
Typestring
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.useContext.code.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).

Control1..1
Typecode
Requirements

Need to refer to a particular code in the system.

Fixed Valuefocus
PlanDefinition.useContext.code.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control0..0
Typestring
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

PlanDefinition.useContext.code.userSelected
Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Control0..0
Typeboolean
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.useContext.valueCodeableConcept
Definition

The disease the regimen on this template is intended to treat / manage.

Control1..1
TypeCodeableConcept
PlanDefinition.useContext.valueCodeableConcept.id
Definition

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

Control0..0
Typestring
PlanDefinition.useContext.valueCodeableConcept.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.

Control0..*
TypeExtension
Alternate Namesextensions, 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.useContext.valueCodeableConcept.coding
Definition

A reference to a code defined by a terminology system.

Control0..0
TypeCoding
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

NCCN Templates do not include coded diseases at this time.

PlanDefinition.useContext.valueCodeableConcept.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.

Control1..1
Typestring
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.

Max Length256
PlanDefinition.useContext(indicationComponent)
Definition

A component of the clinical indication for the regimen.

Control1..*
TypeUsageContext
Requirements

Assist in searching for appropriate content.

Comments

When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply.

PlanDefinition.useContext.id
Definition

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

Control0..0
Typestring
PlanDefinition.useContext.extension (http://hl7.org/fhir/StructureDefinition/usagecontext-group)
Definition

Defines the group in which this usage context is a member. Multiple groups are "OR'ed", contexts within a group are "AND'ed".

Control0..1 This element is affected by the following invariants: ele-1
Type (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: children().count() > id.count())
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
PlanDefinition.useContext.code
Definition

The class of the indication code according to a simple classification system managed by NCCN.

Control1..1
BindingThe category under which a given indication component is classified
The codes SHALL be taken from Indication Classes
TypeCoding
Comments

This classification system is likely to evolve for future versions of the NCCN Order Templates.

PlanDefinition.useContext.valueCodeableConcept
Definition

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

Control1..1
TypeCodeableConcept
PlanDefinition.useContext.valueCodeableConcept.id
Definition

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

Control0..0
Typestring
PlanDefinition.useContext.valueCodeableConcept.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.

Control0..*
TypeExtension
Alternate Namesextensions, 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.useContext.valueCodeableConcept.coding
Definition

A reference to a code defined by a terminology system.

Control0..0
TypeCoding
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

NCCN Templates do not include coded indications at this time.

PlanDefinition.useContext.valueCodeableConcept.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.

Control1..1
Typestring
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.

Max Length256
PlanDefinition.jurisdiction
Definition

A jurisdiction in which the plan definition is intended to be used.

Control0..0
BindingCountries 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
TypeCodeableConcept
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.

Control0..0
BindingHigh-level categorization of the definition, used for searching, sorting, and filtering
For example codes, see DefinitionTopic
TypeCodeableConcept
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 list of NCCN staff members that have contributed to this Order Template.

Control1..*
TypeContributor
Requirements

Consumers of the content must be able to quickly determine who contributed to the content of the asset.

Comments

The list will include all users of the authoring system that have pressed 'Save' on any version of this template.

PlanDefinition.contributor.id
Definition

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

Control0..0
Typestring
PlanDefinition.contributor.extension
Definition

An Extension

Control0..0
TypeExtension
PlanDefinition.contributor.type
Definition

The type of contributor.

Control1..1
BindingThe type of contributor
The codes SHALL be taken from ContributorType
Typecode
Fixed Valueauthor
PlanDefinition.contributor.name
Definition

The name of the individual or organization responsible for the contribution.

Control1..1
Typestring
PlanDefinition.contributor.contact
Definition

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

Control0..0
TypeContactDetail
PlanDefinition.contact
Definition

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

Control0..0
TypeContactDetail
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.

Control1..1
Typemarkdown
Requirements

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

Alternate NamesLicense, Restrictions
Comments

This value is fixed but the IG tooling doesn't yet support the markdown type.

PlanDefinition.relatedArtifact
Definition

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

Control0..*
TypeRelatedArtifact
Requirements

Assets must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.

Comments

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

PlanDefinition.relatedArtifact(guidelineReference)
Definition

A link to the NCCN Clinical Practice Guideline which recommends this regimen.

Control1..1
TypeRelatedArtifact
Requirements

Assets must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.

Comments

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

PlanDefinition.relatedArtifact.id
Definition

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

Control0..0
Typestring
PlanDefinition.relatedArtifact.extension
Definition

An Extension

Control0..0
TypeExtension
PlanDefinition.relatedArtifact.type
Definition

The type of relationship to the related artifact.

Control1..1
BindingThe type of relationship to the related artifact
The codes SHALL be taken from RelatedArtifactType
Typecode
Comments

NCCN templates are derived from the NCCN Guidelines.

Fixed Valuederived-from
PlanDefinition.relatedArtifact.display
Definition

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

Control1..1
Typestring
PlanDefinition.relatedArtifact.citation
Definition

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

Control0..0
Typestring
Comments

Additional structured information about citations should be captured as extensions.

PlanDefinition.relatedArtifact.url
Definition

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

Control1..1
Typeuri
Comments

If a document or resource element is present, this element SHALL NOT be provided (use the url or reference in the Attachment or resource reference).

PlanDefinition.relatedArtifact.document
Definition

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

Control0..0
TypeAttachment
PlanDefinition.relatedArtifact.resource
Definition

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

Control0..0
TypeReference(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.relatedArtifact(citation)
Definition

A reference to literature with evidence informing the regimen.

Control1..*
TypeRelatedArtifact
Requirements

Assets must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.

Comments

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

PlanDefinition.relatedArtifact.id
Definition

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

Control0..0
Typestring
PlanDefinition.relatedArtifact.extension (http://nccn.org/fhir/StructureDefinition/regimenReferenceType)
Definition

How the citation relates to the regimen referenced from the corresponding guideline, as defined at https://www.nccn.org/OrderTemplates/PDF/appendix_E.pdf.

Control1..1 This element is affected by the following invariants: ele-1
Type (Extension Type: code)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: children().count() > id.count())
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
PlanDefinition.relatedArtifact.type
Definition

The type of relationship to the related artifact.

Control1..1
BindingThe type of relationship to the related artifact
The codes SHALL be taken from RelatedArtifactType
Typecode
Fixed Valuecitation
PlanDefinition.relatedArtifact.display
Definition

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

Control1..1
Typestring
Comments

A formatted version of this display text can be found in the narrative text of the order template.

PlanDefinition.relatedArtifact.citation
Definition

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

Control0..0
Typestring
Comments

Additional structured information about citations should be captured as extensions.

PlanDefinition.relatedArtifact.url
Definition

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

Control1..1
Typeuri
Comments

If a document or resource element is present, this element SHALL NOT be provided (use the url or reference in the Attachment or resource reference).

PlanDefinition.relatedArtifact.document
Definition

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

Control0..0
TypeAttachment
PlanDefinition.relatedArtifact.resource
Definition

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

Control0..0
TypeReference(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.relatedArtifact(relatedTemplate)
Definition

Some regimen are split across multiple courses and each course may have its own template.

Control0..*
TypeRelatedArtifact
Requirements

Assets must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.

Comments

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

PlanDefinition.relatedArtifact.id
Definition

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

Control0..0
Typestring
PlanDefinition.relatedArtifact.extension
Definition

An Extension

Control0..0
TypeExtension
PlanDefinition.relatedArtifact.type
Definition

The type of relationship to the related artifact.

Control1..1
BindingThe type of relationship to the related artifact
The codes SHALL be taken from RelatedArtifactType
Typecode
Comments

For related templates, the value of the type element is purposefully left blank because none of the codes from the required codesystem seem to fit.

PlanDefinition.relatedArtifact.type.id
Definition

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

Control0..0
Typeid
PlanDefinition.relatedArtifact.type.extension (http://nccn.org/fhir/StructureDefinition/templateRelationship)
Definition

The relationship from the current template to the target one.

Control0..1 This element is affected by the following invariants: ele-1
Type (Extension Type: code)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: children().count() > id.count())
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
PlanDefinition.relatedArtifact.type.value
Definition

Primitive value for code

Control0..0
PlanDefinition.relatedArtifact.display
Definition

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

Control1..1
Typestring
PlanDefinition.relatedArtifact.citation
Definition

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

Control0..0
Typestring
Comments

Additional structured information about citations should be captured as extensions.

PlanDefinition.relatedArtifact.url
Definition

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

Control1..1
Typeuri
Comments

If a document or resource element is present, this element SHALL NOT be provided (use the url or reference in the Attachment or resource reference).

PlanDefinition.relatedArtifact.document
Definition

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

Control0..0
TypeAttachment
PlanDefinition.relatedArtifact.resource
Definition

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

Control0..0
TypeReference(Resource)
Comments

If the type is predecessor, this is a reference to the succeeding knowledge resource. If the type is successor, this is a reference to the prior knowledge resource.

PlanDefinition.library
Definition

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

Control0..0
TypeReference(Library)
PlanDefinition.goal
Definition

Goals that describe what the activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.

Control0..0
TypeBackboneElement
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: 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.

Control0..1
Typestring
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.

Control0..*
TypeExtension
Alternate Namesextensions, 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, 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.

Control0..1
BindingExample codes for grouping goals for filtering or presentation
For example codes, see GoalCategory
TypeCodeableConcept
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".

Control1..1
BindingDescribes goals that can be achieved
For example codes, see SNOMED CT Clinical Findings
TypeCodeableConcept
Comments

If no code is available, use CodeableConcept.text.

PlanDefinition.goal.priority
Definition

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

Control0..1
BindingIndicates the level of importance associated with reaching or sustaining a goal
The codes SHOULD be taken from GoalPriority
TypeCodeableConcept
PlanDefinition.goal.start
Definition

The event after which the goal should begin being pursued.

Control0..1
BindingIdentifies the types of events that might trigger the start of a goal
For example codes, see GoalStartEvent
TypeCodeableConcept
PlanDefinition.goal.addresses
Definition

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

Control0..*
BindingIdentifies problems, conditions, issues, or concerns that goals may address
For example codes, see Condition/Problem/Diagnosis Codes
TypeCodeableConcept
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.

Control0..*
TypeRelatedArtifact
PlanDefinition.goal.target
Definition

Indicates what should be done and within what timeframe.

Control0..*
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: 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.

Control0..1
Typestring
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.

Control0..*
TypeExtension
Alternate Namesextensions, 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, 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.

Control0..1
BindingIdentifies types of parameters that can be tracked to determine goal achievement
For example codes, see LOINC Codes
TypeCodeableConcept
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.

Control0..1
TypeChoice of: Quantity, Range, CodeableConcept
[x] NoteSee 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.

Control0..1
TypeDuration
PlanDefinition.action
Definition

An action to be taken as part of the plan.

Control1..1
TypeBackboneElement
Comments

The top-level action is a container for the regimen options within the order template.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: 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.

Control0..0
Typestring
PlanDefinition.action.extension (http://nccn.org/fhir/StructureDefinition/febrileNeutropeniaRisk)
Definition

An Extension

Control1..* This element is affected by the following invariants: ele-1
Type (Extension Type: code)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: children().count() > id.count())
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
PlanDefinition.action.modifierExtension
Definition

An Extension

Control0..0
TypeExtension
Is Modifiertrue
PlanDefinition.action.label
Definition

A user-visible label for the action.

Control0..0
Typestring
PlanDefinition.action.title
Definition

The title of the action displayed to a user.

Control0..0
Typestring
PlanDefinition.action.description
Definition

A short description of the action used to provide a summary to display to the user.

Control0..0
Typestring
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.

Control0..0
Typestring
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.

Control0..0
TypeCodeableConcept
PlanDefinition.action.reason
Definition

A description of why this action is necessary or appropriate.

Control0..0
TypeCodeableConcept
Comments

This is different than the clinical evidence documentation, it's an actual business description of the reason for performing the action.

PlanDefinition.action.documentation
Definition

Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.

Control0..0
TypeRelatedArtifact
PlanDefinition.action.goalId
Definition

Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition.

Control0..0
Typeid
PlanDefinition.action.triggerDefinition
Definition

A description of when the action should be triggered.

Control0..0
TypeTriggerDefinition
PlanDefinition.action.condition
Definition

An expression that describes applicability criteria, or start/stop conditions for the action.

Control0..0
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: 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.

Control0..1
Typestring
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.

Control0..*
TypeExtension
Alternate Namesextensions, 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, 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.

Control1..1
BindingDefines the kinds of conditions that can appear on actions
The codes SHALL be taken from ActionConditionKind
Typecode
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.

Control0..1
Typestring
PlanDefinition.action.condition.language
Definition

The media type of the language for the expression.

Control0..1
Typestring
PlanDefinition.action.condition.expression
Definition

An expression that returns true or false, indicating whether or not the condition is satisfied.

Control0..1
Typestring
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.

Control0..0
TypeDataRequirement
PlanDefinition.action.output
Definition

Defines the outputs of the action, if any.

Control0..0
TypeDataRequirement
PlanDefinition.action.relatedAction
Definition

A relationship to another action such as "before" or "30-60 minutes after start of".

Control0..0
TypeBackboneElement
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: 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.

Control0..1
Typestring
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.

Control0..*
TypeExtension
Alternate Namesextensions, 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, 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.

Control1..1
Typeid
PlanDefinition.action.relatedAction.relationship
Definition

The relationship of this action to the related action.

Control1..1
BindingDefines the types of relationships between actions
The codes SHALL be taken from ActionRelationshipType
Typecode
PlanDefinition.action.relatedAction.offset[x]
Definition

A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

Control0..1
TypeChoice of: Duration, Range
[x] NoteSee Choice of Data Types for further information about how to use [x]
PlanDefinition.action.timing[x]
Definition

An optional value describing when the action should be performed.

Control0..0
TypeChoice of: dateTime, Period, Duration, Range, Timing
[x] NoteSee Choice of Data Types for further information about how to use [x]
PlanDefinition.action.participant
Definition

Indicates who should participate in performing the action described.

Control0..0
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: 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.

Control0..1
Typestring
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.

Control0..*
TypeExtension
Alternate Namesextensions, 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, 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.

Control1..1
BindingThe type of participant for the action
The codes SHALL be taken from ActionParticipantType
Typecode
PlanDefinition.action.participant.role
Definition

The role the participant should play in performing the described action.

Control0..1
BindingDefines roles played by participants for the action
For example codes, see ActionParticipantRole
TypeCodeableConcept
PlanDefinition.action.type
Definition

The type of action to perform (create, update, remove).

Control0..0
BindingThe type of action to be performed
The codes SHALL be taken from ActionType
TypeCoding
PlanDefinition.action.groupingBehavior
Definition

Defines the grouping behavior for the action and its children.

Control0..0
BindingDefines organization behavior of a group
The codes SHALL be taken from ActionGroupingBehavior
Typecode
PlanDefinition.action.selectionBehavior
Definition

Defines the selection behavior for the action and its children.

Control0..0
BindingDefines selection behavior of a group
The codes SHALL be taken from ActionSelectionBehavior
Typecode
PlanDefinition.action.requiredBehavior
Definition

Defines the requiredness behavior for the action.

Control0..0
BindingDefines requiredness behavior for selecting an action or an action group
The codes SHALL be taken from ActionRequiredBehavior
Typecode
PlanDefinition.action.precheckBehavior
Definition

Defines whether the action should usually be preselected.

Control0..0
BindingDefines selection frequency behavior for an action or group
The codes SHALL be taken from ActionPrecheckBehavior
Typecode
PlanDefinition.action.cardinalityBehavior
Definition

Defines whether the action can be selected multiple times.

Control0..0
BindingDefines behavior for an action or a group for how many times that item may be repeated
The codes SHALL be taken from ActionCardinalityBehavior
Typecode
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.

Control0..0
TypeChoice of: Reference(ActivityDefinition), Reference(PlanDefinition)
Comments

Note that the definition is optional, and if no definition is specified, a dynamicValue with a root (~) path can be used to define the entire resource dynamically.

PlanDefinition.action.transform
Definition

A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.

Control0..0
TypeReference(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.

Control0..0
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: 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.

Control0..1
Typestring
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.

Control0..*
TypeExtension
Alternate Namesextensions, 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, 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.

Control0..1
Typestring
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.

Control0..1
Typestring
PlanDefinition.action.dynamicValue.language
Definition

The media type of the language for the expression.

Control0..1
Typestring
PlanDefinition.action.dynamicValue.expression
Definition

An expression specifying the value of the customized element.

Control0..1
Typestring
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(regimenOption)
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.

Control1..*
TypeSee PlanDefinition:ordertemplate.action