Electronic Case Reporting (eCR)
3.0.0-ballot - STU 3 Ballot United States of America flag

Electronic Case Reporting (eCR), published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/case-reporting/ and changes regularly. See the Directory of published versions

Resource Profile: eRSD PlanDefinition - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 3

Definitions for the ersd-plandefinition resource profile

See the documentation on how to interpret the contents of this table

0. PlanDefinition
Definition

Defines the logic and rules around determining: whether or not a condition is reportable to public health, which jurisdiction(s) is/are responsible, which jurisdiction(s) need to be notified, and if the condition is reportable, gives timing information, next steps and condition information to the clinician.


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 artifacts such as clinical decision support rules, order sets and protocols.

ShorteRSD - electronic Reporting and Surveillance DistributionThe definition of a plan for a series of actions, independent of any specific patient or context
Control10..1*
Is Modifierfalse
Summaryfalse
Invariantsdom-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 or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
pdf-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.matches('[A-Z]([A-Za-z0-9_]){0,254}'))
pdf-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.matches('[A-Z]([A-Za-z0-9_]){0,254}'))
2. 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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
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. 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.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. PlanDefinition.extension
Definition

Defines variables for the PlanDefinition.


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

ShortExtensionAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Must Supporttrue
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

6. PlanDefinition.extension:knowledgeCapability
Slice NameknowledgeCapability
Definition

Defines a knowledge capability afforded by this knowledge artifact.

Shortshareable | computable | publishable | executable
Control0..*
TypeExtension(CQF Knowledge capability) (Extension Type: code)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
8. PlanDefinition.extension:artifactComment
Slice NameartifactComment
Definition

A comment containing additional documentation, a review comment, usage guidance, or other relevant information from a particular user.

ShortAdditional documentation, review, or usage guidance
Control0..*
TypeExtension(Artifact Comment) (Complex Extension)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
10. PlanDefinition.extension:versionAlgorithm
Slice NameversionAlgorithm
Definition

Indicates the mechanism used to compare versions to determine which is more current.

ShortHow to compare versions
Comments

If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.

Control0..1
TypeExtension(Artifact Version Algorithm) (Extension Type: Choice of: string, Coding)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
12. PlanDefinition.extension:versionPolicy
Slice NameversionPolicy
Definition

Defines the versioning policy of the artifact.

Shortmetadata | strict
Control0..1
TypeExtension(Artifact Version Policy) (Extension Type: CodeableConcept)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
14. PlanDefinition.extension:receiverAddress
Slice NamereceiverAddress
Definition

Indicates the address where the report has to be sent.

ShortIndicates the address where the report has to be sent.
Control0..1
TypeExtension(US Public Health Receiver Address Extension) (Extension Type: Reference(Endpoint))
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
16. PlanDefinition.extension:asyncIndicator
Slice NameasyncIndicator
Definition

This Extension profile represents the expectation of whether messages resulting from the PlanDefinition are expected to be processed asynchronously.

ShortUS Public Health Async Indicator Extension
Control0..1
TypeExtension(US Public Health Async Indicator Extension) (Extension Type: boolean)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
18. PlanDefinition.extension:contentEncrypted
Slice NamecontentEncrypted
Definition

Indicates whether the data in the content bundle is encrypted or not.

ShortUS Public Health Data Encrypted Extension
Control0..1
TypeExtension(US Public Health Data Encrypted Extension) (Extension Type: boolean)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
20. PlanDefinition.extension:jwksForContentEncryption
Slice NamejwksForContentEncryption
Definition

This Extension profile indicates the location of the public key that needs to be used for encryption when sending data to the receiver.

ShortUS Public Health Receiver Jwks Url
Control0..1
TypeExtension(US Public Health Receiver JWKS Url Extension) (Extension Type: url)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
22. PlanDefinition.extension:contentEncryptionAlgorithm
Slice NamecontentEncryptionAlgorithm
Definition

This Extension profile represents algorithms that would be acceptable for encryption of the data prior to submitting to the data receiver.

ShortUS Public Health Data Encryption Algorithm
Control0..1
TypeExtension(US Public Health Data Encryption Algorithm Extension) (Extension Type: code)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
24. PlanDefinition.extension:expectedResponseDuration
Slice NameexpectedResponseDuration
Definition

This Extension profile represents the maximum time the sender has to wait to get a response, beyond which the message is assumed to have failed to reach the destination.

ShortUS Public Health Expected Response Time Extension
Control0..1
TypeExtension(US Public Health Expected Response Time Extension) (Extension Type: Duration)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
26. PlanDefinition.extension:variable
Slice Namevariable
Definition

Variable specifying a logic to generate a variable for use in subsequent logic. The name of the variable will be added to FHIRPath's context when processing descendants of the element that contains this extension as well as extensions within the same element.

ShortDefines variables for the PlanDefinition.
Comments

Ordering of variable extension declarations is significant as variables declared in one repetition of this extension might be used in subsequent extension repetitions

​For questionnaires, see additional guidance and examples in the SDC implementation guide.

Control0..*
TypeExtension(Variable) (Extension Type: Expression)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
28. PlanDefinition.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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).

ShortExtensions that cannot be ignored
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summaryfalse
Requirements

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.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
30. PlanDefinition.url
Definition

An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance; 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.

ShortCanonical identifier for this plan definition, represented as a URI (globally unique)
Comments

Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

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.

Control10..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. PlanDefinition.version
Definition

The identifier that is used to identify this version of the plan definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the plan definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.

ShortBusiness version of the plan definition
Comments

There may be different plan definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the plan definition with the format [url]|[version].

NoteThis is a business version Id, not a resource version Id (see discussion)
Control10..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. 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.

ShortName for this plan definition (computer friendly)
Comments

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.

Control10..1
This element is affected by the following invariants: inv-0
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Support human navigation and code generation.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. PlanDefinition.title
Definition

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

ShortName for this plan definition (human friendly)
Comments

This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

Control10..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. PlanDefinition.type
Definition

Type of this PlanDefinition


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

ShortType of this PlanDefinitionorder-set | clinical-protocol | eca-rule | workflow-definition
Control10..1
BindingUnless not suitable, these codes SHALL be taken from PlanDefinitionTypehttp://hl7.org/fhir/ValueSet/plan-definition-type|4.0.1
(extensible to http://hl7.org/fhir/ValueSet/plan-definition-type)

The type of PlanDefinition.

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/plan-definition-type",
      "code" : "workflow-definition",
      "display" : "Workflow Definition"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/plan-definition-type"/>
    <code value="workflow-definition"/>
    <display value="Workflow Definition"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. PlanDefinition.status
Definition

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

Shortdraft | active | retired | unknown
Comments

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

Control1..1
BindingThe codes SHALL be taken from PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1
(required to http://hl7.org/fhir/ValueSet/publication-status|4.0.1)

The lifecycle status of an artifact.

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. PlanDefinition.experimental
Definition

A Boolean value to indicate that this plan definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

ShortFor testing purposes, not real usage
Comments

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

Control0..1
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. PlanDefinition.subject[x]
Definition

A code or group definition that describes the intended subject of the plan definition.

ShortType of individual the plan definition is focused on
Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectTypehttp://hl7.org/fhir/ValueSet/subject-type|4.0.1
(extensible to http://hl7.org/fhir/ValueSet/subject-type)

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

TypeChoice of: CodeableConcept, Reference(Group, Group)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
Summaryfalse
Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. PlanDefinition.date
Definition

Date the PlanDefinition was last changed


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.

ShortDate the PlanDefinition was last changedDate last changed
Comments

Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the plan definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

Control10..1
TypedateTime
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Alternate NamesRevision Date
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. PlanDefinition.publisher
Definition

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

ShortName of the publisher (organization or individual)
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.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. PlanDefinition.description
Definition

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

ShortNatural language description of the plan definition
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 plan definition is presumed to be the predominant language in the place the plan definition was created).

Control10..1
Typemarkdown
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. PlanDefinition.effectivePeriod
Definition

The period during which this specification is expected to be in use. The start date indicates when the specification takes effect.


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

ShortWhen the eRSD specification is expected to be in use.When the plan definition is expected to be used
Comments

The effective period for a plan definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.

Control0..1
TypePeriod
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

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.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. PlanDefinition.effectivePeriod.start
Definition

The start of the time period when this PlanDefinition goes into effect


The start of the period. The boundary is inclusive.

ShortThe start of the time period when this PlanDefinition goes into effectStarting time with inclusive boundary
Comments

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

Control10..1
This element is affected by the following invariants: per-1
TypedateTime
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
56. PlanDefinition.relatedArtifact
Definition

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

ShortAdditional documentation, citations
Comments

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

Control10..*
TypeRelatedArtifact
Is Modifierfalse
Must Supporttrue
Summaryfalse
Requirements

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.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.relatedArtifact. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

58. PlanDefinition.relatedArtifact:triggeringValueSetLibrary
Slice NametriggeringValueSetLibrary
Definition

A dependency on the Reportable Conditions Trigger Codes (RCTC) value set library. The reference SHOULD be version-pinned, so that it is unambiguous which trigger code content this specification was authored against.


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

ShortThe RCTC value set library this specification was authored against.Additional documentation, citations
Comments

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

Control10..1*
TypeRelatedArtifact
Is Modifierfalse
Must Supporttrue
Summaryfalse
Requirements

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.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
60. PlanDefinition.relatedArtifact:triggeringValueSetLibrary.type
Definition

The type of relationship to the related artifact.

Shortdocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Control1..1
BindingThe codes SHALL be taken from RelatedArtifactTypehttp://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1
(required to http://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1)

The type of relationship to the related artifact.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Fixed Value
{
  "type" : "depends-on"
}
<type value="depends-on"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
62. PlanDefinition.relatedArtifact:triggeringValueSetLibrary.resource
Definition

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

ShortWhat resource is being referenced
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.

Control10..1
Typecanonical(Resource)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
64. PlanDefinition.library
Definition

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

ShortLogic used by the plan definition
Control0..*
Typecanonical(Library, Library)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
66. PlanDefinition.action
Definition

An action or group of actions to be taken as part of the plan.

ShortAll constraints on action are intended to apply to any nested constraints.Action defined by the plan
Comments

Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.

Control80..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action. The slices are Ordered and Open, and can be differentiated using the following discriminators:
  • value @ id

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

68. PlanDefinition.action.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
70. PlanDefinition.action.description
Definition

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

ShortBrief description of the action
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
72. 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 the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control0..1*
BindingUnless not suitable, these codes SHALL be taken from For codes, see US Public Health ValueSet - PlanDefinition Action
(extensible to http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-plandefinition-action)

The set of actions that can be used to create plan definition

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
74. PlanDefinition.action.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
76. PlanDefinition.action.trigger.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control10..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.trigger.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
78. PlanDefinition.action.trigger.extension:namedEventType
Slice NamenamedEventType
Definition

Indicates the types of named events to subscribe to from the EHR.

ShortUS Public Health Named Event Type Extension
Control1..1
TypeExtension(US Public Health Named Event Type Extension) (Extension Type: CodeableConcept)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
80. PlanDefinition.action.trigger.type
Definition

The type of triggering event.

Shortnamed-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Control1..1
BindingThe codes SHALL be taken from TriggerTypehttp://hl7.org/fhir/ValueSet/trigger-type|4.0.1
(required to http://hl7.org/fhir/ValueSet/trigger-type|4.0.1)

The type of trigger.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Value
{
  "type" : "named-event"
}
<type value="named-event"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
82. PlanDefinition.action.condition
Definition

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

ShortWhether or not the action is applicable
Comments

When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
84. 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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
86. PlanDefinition.action.condition.kind
Definition

The kind of condition.

Shortapplicability | start | stop
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 enter/exit criteria for an action.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1
(required to http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1)

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
88. PlanDefinition.action.condition.expression
Definition

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

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
90. PlanDefinition.action.input
Definition

Defines input data requirements for the action.

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
92. PlanDefinition.action.input.extension
Definition

Defines extensions for the action.


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.

ShortExtensionAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Must Supporttrue
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

94. PlanDefinition.action.input.extension:fhirquerypattern
Slice Namefhirquerypattern
Definition

A FHIR Query URL pattern that corresponds to the data specified by the data requirement. If multiple FHIR Query URLs are present, they each contribute to the data specified by the data requirement (i.e. the union of the results of the FHIR Queries represents the complete data for the data requirement). This is not a resolveable URL, in that it will contain 1) No base canonical (i.e. it's a relative query), and 2) Parameters using tokens that are delimited using double-braces and the context parameters are dependent solely on the subjectType, according to the following: Patient: context.patientId, Practitioner: context.practitionerId, Organization: context.organizationId, Location: context.locationId, Device: context.deviceId. For example, for a Library with a subjectType of Patient, the context parameter {{context.patientId}} will be used as a token to be replaced with the id of the Patient in context. This extension is used primarily to address the use case for satisfying a data requirement for a single subject. However, the query pattern could also be used to satisfy population level requests by removing the subject-level filter from the query.

ShortWhat FHIR query?
Comments

Supports communicating a FHIR query (or set of queries) for the given data requirement. The query is server-specific, and will need to be created as informed by a CapabilityStatement. The $data-requirements operation should be expected to be able to provide an Endpoint or CapabilityStatement to provide this information.; If no endpoint or capability statement is provided, the capability statement of the server performing the operation is used.

Control0..1
TypeExtension(FHIR Query Pattern) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
96. PlanDefinition.action.input.extension:fhirquerypattern.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "http://hl7.org/fhir/StructureDefinition/cqf-fhirQueryPattern"
}
<url value="http://hl7.org/fhir/StructureDefinition/cqf-fhirQueryPattern"/>
98. PlanDefinition.action.input.extension:fhirquerypattern.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortValue of extension
Control10..1
Typestring, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
100. PlanDefinition.action.input.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1
(required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
102. PlanDefinition.action.output
Definition

Defines the outputs of the action, if any.

ShortOutput data definition
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
104. PlanDefinition.action.output.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1
(required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
106. PlanDefinition.action.relatedAction
Definition

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

ShortRelationship to another action
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.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
108. 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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
110. PlanDefinition.action.relatedAction.actionId
Definition

The element id of the related action.

ShortWhat action is this related to
Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
112. PlanDefinition.action.relatedAction.relationship
Definition

The relationship of this action to the related action.

Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control1..1
BindingThe codes SHALL be taken from ActionRelationshipTypehttp://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1
(required to http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1)

Defines the types of relationships between actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
114. PlanDefinition.action.relatedAction.offset[x]
Definition

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

ShortTime offset for the relationship
Control0..1
TypeChoice of: Duration, Range
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action.relatedAction.offset[x]. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this

Slicing Note: Other type slices that contain no new information are not shown in this view

116. PlanDefinition.action.relatedAction.offset[x]:offsetDuration
Slice NameoffsetDuration
Definition

The duration quantity may include a comparator, indicating how the offset should be applied. For example, <= 1 hour, meaning that the offset should be no more than 1 hour. This allows systems flexibility in scheduling the actions to isolate reporting activities to off hours.


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

ShortTime offset for the relationship
Control0..1
TypeDuration, Range
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
119. PlanDefinition.action.timing[x]
Definition

An optional value describing when the action should be performed.

ShortWhen the action should take place
Control0..1
TypeDuration, dateTime, Period, Timing, Range, Age
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
121. PlanDefinition.action:encounterStart
Slice NameencounterStart
Definition

Defines the "start" action


An action or group of actions to be taken as part of the plan.

ShortEncounter start codeAction defined by the plan
Comments

Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.

Control10..1*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
123. PlanDefinition.action:encounterStart.id
Definition

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

ShortUnique id for inter-element referencing
Control10..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "id" : "start-workflow"
}
<id value="start-workflow"/>
125. PlanDefinition.action:encounterStart.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
127. PlanDefinition.action:encounterStart.description
Definition

Description of the "start" action.


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

ShortDescription of the "start" action.Brief description of the action
Control10..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Value
{
  "description" : "This action represents the start of the reporting workflow in response to the encounter-start event."
}
<description value="This action represents the start of the reporting workflow in response to the encounter-start event."/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
129. PlanDefinition.action:encounterStart.textEquivalent
Definition

Text equivalent of the "start" action.


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 might not be capable of interpreting it dynamically.

ShortText equivalent of the "start" action.Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
Control10..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Value
{
  "textEquivalent" : "Start the reporting workflow in response to an encounter-start event"
}
<textEquivalent value="Start the reporting workflow in response to an encounter-start event"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
131. PlanDefinition.action:encounterStart.code
Definition

The US-PH-PlanDefinition-Action code for the "start" action.


A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode for the "start" action.Code representing the meaning of the action or sub-actions
Control10..1*
BindingUnless not suitable, these codes SHALL be taken from For codes, see US Public Health ValueSet - PlanDefinition Action
(extensible to http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-plandefinition-action)

The set of actions that can be used to create plan definition

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "initiate-reporting-workflow"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="initiate-reporting-workflow"/>
  </coding>
</code>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
133. PlanDefinition.action:encounterStart.trigger
Definition

When the "start" action should be triggered.


A description of when the action should be triggered.

ShortWhen the "start" action should be triggered.When the action should be triggered
Control10..*
TypeTriggerDefinition
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
epd-1: The code value of the namedEventType SHALL be the same as the name element (name.supersetOf(extension('http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-named-eventtype-extension').value.coding.code))
135. PlanDefinition.action:encounterStart.trigger.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control10..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.trigger.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
137. PlanDefinition.action:encounterStart.trigger.extension:namedEventType
Slice NamenamedEventType
Definition

Indicates the types of named events to subscribe to from the EHR.

ShortIndicates the types of named events to subscribe to from the EHR.
Control1..1
TypeExtension(US Public Health Named Event Type Extension) (Extension Type: CodeableConcept)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
139. PlanDefinition.action:encounterStart.trigger.type
Definition

The type of triggering event.

Shortnamed-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Control1..1
BindingThe codes SHALL be taken from TriggerTypehttp://hl7.org/fhir/ValueSet/trigger-type|4.0.1
(required to http://hl7.org/fhir/ValueSet/trigger-type|4.0.1)

The type of trigger.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Value
{
  "type" : "named-event"
}
<type value="named-event"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
141. PlanDefinition.action:encounterStart.trigger.name
Definition

The name of the event, encounter-start in this case. For any action invoked as a result of this trigger, the triggering encounter is accessible via the context variable %encounter


A formal name for the event. This may be an absolute URI that identifies the event formally (e.g. from a trigger registry), or a simple relative URI that identifies the event in a local context.

ShortName or URI that identifies the event
Comments

An event name can be provided for all event types, but is required for named events. If a name is provided for a type other than named events, it is considered to be a shorthand for the semantics described by the formal description of the event.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Fixed Value
{
  "name" : "encounter-start"
}
<name value="encounter-start"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
143. PlanDefinition.action:encounterStart.condition
Definition

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

ShortWhether or not the action is applicable
Comments

When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
145. PlanDefinition.action:encounterStart.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
147. PlanDefinition.action:encounterStart.condition.kind
Definition

The kind of condition.

Shortapplicability | start | stop
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 enter/exit criteria for an action.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1
(required to http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1)

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
149. PlanDefinition.action:encounterStart.condition.expression
Definition

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

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
151. PlanDefinition.action:encounterStart.input
Definition

Defines input data requirements for the action.

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
153. PlanDefinition.action:encounterStart.input.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
155. PlanDefinition.action:encounterStart.input.extension:fhirquerypattern
Slice Namefhirquerypattern
Definition

A FHIR Query URL pattern that corresponds to the data specified by the data requirement. If multiple FHIR Query URLs are present, they each contribute to the data specified by the data requirement (i.e. the union of the results of the FHIR Queries represents the complete data for the data requirement). This is not a resolveable URL, in that it will contain 1) No base canonical (i.e. it's a relative query), and 2) Parameters using tokens that are delimited using double-braces and the context parameters are dependent solely on the subjectType, according to the following: Patient: context.patientId, Practitioner: context.practitionerId, Organization: context.organizationId, Location: context.locationId, Device: context.deviceId. For example, for a Library with a subjectType of Patient, the context parameter {{context.patientId}} will be used as a token to be replaced with the id of the Patient in context. This extension is used primarily to address the use case for satisfying a data requirement for a single subject. However, the query pattern could also be used to satisfy population level requests by removing the subject-level filter from the query.

ShortWhat FHIR query?
Comments

Supports communicating a FHIR query (or set of queries) for the given data requirement. The query is server-specific, and will need to be created as informed by a CapabilityStatement. The $data-requirements operation should be expected to be able to provide an Endpoint or CapabilityStatement to provide this information.; If no endpoint or capability statement is provided, the capability statement of the server performing the operation is used.

Control0..1
TypeExtension(FHIR Query Pattern) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
157. PlanDefinition.action:encounterStart.input.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1
(required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
159. PlanDefinition.action:encounterStart.output
Definition

Defines the outputs of the action, if any.

ShortOutput data definition
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
161. PlanDefinition.action:encounterStart.output.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1
(required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
163. PlanDefinition.action:encounterStart.relatedAction
Definition

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

ShortRelationship to another action
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.

Control10..1*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
165. PlanDefinition.action:encounterStart.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
167. PlanDefinition.action:encounterStart.relatedAction.actionId
Definition

The element id of the related action.

ShortWhat action is this related to
Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Value
{
  "actionId" : "check-for-immediate-reporting"
}
<actionId value="check-for-immediate-reporting"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
169. PlanDefinition.action:encounterStart.relatedAction.relationship
Definition

The relationship of this action to the related action.

Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control1..1
BindingThe codes SHALL be taken from ActionRelationshipTypehttp://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1
(required to http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1)

Defines the types of relationships between actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Value
{
  "relationship" : "before-start"
}
<relationship value="before-start"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
171. PlanDefinition.action:encounterStart.relatedAction.offset[x]
Definition

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

ShortTime offset for the relationship
Control0..1
TypeChoice of: Duration, Range
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action.relatedAction.offset[x]. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this

Slicing Note: Other type slices that contain no new information are not shown in this view

173. PlanDefinition.action:encounterStart.relatedAction.offset[x]:offsetDuration
Slice NameoffsetDuration
Definition

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

ShortTime offset for the relationship
Control0..1
TypeDuration, Range
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
ExampleWait 1 hour before next action.: { "value" : 1, "unit" : "h" }
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
176. PlanDefinition.action:encounterStart.timing[x]
Definition

An optional value describing when the action should be performed.

ShortWhen the action should take place
Control0..1
TypeDuration, dateTime, Period, Timing, Range, Age
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
178. PlanDefinition.action:checkForImmediateReporting
Slice NamecheckForImmediateReporting
Definition

Defines the "check-for-immediate-reporting" action, which checks for immediately reportable evidence and schedules the subsequent reportability checks.


An action or group of actions to be taken as part of the plan.

ShortCheck for immediate reportingAction defined by the plan
Comments

Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.

Control10..1*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
180. PlanDefinition.action:checkForImmediateReporting.id
Definition

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

ShortUnique id for inter-element referencing
Control10..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "id" : "check-for-immediate-reporting"
}
<id value="check-for-immediate-reporting"/>
182. PlanDefinition.action:checkForImmediateReporting.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
184. PlanDefinition.action:checkForImmediateReporting.description
Definition

Description of the check for immediate reporting action.


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

ShortDescription of the check for immediate reporting action.Brief description of the action
Control10..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Value
{
  "description" : "This action represents the start of the check suspected disorder reporting workflow in response to the encounter-start event."
}
<description value="This action represents the start of the check suspected disorder reporting workflow in response to the encounter-start event."/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
186. PlanDefinition.action:checkForImmediateReporting.code
Definition

The US-PH-PlanDefinition-Action code for the "check-for-immediate-reporting" action.


A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode for the "check-for-immediate-reporting" action.Code representing the meaning of the action or sub-actions
Control10..1*
BindingUnless not suitable, these codes SHALL be taken from For codes, see US Public Health ValueSet - PlanDefinition Action
(extensible to http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-plandefinition-action)

The set of actions that can be used to create plan definition

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "execute-reporting-workflow"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="execute-reporting-workflow"/>
  </coding>
</code>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
188. PlanDefinition.action:checkForImmediateReporting.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
190. PlanDefinition.action:checkForImmediateReporting.trigger.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control10..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.trigger.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
192. PlanDefinition.action:checkForImmediateReporting.trigger.extension:namedEventType
Slice NamenamedEventType
Definition

Indicates the types of named events to subscribe to from the EHR.

ShortUS Public Health Named Event Type Extension
Control1..1
TypeExtension(US Public Health Named Event Type Extension) (Extension Type: CodeableConcept)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
194. PlanDefinition.action:checkForImmediateReporting.trigger.type
Definition

The type of triggering event.

Shortnamed-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Control1..1
BindingThe codes SHALL be taken from TriggerTypehttp://hl7.org/fhir/ValueSet/trigger-type|4.0.1
(required to http://hl7.org/fhir/ValueSet/trigger-type|4.0.1)

The type of trigger.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Value
{
  "type" : "named-event"
}
<type value="named-event"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
196. PlanDefinition.action:checkForImmediateReporting.condition
Definition

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

ShortWhether or not the action is applicable
Comments

When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
198. PlanDefinition.action:checkForImmediateReporting.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
200. PlanDefinition.action:checkForImmediateReporting.condition.kind
Definition

The kind of condition.

Shortapplicability | start | stop
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 enter/exit criteria for an action.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1
(required to http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1)

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
202. PlanDefinition.action:checkForImmediateReporting.condition.expression
Definition

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

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
204. PlanDefinition.action:checkForImmediateReporting.input
Definition

Defines input data requirements for the action.

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
206. PlanDefinition.action:checkForImmediateReporting.input.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
208. PlanDefinition.action:checkForImmediateReporting.input.extension:fhirquerypattern
Slice Namefhirquerypattern
Definition

A FHIR Query URL pattern that corresponds to the data specified by the data requirement. If multiple FHIR Query URLs are present, they each contribute to the data specified by the data requirement (i.e. the union of the results of the FHIR Queries represents the complete data for the data requirement). This is not a resolveable URL, in that it will contain 1) No base canonical (i.e. it's a relative query), and 2) Parameters using tokens that are delimited using double-braces and the context parameters are dependent solely on the subjectType, according to the following: Patient: context.patientId, Practitioner: context.practitionerId, Organization: context.organizationId, Location: context.locationId, Device: context.deviceId. For example, for a Library with a subjectType of Patient, the context parameter {{context.patientId}} will be used as a token to be replaced with the id of the Patient in context. This extension is used primarily to address the use case for satisfying a data requirement for a single subject. However, the query pattern could also be used to satisfy population level requests by removing the subject-level filter from the query.

ShortWhat FHIR query?
Comments

Supports communicating a FHIR query (or set of queries) for the given data requirement. The query is server-specific, and will need to be created as informed by a CapabilityStatement. The $data-requirements operation should be expected to be able to provide an Endpoint or CapabilityStatement to provide this information.; If no endpoint or capability statement is provided, the capability statement of the server performing the operation is used.

Control0..1
TypeExtension(FHIR Query Pattern) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
210. PlanDefinition.action:checkForImmediateReporting.input.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1
(required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
212. PlanDefinition.action:checkForImmediateReporting.output
Definition

Defines the outputs of the action, if any.

ShortOutput data definition
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
214. PlanDefinition.action:checkForImmediateReporting.output.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1
(required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
216. PlanDefinition.action:checkForImmediateReporting.relatedAction
Definition

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

ShortRelationship to another action
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.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
218. PlanDefinition.action:checkForImmediateReporting.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
220. PlanDefinition.action:checkForImmediateReporting.relatedAction.actionId
Definition

The element id of the related action.

ShortWhat action is this related to
Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
222. PlanDefinition.action:checkForImmediateReporting.relatedAction.relationship
Definition

The relationship of this action to the related action.

Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control1..1
BindingThe codes SHALL be taken from ActionRelationshipTypehttp://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1
(required to http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1)

Defines the types of relationships between actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
224. PlanDefinition.action:checkForImmediateReporting.relatedAction.offset[x]
Definition

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

ShortTime offset for the relationship
Control0..1
TypeChoice of: Duration, Range
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action.relatedAction.offset[x]. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this
226. PlanDefinition.action:checkForImmediateReporting.relatedAction.offset[x]:offsetDuration
Slice NameoffsetDuration
Definition

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

ShortTime offset for the relationship
Control0..1
TypeDuration, Range
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
228. PlanDefinition.action:checkForImmediateReporting.timing[x]
Definition

An optional value describing when the action should be performed.

ShortWhen the action should take place
Control0..1
TypeDuration, dateTime, Period, Timing, Range, Age
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
230. PlanDefinition.action:checkForImmediateReporting.action
Definition

Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.

ShortA sub-action
Control40..*
TypeSeettp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action.action. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ id
232. PlanDefinition.action:checkForImmediateReporting.action.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
234. PlanDefinition.action:checkForImmediateReporting.action.description
Definition

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

ShortBrief description of the action
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
236. PlanDefinition.action:checkForImmediateReporting.action.code
Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control0..1*
BindingUnless not suitable, these codes SHALL be taken from For codes, see US Public Health ValueSet - PlanDefinition Action
(extensible to http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-plandefinition-action)

The set of actions that can be used to create plan definition

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
238. PlanDefinition.action:checkForImmediateReporting.action.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
240. PlanDefinition.action:checkForImmediateReporting.action.trigger.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control10..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.action.trigger.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
242. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable
Slice NameisEncounterImmediatelyReportable
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.

ShortA sub-action
Control10..1*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
244. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.id
Definition

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

ShortUnique id for inter-element referencing
Control10..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "id" : "is-encounter-immediately-reportable"
}
<id value="is-encounter-immediately-reportable"/>
246. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
248. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.description
Definition

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

ShortBrief description of the action
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
250. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.code
Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control10..*
TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "check-trigger-codes"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="check-trigger-codes"/>
  </coding>
</code>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
252. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
254. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.condition
Definition

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

ShortWhether or not the action is applicable
Comments

When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
256. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
258. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.condition.kind
Definition

The kind of condition.

Shortapplicability | start | stop
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 enter/exit criteria for an action.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1
(required to http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1)

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Value
{
  "kind" : "applicability"
}
<kind value="applicability"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
260. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.condition.expression
Definition

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

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control10..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
262. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.condition.expression.language
Definition

The media type of the language for the expression.

Shorttext/cql | text/fhirpath | application/x-fhir-query | etc.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from ExpressionLanguagehttp://hl7.org/fhir/ValueSet/expression-language|4.0.1
(extensible to http://hl7.org/fhir/ValueSet/expression-language|4.0.1)

The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Fixed Value
{
  "language" : "text/fhirpath"
}
<language value="text/fhirpath"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
264. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.input
Definition

Defines input data requirements for the action. Required data is accessible via a context variable named '%[id]' using the 'id' of the input data requirement


Defines input data requirements for the action.

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
266. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.input.id
Definition

The id of the input requirement, allowing the data to be referenced via a context variable named '%[id]'


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

ShortUnique id for inter-element referencing
Control10..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
268. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.input.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1
(required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
270. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable
Slice NamecontinueCheckReportable
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.

ShortA sub-action
Control10..1*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
272. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.id
Definition

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

ShortUnique id for inter-element referencing
Control10..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "id" : "continue-check-reportable"
}
<id value="continue-check-reportable"/>
274. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
276. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.description
Definition

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

ShortBrief description of the action
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
278. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.code
Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control10..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "evaluate-condition"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="evaluate-condition"/>
  </coding>
</code>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
280. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
282. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.condition
Definition

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

ShortWhether or not the action is applicable
Comments

When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
284. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
286. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.condition.kind
Definition

The kind of condition.

Shortapplicability | start | stop
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 enter/exit criteria for an action.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1
(required to http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1)

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Value
{
  "kind" : "applicability"
}
<kind value="applicability"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
288. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.condition.expression
Definition

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

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control10..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
290. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.condition.expression.language
Definition

The media type of the language for the expression.

Shorttext/cql | text/fhirpath | application/x-fhir-query | etc.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from ExpressionLanguagehttp://hl7.org/fhir/ValueSet/expression-language|4.0.1
(extensible to http://hl7.org/fhir/ValueSet/expression-language|4.0.1)

The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Fixed Value
{
  "language" : "text/fhirpath"
}
<language value="text/fhirpath"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
292. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter
Slice NameterminateLateEncounter
Definition

Terminates the reporting workflow for an encounter that is still in progress beyond the normal reporting duration, or that ended more than the post-encounter grace period ago.


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.

ShortTerminate a late encounterA sub-action
Control10..1*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
294. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.id
Definition

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

ShortUnique id for inter-element referencing
Control10..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "id" : "terminate-late-encounter"
}
<id value="terminate-late-encounter"/>
296. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
298. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.description
Definition

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

ShortBrief description of the action
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
300. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.code
Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control10..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "terminate-reporting-workflow"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="terminate-reporting-workflow"/>
  </coding>
</code>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
302. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
304. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.condition
Definition

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

ShortWhether or not the action is applicable
Comments

When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
306. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
308. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.condition.kind
Definition

The kind of condition.

Shortapplicability | start | stop
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 enter/exit criteria for an action.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1
(required to http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1)

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Value
{
  "kind" : "applicability"
}
<kind value="applicability"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
310. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.condition.expression
Definition

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

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control10..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
312. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.condition.expression.language
Definition

The media type of the language for the expression.

Shorttext/cql | text/fhirpath | application/x-fhir-query | etc.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from ExpressionLanguagehttp://hl7.org/fhir/ValueSet/expression-language|4.0.1
(extensible to http://hl7.org/fhir/ValueSet/expression-language|4.0.1)

The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Fixed Value
{
  "language" : "text/fhirpath"
}
<language value="text/fhirpath"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
314. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted
Slice NameisLateEncounterCompleted
Definition

Records completion of reporting for an encounter that finished after its reporting window had elapsed. Ambulatory encounters use the ambulatory reporting duration; inpatient encounters use the normal reporting duration.


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.

ShortLate encounter completedA sub-action
Control10..1*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
316. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.id
Definition

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

ShortUnique id for inter-element referencing
Control10..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "id" : "is-late-encounter-completed"
}
<id value="is-late-encounter-completed"/>
318. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
320. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.description
Definition

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

ShortBrief description of the action
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
322. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.code
Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control10..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "complete-reporting"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="complete-reporting"/>
  </coding>
</code>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
324. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
326. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.condition
Definition

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

ShortWhether or not the action is applicable
Comments

When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
328. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
330. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.condition.kind
Definition

The kind of condition.

Shortapplicability | start | stop
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 enter/exit criteria for an action.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1
(required to http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1)

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Value
{
  "kind" : "applicability"
}
<kind value="applicability"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
332. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.condition.expression
Definition

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

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control10..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
334. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.condition.expression.language
Definition

The media type of the language for the expression.

Shorttext/cql | text/fhirpath | application/x-fhir-query | etc.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from ExpressionLanguagehttp://hl7.org/fhir/ValueSet/expression-language|4.0.1
(extensible to http://hl7.org/fhir/ValueSet/expression-language|4.0.1)

The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Fixed Value
{
  "language" : "text/fhirpath"
}
<language value="text/fhirpath"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
336. PlanDefinition.action:checkReportable
Slice NamecheckReportable
Definition

Defines the checking of the encounter for reportability.


An action or group of actions to be taken as part of the plan.

ShortCheck the encounter for reportabilityAction defined by the plan
Comments

Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.

Control10..1*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
338. PlanDefinition.action:checkReportable.id
Definition

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

ShortUnique id for inter-element referencing
Control10..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "id" : "check-reportable"
}
<id value="check-reportable"/>
340. PlanDefinition.action:checkReportable.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
342. PlanDefinition.action:checkReportable.description
Definition

Description of the Periodic Update of eICR action within the eICR action.


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

ShortDescription of the Periodic Update of eICR action.Brief description of the action
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Value
{
  "description" : "This action represents the check for suspected reportability of the eICR."
}
<description value="This action represents the check for suspected reportability of the eICR."/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
344. PlanDefinition.action:checkReportable.code
Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control10..1*
BindingUnless not suitable, these codes SHALL be taken from For codes, see US Public Health ValueSet - PlanDefinition Action
(extensible to http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-plandefinition-action)

The set of actions that can be used to create plan definition

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "execute-reporting-workflow"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="execute-reporting-workflow"/>
  </coding>
</code>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
346. PlanDefinition.action:checkReportable.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
348. PlanDefinition.action:checkReportable.trigger.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control10..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.trigger.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
350. PlanDefinition.action:checkReportable.trigger.extension:namedEventType
Slice NamenamedEventType
Definition

Indicates the types of named events to subscribe to from the EHR.

ShortUS Public Health Named Event Type Extension
Control1..1
TypeExtension(US Public Health Named Event Type Extension) (Extension Type: CodeableConcept)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
352. PlanDefinition.action:checkReportable.trigger.type
Definition

The type of triggering event.

Shortnamed-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Control1..1
BindingThe codes SHALL be taken from TriggerTypehttp://hl7.org/fhir/ValueSet/trigger-type|4.0.1
(required to http://hl7.org/fhir/ValueSet/trigger-type|4.0.1)

The type of trigger.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Value
{
  "type" : "named-event"
}
<type value="named-event"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
354. PlanDefinition.action:checkReportable.condition
Definition

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

ShortWhether or not the action is applicable
Comments

When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
356. PlanDefinition.action:checkReportable.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
358. PlanDefinition.action:checkReportable.condition.kind
Definition

The kind of condition.

Shortapplicability | start | stop
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 enter/exit criteria for an action.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1
(required to http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1)

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
360. PlanDefinition.action:checkReportable.condition.expression
Definition

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

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
362. PlanDefinition.action:checkReportable.input
Definition

Defines input data requirements for the action.

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
364. PlanDefinition.action:checkReportable.input.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
366. PlanDefinition.action:checkReportable.input.extension:fhirquerypattern
Slice Namefhirquerypattern
Definition

A FHIR Query URL pattern that corresponds to the data specified by the data requirement. If multiple FHIR Query URLs are present, they each contribute to the data specified by the data requirement (i.e. the union of the results of the FHIR Queries represents the complete data for the data requirement). This is not a resolveable URL, in that it will contain 1) No base canonical (i.e. it's a relative query), and 2) Parameters using tokens that are delimited using double-braces and the context parameters are dependent solely on the subjectType, according to the following: Patient: context.patientId, Practitioner: context.practitionerId, Organization: context.organizationId, Location: context.locationId, Device: context.deviceId. For example, for a Library with a subjectType of Patient, the context parameter {{context.patientId}} will be used as a token to be replaced with the id of the Patient in context. This extension is used primarily to address the use case for satisfying a data requirement for a single subject. However, the query pattern could also be used to satisfy population level requests by removing the subject-level filter from the query.

ShortWhat FHIR query?
Comments

Supports communicating a FHIR query (or set of queries) for the given data requirement. The query is server-specific, and will need to be created as informed by a CapabilityStatement. The $data-requirements operation should be expected to be able to provide an Endpoint or CapabilityStatement to provide this information.; If no endpoint or capability statement is provided, the capability statement of the server performing the operation is used.

Control0..1
TypeExtension(FHIR Query Pattern) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
368. PlanDefinition.action:checkReportable.input.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1
(required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
370. PlanDefinition.action:checkReportable.output
Definition

Defines the outputs of the action, if any.

ShortOutput data definition
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
372. PlanDefinition.action:checkReportable.output.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1
(required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
374. PlanDefinition.action:checkReportable.relatedAction
Definition

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

ShortRelationship to another action
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.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
376. PlanDefinition.action:checkReportable.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
378. PlanDefinition.action:checkReportable.relatedAction.actionId
Definition

The element id of the related action.

ShortWhat action is this related to
Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
380. PlanDefinition.action:checkReportable.relatedAction.relationship
Definition

The relationship of this action to the related action.

Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control1..1
BindingThe codes SHALL be taken from ActionRelationshipTypehttp://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1
(required to http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1)

Defines the types of relationships between actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
382. PlanDefinition.action:checkReportable.relatedAction.offset[x]
Definition

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

ShortTime offset for the relationship
Control0..1
TypeChoice of: Duration, Range
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action.relatedAction.offset[x]. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this
384. PlanDefinition.action:checkReportable.relatedAction.offset[x]:offsetDuration
Slice NameoffsetDuration
Definition

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

ShortTime offset for the relationship
Control0..1
TypeDuration, Range
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
386. PlanDefinition.action:checkReportable.timing[x]
Definition

An optional value describing when the action should be performed.

ShortWhen the action should take place
Control0..1
TypeDuration, dateTime, Period, Timing, Range, Age
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
388. PlanDefinition.action:checkReportable.action
Definition

Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.

ShortA sub-action
Control70..*
TypeSeettp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action.action. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ id
390. PlanDefinition.action:checkReportable.action.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
392. PlanDefinition.action:checkReportable.action.description
Definition

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

ShortBrief description of the action
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
394. PlanDefinition.action:checkReportable.action.code
Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control0..1*
BindingUnless not suitable, these codes SHALL be taken from For codes, see US Public Health ValueSet - PlanDefinition Action
(extensible to http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-plandefinition-action)

The set of actions that can be used to create plan definition

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
396. PlanDefinition.action:checkReportable.action.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
398. PlanDefinition.action:checkReportable.action.trigger.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control10..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.action.trigger.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
400. PlanDefinition.action:checkReportable.action:isEncounterReportable
Slice NameisEncounterReportable
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.

ShortA sub-action
Control10..1*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
402. PlanDefinition.action:checkReportable.action:isEncounterReportable.id
Definition

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

ShortUnique id for inter-element referencing
Control10..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "id" : "is-encounter-reportable"
}
<id value="is-encounter-reportable"/>
404. PlanDefinition.action:checkReportable.action:isEncounterReportable.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
406. PlanDefinition.action:checkReportable.action:isEncounterReportable.description
Definition

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

ShortBrief description of the action
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
408. PlanDefinition.action:checkReportable.action:isEncounterReportable.code
Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control10..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "check-trigger-codes"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="check-trigger-codes"/>
  </coding>
</code>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
410. PlanDefinition.action:checkReportable.action:isEncounterReportable.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
412. PlanDefinition.action:checkReportable.action:isEncounterReportable.condition
Definition

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

ShortWhether or not the action is applicable
Comments

When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
414. PlanDefinition.action:checkReportable.action:isEncounterReportable.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
416. PlanDefinition.action:checkReportable.action:isEncounterReportable.condition.kind
Definition

The kind of condition.

Shortapplicability | start | stop
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 enter/exit criteria for an action.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1
(required to http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1)

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Value
{
  "kind" : "applicability"
}
<kind value="applicability"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
418. PlanDefinition.action:checkReportable.action:isEncounterReportable.condition.expression
Definition

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

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control10..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
420. PlanDefinition.action:checkReportable.action:isEncounterReportable.condition.expression.language
Definition

The media type of the language for the expression.

Shorttext/cql | text/fhirpath | application/x-fhir-query | etc.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from ExpressionLanguagehttp://hl7.org/fhir/ValueSet/expression-language|4.0.1
(extensible to http://hl7.org/fhir/ValueSet/expression-language|4.0.1)

The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Fixed Value
{
  "language" : "text/fhirpath"
}
<language value="text/fhirpath"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
422. PlanDefinition.action:checkReportable.action:isEncounterReportable.input
Definition

Defines input data requirements for the action. Required data is accessible via a context variable named %[id] using the id of the input data requirement


Defines input data requirements for the action.

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
424. PlanDefinition.action:checkReportable.action:isEncounterReportable.input.id
Definition

The id of the input requirement, allowing the data to be referenced via a context variable named %[id]


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

ShortUnique id for inter-element referencing
Control10..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
426. PlanDefinition.action:checkReportable.action:isEncounterReportable.input.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1
(required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
428. PlanDefinition.action:checkReportable.action:checkUpdateEicr
Slice NamecheckUpdateEicr
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.

ShortA sub-action
Control10..1*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
430. PlanDefinition.action:checkReportable.action:checkUpdateEicr.id
Definition

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

ShortUnique id for inter-element referencing
Control10..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "id" : "check-update-eicr"
}
<id value="check-update-eicr"/>
432. PlanDefinition.action:checkReportable.action:checkUpdateEicr.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
434. PlanDefinition.action:checkReportable.action:checkUpdateEicr.description
Definition

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

ShortBrief description of the action
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
436. PlanDefinition.action:checkReportable.action:checkUpdateEicr.code
Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control10..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "evaluate-condition"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="evaluate-condition"/>
  </coding>
</code>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
438. PlanDefinition.action:checkReportable.action:checkUpdateEicr.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
440. PlanDefinition.action:checkReportable.action:checkUpdateEicr.condition
Definition

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

ShortWhether or not the action is applicable
Comments

When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
442. PlanDefinition.action:checkReportable.action:checkUpdateEicr.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
444. PlanDefinition.action:checkReportable.action:checkUpdateEicr.condition.kind
Definition

The kind of condition.

Shortapplicability | start | stop
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 enter/exit criteria for an action.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1
(required to http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1)

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Value
{
  "kind" : "applicability"
}
<kind value="applicability"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
446. PlanDefinition.action:checkReportable.action:checkUpdateEicr.condition.expression
Definition

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

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control10..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
448. PlanDefinition.action:checkReportable.action:checkUpdateEicr.condition.expression.language
Definition

The media type of the language for the expression.

Shorttext/cql | text/fhirpath | application/x-fhir-query | etc.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from ExpressionLanguagehttp://hl7.org/fhir/ValueSet/expression-language|4.0.1
(extensible to http://hl7.org/fhir/ValueSet/expression-language|4.0.1)

The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Fixed Value
{
  "language" : "text/fhirpath"
}
<language value="text/fhirpath"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
450. PlanDefinition.action:checkReportable.action:encounterInProgress
Slice NameencounterInProgress
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.

ShortA sub-action
Control10..1*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
452. PlanDefinition.action:checkReportable.action:encounterInProgress.id
Definition

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

ShortUnique id for inter-element referencing
Control10..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "id" : "is-encounter-in-progress"
}
<id value="is-encounter-in-progress"/>
454. PlanDefinition.action:checkReportable.action:encounterInProgress.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
456. PlanDefinition.action:checkReportable.action:encounterInProgress.description
Definition

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

ShortBrief description of the action
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
458. PlanDefinition.action:checkReportable.action:encounterInProgress.code
Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control10..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "evaluate-condition"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="evaluate-condition"/>
  </coding>
</code>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
460. PlanDefinition.action:checkReportable.action:encounterInProgress.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
462. PlanDefinition.action:checkReportable.action:encounterInProgress.condition
Definition

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

ShortWhether or not the action is applicable
Comments

When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
464. PlanDefinition.action:checkReportable.action:encounterInProgress.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
466. PlanDefinition.action:checkReportable.action:encounterInProgress.condition.kind
Definition

The kind of condition.

Shortapplicability | start | stop
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 enter/exit criteria for an action.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1
(required to http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1)

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Value
{
  "kind" : "applicability"
}
<kind value="applicability"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
468. PlanDefinition.action:checkReportable.action:encounterInProgress.condition.expression
Definition

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

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control10..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
470. PlanDefinition.action:checkReportable.action:encounterInProgress.condition.expression.language
Definition

The media type of the language for the expression.

Shorttext/cql | text/fhirpath | application/x-fhir-query | etc.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from ExpressionLanguagehttp://hl7.org/fhir/ValueSet/expression-language|4.0.1
(extensible to http://hl7.org/fhir/ValueSet/expression-language|4.0.1)

The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Fixed Value
{
  "language" : "text/fhirpath"
}
<language value="text/fhirpath"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
472. PlanDefinition.action:checkReportable.action:ambEncounterInProgress
Slice NameambEncounterInProgress
Definition

Continues the reportability check loop for an ambulatory encounter that is still in progress and within the ambulatory reporting duration.


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.

ShortAmbulatory encounter in progressA sub-action
Control10..1*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
474. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.id
Definition

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

ShortUnique id for inter-element referencing
Control10..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "id" : "is-amb-encounter-in-progress"
}
<id value="is-amb-encounter-in-progress"/>
476. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
478. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.description
Definition

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

ShortBrief description of the action
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
480. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.code
Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control10..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "evaluate-condition"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="evaluate-condition"/>
  </coding>
</code>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
482. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
484. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.condition
Definition

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

ShortWhether or not the action is applicable
Comments

When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
486. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
488. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.condition.kind
Definition

The kind of condition.

Shortapplicability | start | stop
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 enter/exit criteria for an action.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1
(required to http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1)

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Value
{
  "kind" : "applicability"
}
<kind value="applicability"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
490. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.condition.expression
Definition

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

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control10..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
492. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.condition.expression.language
Definition

The media type of the language for the expression.

Shorttext/cql | text/fhirpath | application/x-fhir-query | etc.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from ExpressionLanguagehttp://hl7.org/fhir/ValueSet/expression-language|4.0.1
(extensible to http://hl7.org/fhir/ValueSet/expression-language|4.0.1)

The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Fixed Value
{
  "language" : "text/fhirpath"
}
<language value="text/fhirpath"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
494. PlanDefinition.action:checkReportable.action:terminateEncounter
Slice NameterminateEncounter
Definition

Terminates the reporting workflow for an inpatient, emergency or observation encounter that has passed the normal reporting duration or the post-encounter grace period.


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.

ShortTerminate an inpatient encounterA sub-action
Control10..1*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
496. PlanDefinition.action:checkReportable.action:terminateEncounter.id
Definition

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

ShortUnique id for inter-element referencing
Control10..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "id" : "terminate-encounter"
}
<id value="terminate-encounter"/>
498. PlanDefinition.action:checkReportable.action:terminateEncounter.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
500. PlanDefinition.action:checkReportable.action:terminateEncounter.description
Definition

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

ShortBrief description of the action
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
502. PlanDefinition.action:checkReportable.action:terminateEncounter.code
Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control10..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "terminate-reporting-workflow"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="terminate-reporting-workflow"/>
  </coding>
</code>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
504. PlanDefinition.action:checkReportable.action:terminateEncounter.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
506. PlanDefinition.action:checkReportable.action:terminateEncounter.condition
Definition

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

ShortWhether or not the action is applicable
Comments

When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
508. PlanDefinition.action:checkReportable.action:terminateEncounter.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
510. PlanDefinition.action:checkReportable.action:terminateEncounter.condition.kind
Definition

The kind of condition.

Shortapplicability | start | stop
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 enter/exit criteria for an action.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1
(required to http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1)

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Value
{
  "kind" : "applicability"
}
<kind value="applicability"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
512. PlanDefinition.action:checkReportable.action:terminateEncounter.condition.expression
Definition

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

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control10..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
514. PlanDefinition.action:checkReportable.action:terminateEncounter.condition.expression.language
Definition

The media type of the language for the expression.

Shorttext/cql | text/fhirpath | application/x-fhir-query | etc.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from ExpressionLanguagehttp://hl7.org/fhir/ValueSet/expression-language|4.0.1
(extensible to http://hl7.org/fhir/ValueSet/expression-language|4.0.1)

The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Fixed Value
{
  "language" : "text/fhirpath"
}
<language value="text/fhirpath"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
516. PlanDefinition.action:checkReportable.action:terminateAmbEncounter
Slice NameterminateAmbEncounter
Definition

Terminates the reporting workflow for an ambulatory, virtual or home health encounter that has passed the ambulatory reporting duration or the post-encounter grace period.


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.

ShortTerminate an ambulatory encounterA sub-action
Control10..1*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
518. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.id
Definition

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

ShortUnique id for inter-element referencing
Control10..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "id" : "terminate-amb-encounter"
}
<id value="terminate-amb-encounter"/>
520. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
522. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.description
Definition

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

ShortBrief description of the action
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
524. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.code
Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control10..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "terminate-reporting-workflow"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="terminate-reporting-workflow"/>
  </coding>
</code>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
526. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
528. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.condition
Definition

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

ShortWhether or not the action is applicable
Comments

When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
530. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
532. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.condition.kind
Definition

The kind of condition.

Shortapplicability | start | stop
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 enter/exit criteria for an action.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1
(required to http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1)

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Value
{
  "kind" : "applicability"
}
<kind value="applicability"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
534. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.condition.expression
Definition

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

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control10..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
536. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.condition.expression.language
Definition

The media type of the language for the expression.

Shorttext/cql | text/fhirpath | application/x-fhir-query | etc.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from ExpressionLanguagehttp://hl7.org/fhir/ValueSet/expression-language|4.0.1
(extensible to http://hl7.org/fhir/ValueSet/expression-language|4.0.1)

The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Fixed Value
{
  "language" : "text/fhirpath"
}
<language value="text/fhirpath"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
538. PlanDefinition.action:checkReportable.action:encounterComplete
Slice NameencounterComplete
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.

ShortA sub-action
Control10..1*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
540. PlanDefinition.action:checkReportable.action:encounterComplete.id
Definition

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

ShortUnique id for inter-element referencing
Control10..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "id" : "is-encounter-completed"
}
<id value="is-encounter-completed"/>
542. PlanDefinition.action:checkReportable.action:encounterComplete.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
544. PlanDefinition.action:checkReportable.action:encounterComplete.description
Definition

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

ShortBrief description of the action
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
546. PlanDefinition.action:checkReportable.action:encounterComplete.code
Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control10..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "complete-reporting"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="complete-reporting"/>
  </coding>
</code>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
548. PlanDefinition.action:checkReportable.action:encounterComplete.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
550. PlanDefinition.action:checkReportable.action:encounterComplete.condition
Definition

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

ShortWhether or not the action is applicable
Comments

When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
552. PlanDefinition.action:checkReportable.action:encounterComplete.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
554. PlanDefinition.action:checkReportable.action:encounterComplete.condition.kind
Definition

The kind of condition.

Shortapplicability | start | stop
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 enter/exit criteria for an action.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1
(required to http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1)

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Value
{
  "kind" : "applicability"
}
<kind value="applicability"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
556. PlanDefinition.action:checkReportable.action:encounterComplete.condition.expression
Definition

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

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control10..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
558. PlanDefinition.action:checkReportable.action:encounterComplete.condition.expression.language
Definition

The media type of the language for the expression.

Shorttext/cql | text/fhirpath | application/x-fhir-query | etc.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from ExpressionLanguagehttp://hl7.org/fhir/ValueSet/expression-language|4.0.1
(extensible to http://hl7.org/fhir/ValueSet/expression-language|4.0.1)

The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Fixed Value
{
  "language" : "text/fhirpath"
}
<language value="text/fhirpath"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
560. PlanDefinition.action:createEicr
Slice NamecreateEicr
Definition

Defines the "create-eicr" action


An action or group of actions to be taken as part of the plan.

ShortCreate the eICRAction defined by the plan
Comments

Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.

Control10..1*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
562. PlanDefinition.action:createEicr.id
Definition

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

ShortUnique id for inter-element referencing
Control10..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "id" : "create-eicr"
}
<id value="create-eicr"/>
564. PlanDefinition.action:createEicr.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
566. PlanDefinition.action:createEicr.description
Definition

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

ShortBrief description of the action
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Value
{
  "description" : "This action represents the creation of the eICR. It subsequently calls validate."
}
<description value="This action represents the creation of the eICR. It subsequently calls validate."/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
568. PlanDefinition.action:createEicr.code
Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control0..1*
BindingUnless not suitable, these codes SHALL be taken from For codes, see US Public Health ValueSet - PlanDefinition Action
(extensible to http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-plandefinition-action)

The set of actions that can be used to create plan definition

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "create-report"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="create-report"/>
  </coding>
</code>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
570. PlanDefinition.action:createEicr.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
572. PlanDefinition.action:createEicr.trigger.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control10..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.trigger.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
574. PlanDefinition.action:createEicr.trigger.extension:namedEventType
Slice NamenamedEventType
Definition

Indicates the types of named events to subscribe to from the EHR.

ShortUS Public Health Named Event Type Extension
Control1..1
TypeExtension(US Public Health Named Event Type Extension) (Extension Type: CodeableConcept)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
576. PlanDefinition.action:createEicr.trigger.type
Definition

The type of triggering event.

Shortnamed-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Control1..1
BindingThe codes SHALL be taken from TriggerTypehttp://hl7.org/fhir/ValueSet/trigger-type|4.0.1
(required to http://hl7.org/fhir/ValueSet/trigger-type|4.0.1)

The type of trigger.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Value
{
  "type" : "named-event"
}
<type value="named-event"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
578. PlanDefinition.action:createEicr.condition
Definition

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

ShortWhether or not the action is applicable
Comments

When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
580. PlanDefinition.action:createEicr.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
582. PlanDefinition.action:createEicr.condition.kind
Definition

The kind of condition.

Shortapplicability | start | stop
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 enter/exit criteria for an action.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1
(required to http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1)

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
584. PlanDefinition.action:createEicr.condition.expression
Definition

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

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
586. PlanDefinition.action:createEicr.input
Definition

Defines input data requirements for the action.

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
588. PlanDefinition.action:createEicr.input.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
590. PlanDefinition.action:createEicr.input.extension:fhirquerypattern
Slice Namefhirquerypattern
Definition

A FHIR Query URL pattern that corresponds to the data specified by the data requirement. If multiple FHIR Query URLs are present, they each contribute to the data specified by the data requirement (i.e. the union of the results of the FHIR Queries represents the complete data for the data requirement). This is not a resolveable URL, in that it will contain 1) No base canonical (i.e. it's a relative query), and 2) Parameters using tokens that are delimited using double-braces and the context parameters are dependent solely on the subjectType, according to the following: Patient: context.patientId, Practitioner: context.practitionerId, Organization: context.organizationId, Location: context.locationId, Device: context.deviceId. For example, for a Library with a subjectType of Patient, the context parameter {{context.patientId}} will be used as a token to be replaced with the id of the Patient in context. This extension is used primarily to address the use case for satisfying a data requirement for a single subject. However, the query pattern could also be used to satisfy population level requests by removing the subject-level filter from the query.

ShortWhat FHIR query?
Comments

Supports communicating a FHIR query (or set of queries) for the given data requirement. The query is server-specific, and will need to be created as informed by a CapabilityStatement. The $data-requirements operation should be expected to be able to provide an Endpoint or CapabilityStatement to provide this information.; If no endpoint or capability statement is provided, the capability statement of the server performing the operation is used.

Control0..1
TypeExtension(FHIR Query Pattern) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
592. PlanDefinition.action:createEicr.input.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1
(required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
594. PlanDefinition.action:createEicr.output
Definition

Defines the output of the action, the created eICR. The output is consumed as the input of the next action in the sequence.


Defines the outputs of the action, if any.

ShortThe eICR document bundle produced by this action.Output data definition
Control10..1*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
596. PlanDefinition.action:createEicr.output.id
Definition

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

ShortUnique id for inter-element referencing
Control10..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
598. PlanDefinition.action:createEicr.output.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1
(required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Value
{
  "type" : "Bundle"
}
<type value="Bundle"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
600. PlanDefinition.action:createEicr.output.profile
Definition

The profile of the required data, specified as the uri of the profile definition.

ShortThe profile of the required data
Control10..1*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Value
{
  "profile" : "http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle"
}
<profile value="http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
602. PlanDefinition.action:createEicr.relatedAction
Definition

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

ShortRelationship to another action
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.

Control10..1*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
604. PlanDefinition.action:createEicr.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
606. PlanDefinition.action:createEicr.relatedAction.actionId
Definition

The element id of the related action.

ShortWhat action is this related to
Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Value
{
  "actionId" : "validate-eicr"
}
<actionId value="validate-eicr"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
608. PlanDefinition.action:createEicr.relatedAction.relationship
Definition

The relationship of this action to the related action.

Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control1..1
BindingThe codes SHALL be taken from ActionRelationshipTypehttp://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1
(required to http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1)

Defines the types of relationships between actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Value
{
  "relationship" : "before-start"
}
<relationship value="before-start"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
610. PlanDefinition.action:createEicr.relatedAction.offset[x]
Definition

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

ShortTime offset for the relationship
Control0..1
TypeChoice of: Duration, Range
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action.relatedAction.offset[x]. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this
612. PlanDefinition.action:createEicr.relatedAction.offset[x]:offsetDuration
Slice NameoffsetDuration
Definition

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

ShortTime offset for the relationship
Control0..1
TypeDuration, Range
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
614. PlanDefinition.action:createEicr.timing[x]
Definition

An optional value describing when the action should be performed.

ShortWhen the action should take place
Control0..1
TypeDuration, dateTime, Period, Timing, Range, Age
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
616. PlanDefinition.action:validateEicr
Slice NamevalidateEicr
Definition

Defines the "validate-eicr" action


An action or group of actions to be taken as part of the plan.

ShortValidate the eICRAction defined by the plan
Comments

Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.

Control10..1*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
618. PlanDefinition.action:validateEicr.id
Definition

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

ShortUnique id for inter-element referencing
Control10..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "id" : "validate-eicr"
}
<id value="validate-eicr"/>
620. PlanDefinition.action:validateEicr.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
622. PlanDefinition.action:validateEicr.description
Definition

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

ShortBrief description of the action
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Value
{
  "description" : "This action represents the validation of the eICR. It subsequently calls route-and-send."
}
<description value="This action represents the validation of the eICR. It subsequently calls route-and-send."/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
624. PlanDefinition.action:validateEicr.code
Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control0..1*
BindingUnless not suitable, these codes SHALL be taken from For codes, see US Public Health ValueSet - PlanDefinition Action
(extensible to http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-plandefinition-action)

The set of actions that can be used to create plan definition

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "validate-report"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="validate-report"/>
  </coding>
</code>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
626. PlanDefinition.action:validateEicr.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
628. PlanDefinition.action:validateEicr.trigger.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control10..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.trigger.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
630. PlanDefinition.action:validateEicr.trigger.extension:namedEventType
Slice NamenamedEventType
Definition

Indicates the types of named events to subscribe to from the EHR.

ShortUS Public Health Named Event Type Extension
Control1..1
TypeExtension(US Public Health Named Event Type Extension) (Extension Type: CodeableConcept)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
632. PlanDefinition.action:validateEicr.trigger.type
Definition

The type of triggering event.

Shortnamed-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Control1..1
BindingThe codes SHALL be taken from TriggerTypehttp://hl7.org/fhir/ValueSet/trigger-type|4.0.1
(required to http://hl7.org/fhir/ValueSet/trigger-type|4.0.1)

The type of trigger.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Value
{
  "type" : "named-event"
}
<type value="named-event"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
634. PlanDefinition.action:validateEicr.condition
Definition

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

ShortWhether or not the action is applicable
Comments

When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
636. PlanDefinition.action:validateEicr.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
638. PlanDefinition.action:validateEicr.condition.kind
Definition

The kind of condition.

Shortapplicability | start | stop
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 enter/exit criteria for an action.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1
(required to http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1)

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
640. PlanDefinition.action:validateEicr.condition.expression
Definition

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

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
642. PlanDefinition.action:validateEicr.input
Definition

Defines input data requirements for the action.

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
644. PlanDefinition.action:validateEicr.input.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
646. PlanDefinition.action:validateEicr.input.extension:fhirquerypattern
Slice Namefhirquerypattern
Definition

A FHIR Query URL pattern that corresponds to the data specified by the data requirement. If multiple FHIR Query URLs are present, they each contribute to the data specified by the data requirement (i.e. the union of the results of the FHIR Queries represents the complete data for the data requirement). This is not a resolveable URL, in that it will contain 1) No base canonical (i.e. it's a relative query), and 2) Parameters using tokens that are delimited using double-braces and the context parameters are dependent solely on the subjectType, according to the following: Patient: context.patientId, Practitioner: context.practitionerId, Organization: context.organizationId, Location: context.locationId, Device: context.deviceId. For example, for a Library with a subjectType of Patient, the context parameter {{context.patientId}} will be used as a token to be replaced with the id of the Patient in context. This extension is used primarily to address the use case for satisfying a data requirement for a single subject. However, the query pattern could also be used to satisfy population level requests by removing the subject-level filter from the query.

ShortWhat FHIR query?
Comments

Supports communicating a FHIR query (or set of queries) for the given data requirement. The query is server-specific, and will need to be created as informed by a CapabilityStatement. The $data-requirements operation should be expected to be able to provide an Endpoint or CapabilityStatement to provide this information.; If no endpoint or capability statement is provided, the capability statement of the server performing the operation is used.

Control0..1
TypeExtension(FHIR Query Pattern) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
648. PlanDefinition.action:validateEicr.input.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1
(required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
650. PlanDefinition.action:validateEicr.output
Definition

Defines the output of the action, the validated eICR. The output is consumed as the input of the next action in the sequence.


Defines the outputs of the action, if any.

ShortThe eICR document bundle produced by this action.Output data definition
Control10..1*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
652. PlanDefinition.action:validateEicr.output.id
Definition

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

ShortUnique id for inter-element referencing
Control10..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
654. PlanDefinition.action:validateEicr.output.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1
(required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Value
{
  "type" : "Bundle"
}
<type value="Bundle"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
656. PlanDefinition.action:validateEicr.output.profile
Definition

The profile of the required data, specified as the uri of the profile definition.

ShortThe profile of the required data
Control10..1*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Value
{
  "profile" : "http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle"
}
<profile value="http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
658. PlanDefinition.action:validateEicr.relatedAction
Definition

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

ShortRelationship to another action
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.

Control10..1*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
660. PlanDefinition.action:validateEicr.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
662. PlanDefinition.action:validateEicr.relatedAction.actionId
Definition

The element id of the related action.

ShortWhat action is this related to
Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Value
{
  "actionId" : "route-and-send-eicr"
}
<actionId value="route-and-send-eicr"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
664. PlanDefinition.action:validateEicr.relatedAction.relationship
Definition

The relationship of this action to the related action.

Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control1..1
BindingThe codes SHALL be taken from ActionRelationshipTypehttp://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1
(required to http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1)

Defines the types of relationships between actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Value
{
  "relationship" : "before-start"
}
<relationship value="before-start"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
666. PlanDefinition.action:validateEicr.relatedAction.offset[x]
Definition

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

ShortTime offset for the relationship
Control0..1
TypeChoice of: Duration, Range
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action.relatedAction.offset[x]. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this
668. PlanDefinition.action:validateEicr.relatedAction.offset[x]:offsetDuration
Slice NameoffsetDuration
Definition

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

ShortTime offset for the relationship
Control0..1
TypeDuration, Range
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
670. PlanDefinition.action:validateEicr.timing[x]
Definition

An optional value describing when the action should be performed.

ShortWhen the action should take place
Control0..1
TypeDuration, dateTime, Period, Timing, Range, Age
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
672. PlanDefinition.action:routeAndSendEicr
Slice NamerouteAndSendEicr
Definition

Defines the routing and sending of the eICR.


An action or group of actions to be taken as part of the plan.

ShortRoute and send eICRAction defined by the plan
Comments

Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.

Control10..1*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
674. PlanDefinition.action:routeAndSendEicr.id
Definition

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

ShortUnique id for inter-element referencing
Control10..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "id" : "route-and-send-eicr"
}
<id value="route-and-send-eicr"/>
676. PlanDefinition.action:routeAndSendEicr.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
678. PlanDefinition.action:routeAndSendEicr.description
Definition

Description of the route and send action.


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

ShortDescription of the route and send action.Brief description of the action
Control10..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Value
{
  "description" : "This action represents the routing and sending of the eICR."
}
<description value="This action represents the routing and sending of the eICR."/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
680. PlanDefinition.action:routeAndSendEicr.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 might not be capable of interpreting it dynamically.

ShortStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
Control10..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Value
{
  "textEquivalent" : "Route and send eICR"
}
<textEquivalent value="Route and send eICR"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
682. PlanDefinition.action:routeAndSendEicr.code
Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control0..1*
BindingUnless not suitable, these codes SHALL be taken from For codes, see US Public Health ValueSet - PlanDefinition Action
(extensible to http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-plandefinition-action)

The set of actions that can be used to create plan definition

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "submit-report"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="submit-report"/>
  </coding>
</code>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
684. PlanDefinition.action:routeAndSendEicr.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
686. PlanDefinition.action:routeAndSendEicr.trigger.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control10..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.trigger.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
688. PlanDefinition.action:routeAndSendEicr.trigger.extension:namedEventType
Slice NamenamedEventType
Definition

Indicates the types of named events to subscribe to from the EHR.

ShortUS Public Health Named Event Type Extension
Control1..1
TypeExtension(US Public Health Named Event Type Extension) (Extension Type: CodeableConcept)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
690. PlanDefinition.action:routeAndSendEicr.trigger.type
Definition

The type of triggering event.

Shortnamed-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Control1..1
BindingThe codes SHALL be taken from TriggerTypehttp://hl7.org/fhir/ValueSet/trigger-type|4.0.1
(required to http://hl7.org/fhir/ValueSet/trigger-type|4.0.1)

The type of trigger.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Value
{
  "type" : "named-event"
}
<type value="named-event"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
692. PlanDefinition.action:routeAndSendEicr.condition
Definition

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

ShortWhether or not the action is applicable
Comments

When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
694. PlanDefinition.action:routeAndSendEicr.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
696. PlanDefinition.action:routeAndSendEicr.condition.kind
Definition

The kind of condition.

Shortapplicability | start | stop
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 enter/exit criteria for an action.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1
(required to http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1)

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
698. PlanDefinition.action:routeAndSendEicr.condition.expression
Definition

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

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
700. PlanDefinition.action:routeAndSendEicr.input
Definition

Defines input data requirements for the action.

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
702. PlanDefinition.action:routeAndSendEicr.input.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
704. PlanDefinition.action:routeAndSendEicr.input.extension:fhirquerypattern
Slice Namefhirquerypattern
Definition

A FHIR Query URL pattern that corresponds to the data specified by the data requirement. If multiple FHIR Query URLs are present, they each contribute to the data specified by the data requirement (i.e. the union of the results of the FHIR Queries represents the complete data for the data requirement). This is not a resolveable URL, in that it will contain 1) No base canonical (i.e. it's a relative query), and 2) Parameters using tokens that are delimited using double-braces and the context parameters are dependent solely on the subjectType, according to the following: Patient: context.patientId, Practitioner: context.practitionerId, Organization: context.organizationId, Location: context.locationId, Device: context.deviceId. For example, for a Library with a subjectType of Patient, the context parameter {{context.patientId}} will be used as a token to be replaced with the id of the Patient in context. This extension is used primarily to address the use case for satisfying a data requirement for a single subject. However, the query pattern could also be used to satisfy population level requests by removing the subject-level filter from the query.

ShortWhat FHIR query?
Comments

Supports communicating a FHIR query (or set of queries) for the given data requirement. The query is server-specific, and will need to be created as informed by a CapabilityStatement. The $data-requirements operation should be expected to be able to provide an Endpoint or CapabilityStatement to provide this information.; If no endpoint or capability statement is provided, the capability statement of the server performing the operation is used.

Control0..1
TypeExtension(FHIR Query Pattern) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
706. PlanDefinition.action:routeAndSendEicr.input.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1
(required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
708. PlanDefinition.action:routeAndSendEicr.output
Definition

Defines the output of the action, the submitted eICR. The output is consumed as the input of the next action in the sequence.


Defines the outputs of the action, if any.

ShortThe eICR document bundle produced by this action.Output data definition
Control10..1*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
710. PlanDefinition.action:routeAndSendEicr.output.id
Definition

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

ShortUnique id for inter-element referencing
Control10..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
712. PlanDefinition.action:routeAndSendEicr.output.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1
(required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Value
{
  "type" : "Bundle"
}
<type value="Bundle"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
714. PlanDefinition.action:routeAndSendEicr.output.profile
Definition

The profile of the required data, specified as the uri of the profile definition.

ShortThe profile of the required data
Control10..1*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Value
{
  "profile" : "http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle"
}
<profile value="http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
716. PlanDefinition.action:routeAndSendEicr.relatedAction
Definition

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

ShortRelationship to another action
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.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
718. PlanDefinition.action:routeAndSendEicr.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
720. PlanDefinition.action:routeAndSendEicr.relatedAction.actionId
Definition

The element id of the related action.

ShortWhat action is this related to
Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
722. PlanDefinition.action:routeAndSendEicr.relatedAction.relationship
Definition

The relationship of this action to the related action.

Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control1..1
BindingThe codes SHALL be taken from ActionRelationshipTypehttp://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1
(required to http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1)

Defines the types of relationships between actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
724. PlanDefinition.action:routeAndSendEicr.relatedAction.offset[x]
Definition

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

ShortTime offset for the relationship
Control0..1
TypeChoice of: Duration, Range
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action.relatedAction.offset[x]. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this
726. PlanDefinition.action:routeAndSendEicr.relatedAction.offset[x]:offsetDuration
Slice NameoffsetDuration
Definition

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

ShortTime offset for the relationship
Control0..1
TypeDuration, Range
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
728. PlanDefinition.action:routeAndSendEicr.timing[x]
Definition

An optional value describing when the action should be performed.

ShortWhen the action should take place
Control0..1
TypeDuration, dateTime, Period, Timing, Range, Age
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
730. PlanDefinition.action:encounterModified
Slice NameencounterModified
Definition

Defines the "encounter-modified" action


An action or group of actions to be taken as part of the plan.

ShortEncounter modified codeAction defined by the plan
Comments

Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.

Control10..1*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
732. PlanDefinition.action:encounterModified.id
Definition

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

ShortUnique id for inter-element referencing
Control10..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "id" : "encounter-modified"
}
<id value="encounter-modified"/>
734. PlanDefinition.action:encounterModified.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
736. PlanDefinition.action:encounterModified.description
Definition

Description of the "encounter-modified" action.


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

ShortDescription of the "encounter-modified" action.Brief description of the action
Control10..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Value
{
  "description" : "This action represents the start of the reporting workflow in response to the encounter-modified event"
}
<description value="This action represents the start of the reporting workflow in response to the encounter-modified event"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
738. PlanDefinition.action:encounterModified.textEquivalent
Definition

Text equivalent of the "encounter-modified" action.


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 might not be capable of interpreting it dynamically.

ShortText equivalent of the "encounter-modified" action.Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
Control10..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Value
{
  "textEquivalent" : "Start the reporting workflow in response to an encounter-modified event"
}
<textEquivalent value="Start the reporting workflow in response to an encounter-modified event"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
740. PlanDefinition.action:encounterModified.code
Definition

The US-PH-PlanDefinition-Action code for the "encounter-modified" action.


A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode for the "encounter-modified" action.Code representing the meaning of the action or sub-actions
Control10..1*
BindingUnless not suitable, these codes SHALL be taken from For codes, see US Public Health ValueSet - PlanDefinition Action
(extensible to http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-plandefinition-action)

The set of actions that can be used to create plan definition

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "initiate-reporting-workflow"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="initiate-reporting-workflow"/>
  </coding>
</code>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
742. PlanDefinition.action:encounterModified.trigger
Definition

When the "encounter-modified" action should be triggered.


A description of when the action should be triggered.

ShortWhen the "encounter-modified" action should be triggered.When the action should be triggered
Control10..*
TypeTriggerDefinition
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
epd-1: The code value of the namedEventType SHALL be the same as the name element (name.supersetOf(extension('http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-named-eventtype-extension').value.coding.code))
744. PlanDefinition.action:encounterModified.trigger.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control10..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.trigger.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
746. PlanDefinition.action:encounterModified.trigger.extension:namedEventType
Slice NamenamedEventType
Definition

Indicates the types of named events to subscribe to from the EHR.

ShortIndicates the types of named events to subscribe to from the EHR.
Control1..1
TypeExtension(US Public Health Named Event Type Extension) (Extension Type: CodeableConcept)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
748. PlanDefinition.action:encounterModified.trigger.type
Definition

The type of triggering event.

Shortnamed-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Control1..1
BindingThe codes SHALL be taken from TriggerTypehttp://hl7.org/fhir/ValueSet/trigger-type|4.0.1
(required to http://hl7.org/fhir/ValueSet/trigger-type|4.0.1)

The type of trigger.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Value
{
  "type" : "named-event"
}
<type value="named-event"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
750. PlanDefinition.action:encounterModified.trigger.name
Definition

The name of the event, encounter-start in this case. For any action invoked as a result of this trigger, the triggering encounter is accessible via the context variable %encounter


A formal name for the event. This may be an absolute URI that identifies the event formally (e.g. from a trigger registry), or a simple relative URI that identifies the event in a local context.

ShortName or URI that identifies the event
Comments

An event name can be provided for all event types, but is required for named events. If a name is provided for a type other than named events, it is considered to be a shorthand for the semantics described by the formal description of the event.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Fixed Value
{
  "name" : "encounter-modified"
}
<name value="encounter-modified"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
752. PlanDefinition.action:encounterModified.condition
Definition

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

ShortWhether or not the action is applicable
Comments

When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
754. PlanDefinition.action:encounterModified.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
756. PlanDefinition.action:encounterModified.condition.kind
Definition

The kind of condition.

Shortapplicability | start | stop
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 enter/exit criteria for an action.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1
(required to http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1)

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
758. PlanDefinition.action:encounterModified.condition.expression
Definition

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

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
760. PlanDefinition.action:encounterModified.input
Definition

Defines input data requirements for the action.

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
762. PlanDefinition.action:encounterModified.input.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
764. PlanDefinition.action:encounterModified.input.extension:fhirquerypattern
Slice Namefhirquerypattern
Definition

A FHIR Query URL pattern that corresponds to the data specified by the data requirement. If multiple FHIR Query URLs are present, they each contribute to the data specified by the data requirement (i.e. the union of the results of the FHIR Queries represents the complete data for the data requirement). This is not a resolveable URL, in that it will contain 1) No base canonical (i.e. it's a relative query), and 2) Parameters using tokens that are delimited using double-braces and the context parameters are dependent solely on the subjectType, according to the following: Patient: context.patientId, Practitioner: context.practitionerId, Organization: context.organizationId, Location: context.locationId, Device: context.deviceId. For example, for a Library with a subjectType of Patient, the context parameter {{context.patientId}} will be used as a token to be replaced with the id of the Patient in context. This extension is used primarily to address the use case for satisfying a data requirement for a single subject. However, the query pattern could also be used to satisfy population level requests by removing the subject-level filter from the query.

ShortWhat FHIR query?
Comments

Supports communicating a FHIR query (or set of queries) for the given data requirement. The query is server-specific, and will need to be created as informed by a CapabilityStatement. The $data-requirements operation should be expected to be able to provide an Endpoint or CapabilityStatement to provide this information.; If no endpoint or capability statement is provided, the capability statement of the server performing the operation is used.

Control0..1
TypeExtension(FHIR Query Pattern) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
766. PlanDefinition.action:encounterModified.input.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1
(required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
768. PlanDefinition.action:encounterModified.output
Definition

Defines the outputs of the action, if any.

ShortOutput data definition
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
770. PlanDefinition.action:encounterModified.output.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1
(required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
772. PlanDefinition.action:encounterModified.relatedAction
Definition

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

ShortRelationship to another action
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.

Control10..1*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
774. PlanDefinition.action:encounterModified.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
776. PlanDefinition.action:encounterModified.relatedAction.actionId
Definition

The element id of the related action.

ShortWhat action is this related to
Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Value
{
  "actionId" : "is-modified-encounter-reportable"
}
<actionId value="is-modified-encounter-reportable"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
778. PlanDefinition.action:encounterModified.relatedAction.relationship
Definition

The relationship of this action to the related action.

Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control1..1
BindingThe codes SHALL be taken from ActionRelationshipTypehttp://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1
(required to http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1)

Defines the types of relationships between actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Value
{
  "relationship" : "before-start"
}
<relationship value="before-start"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
780. PlanDefinition.action:encounterModified.relatedAction.offset[x]
Definition

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

ShortTime offset for the relationship
Control0..1
TypeChoice of: Duration, Range
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action.relatedAction.offset[x]. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this
782. PlanDefinition.action:encounterModified.relatedAction.offset[x]:offsetDuration
Slice NameoffsetDuration
Definition

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

ShortTime offset for the relationship
Control0..1
TypeDuration, Range
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
784. PlanDefinition.action:encounterModified.timing[x]
Definition

An optional value describing when the action should be performed.

ShortWhen the action should take place
Control0..1
TypeDuration, dateTime, Period, Timing, Range, Age
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
786. PlanDefinition.action:isModifiedEncounterReportable
Slice NameisModifiedEncounterReportable
Definition

Checks a modified encounter against the trigger code value sets. Invoked by the "encounter-modified" action and, when reportable, invokes "create-eicr".


An action or group of actions to be taken as part of the plan.

ShortCheck a modified encounter for reportabilityAction defined by the plan
Comments

Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.

Control10..1*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
788. PlanDefinition.action:isModifiedEncounterReportable.id
Definition

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

ShortUnique id for inter-element referencing
Control10..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "id" : "is-modified-encounter-reportable"
}
<id value="is-modified-encounter-reportable"/>
790. PlanDefinition.action:isModifiedEncounterReportable.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
792. PlanDefinition.action:isModifiedEncounterReportable.description
Definition

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

ShortBrief description of the action
Control10..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
794. PlanDefinition.action:isModifiedEncounterReportable.code
Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control10..1*
BindingUnless not suitable, these codes SHALL be taken from For codes, see US Public Health ValueSet - PlanDefinition Action
(extensible to http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-plandefinition-action)

The set of actions that can be used to create plan definition

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "check-trigger-codes"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="check-trigger-codes"/>
  </coding>
</code>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
796. PlanDefinition.action:isModifiedEncounterReportable.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
798. PlanDefinition.action:isModifiedEncounterReportable.trigger.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control10..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.trigger.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
800. PlanDefinition.action:isModifiedEncounterReportable.trigger.extension:namedEventType
Slice NamenamedEventType
Definition

Indicates the types of named events to subscribe to from the EHR.

ShortUS Public Health Named Event Type Extension
Control1..1
TypeExtension(US Public Health Named Event Type Extension) (Extension Type: CodeableConcept)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
802. PlanDefinition.action:isModifiedEncounterReportable.trigger.type
Definition

The type of triggering event.

Shortnamed-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Control1..1
BindingThe codes SHALL be taken from TriggerTypehttp://hl7.org/fhir/ValueSet/trigger-type|4.0.1
(required to http://hl7.org/fhir/ValueSet/trigger-type|4.0.1)

The type of trigger.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Value
{
  "type" : "named-event"
}
<type value="named-event"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
804. PlanDefinition.action:isModifiedEncounterReportable.condition
Definition

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

ShortApplicability condition for the modified-encounter reportability check.Whether or not the action is applicable
Comments

When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.

Control10..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
806. PlanDefinition.action:isModifiedEncounterReportable.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
808. PlanDefinition.action:isModifiedEncounterReportable.condition.kind
Definition

The kind of condition.

Shortapplicability | start | stop
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 enter/exit criteria for an action.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1
(required to http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1)

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Value
{
  "kind" : "applicability"
}
<kind value="applicability"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
810. PlanDefinition.action:isModifiedEncounterReportable.condition.expression
Definition

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

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control10..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
812. PlanDefinition.action:isModifiedEncounterReportable.condition.expression.language
Definition

The media type of the language for the expression.

Shorttext/cql | text/fhirpath | application/x-fhir-query | etc.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from ExpressionLanguagehttp://hl7.org/fhir/ValueSet/expression-language|4.0.1
(extensible to http://hl7.org/fhir/ValueSet/expression-language|4.0.1)

The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Fixed Value
{
  "language" : "text/fhirpath"
}
<language value="text/fhirpath"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
814. PlanDefinition.action:isModifiedEncounterReportable.input
Definition

Defines input data requirements for the action.

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
816. PlanDefinition.action:isModifiedEncounterReportable.input.id
Definition

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

ShortUnique id for inter-element referencing
Control10..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
818. PlanDefinition.action:isModifiedEncounterReportable.input.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
820. PlanDefinition.action:isModifiedEncounterReportable.input.extension:fhirquerypattern
Slice Namefhirquerypattern
Definition

A FHIR Query URL pattern that corresponds to the data specified by the data requirement. If multiple FHIR Query URLs are present, they each contribute to the data specified by the data requirement (i.e. the union of the results of the FHIR Queries represents the complete data for the data requirement). This is not a resolveable URL, in that it will contain 1) No base canonical (i.e. it's a relative query), and 2) Parameters using tokens that are delimited using double-braces and the context parameters are dependent solely on the subjectType, according to the following: Patient: context.patientId, Practitioner: context.practitionerId, Organization: context.organizationId, Location: context.locationId, Device: context.deviceId. For example, for a Library with a subjectType of Patient, the context parameter {{context.patientId}} will be used as a token to be replaced with the id of the Patient in context. This extension is used primarily to address the use case for satisfying a data requirement for a single subject. However, the query pattern could also be used to satisfy population level requests by removing the subject-level filter from the query.

ShortWhat FHIR query?
Comments

Supports communicating a FHIR query (or set of queries) for the given data requirement. The query is server-specific, and will need to be created as informed by a CapabilityStatement. The $data-requirements operation should be expected to be able to provide an Endpoint or CapabilityStatement to provide this information.; If no endpoint or capability statement is provided, the capability statement of the server performing the operation is used.

Control0..1
TypeExtension(FHIR Query Pattern) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
822. PlanDefinition.action:isModifiedEncounterReportable.input.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1
(required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
824. PlanDefinition.action:isModifiedEncounterReportable.output
Definition

Defines the outputs of the action, if any.

ShortOutput data definition
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
826. PlanDefinition.action:isModifiedEncounterReportable.output.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1
(required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
828. PlanDefinition.action:isModifiedEncounterReportable.relatedAction
Definition

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

ShortRelationship to another action
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.

Control10..1*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
830. PlanDefinition.action:isModifiedEncounterReportable.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
832. PlanDefinition.action:isModifiedEncounterReportable.relatedAction.actionId
Definition

The element id of the related action.

ShortWhat action is this related to
Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Value
{
  "actionId" : "create-eicr"
}
<actionId value="create-eicr"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
834. PlanDefinition.action:isModifiedEncounterReportable.relatedAction.relationship
Definition

The relationship of this action to the related action.

Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control1..1
BindingThe codes SHALL be taken from ActionRelationshipTypehttp://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1
(required to http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1)

Defines the types of relationships between actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Value
{
  "relationship" : "before-start"
}
<relationship value="before-start"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
836. PlanDefinition.action:isModifiedEncounterReportable.relatedAction.offset[x]
Definition

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

ShortTime offset for the relationship
Control0..1
TypeChoice of: Duration, Range
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action.relatedAction.offset[x]. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this
838. PlanDefinition.action:isModifiedEncounterReportable.relatedAction.offset[x]:offsetDuration
Slice NameoffsetDuration
Definition

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

ShortTime offset for the relationship
Control0..1
TypeDuration, Range
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
840. PlanDefinition.action:isModifiedEncounterReportable.timing[x]
Definition

An optional value describing when the action should be performed.

ShortWhen the action should take place
Control0..1
TypeDuration, dateTime, Period, Timing, Range, Age
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

See the documentation on how to interpret the contents of this table

0. PlanDefinition
Definition

Defines the logic and rules around determining: whether or not a condition is reportable to public health, which jurisdiction(s) is/are responsible, which jurisdiction(s) need to be notified, and if the condition is reportable, gives timing information, next steps and condition information to the clinician.

ShorteRSD - electronic Reporting and Surveillance Distribution
2. PlanDefinition.extension
Definition

Defines variables for the PlanDefinition.

Must Supporttrue
4. PlanDefinition.extension:variable
Slice Namevariable
ShortDefines variables for the PlanDefinition.
Control0..*
TypeExtension(Variable) (Extension Type: Expression)
Must Supporttrue
6. PlanDefinition.effectivePeriod
Definition

The period during which this specification is expected to be in use. The start date indicates when the specification takes effect.

ShortWhen the eRSD specification is expected to be in use.
8. PlanDefinition.relatedArtifact
Control1..?
Must Supporttrue
SlicingThis element introduces a set of slices on PlanDefinition.relatedArtifact. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

10. PlanDefinition.relatedArtifact:triggeringValueSetLibrary
Slice NametriggeringValueSetLibrary
Definition

A dependency on the Reportable Conditions Trigger Codes (RCTC) value set library. The reference SHOULD be version-pinned, so that it is unambiguous which trigger code content this specification was authored against.

ShortThe RCTC value set library this specification was authored against.
Control1..1
Must Supporttrue
12. PlanDefinition.relatedArtifact:triggeringValueSetLibrary.type
Fixed Value
{
  "type" : "depends-on"
}
<type value="depends-on"/>
14. PlanDefinition.relatedArtifact:triggeringValueSetLibrary.resource
Control1..?
Must Supporttrue
16. PlanDefinition.action
Control8..?
SlicingThis element introduces a set of slices on PlanDefinition.action. The slices are Ordered and Open, and can be differentiated using the following discriminators:
  • value @ id

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

18. PlanDefinition.action.input
20. PlanDefinition.action.input.extension
Definition

Defines extensions for the action.

Must Supporttrue
22. PlanDefinition.action.input.extension:fhirquerypattern
Slice Namefhirquerypattern
Control0..1
TypeExtension(FHIR Query Pattern) (Extension Type: string)
Must Supporttrue
24. PlanDefinition.action.input.extension:fhirquerypattern.url
Must Supporttrue
26. PlanDefinition.action.relatedAction
28. PlanDefinition.action.relatedAction.offset[x]:offsetDuration
Slice NameoffsetDuration
Definition

The duration quantity may include a comparator, indicating how the offset should be applied. For example, <= 1 hour, meaning that the offset should be no more than 1 hour. This allows systems flexibility in scheduling the actions to isolate reporting activities to off hours.

TypeDuration
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
30. PlanDefinition.action:encounterStart
Slice NameencounterStart
Definition

Defines the "start" action

ShortEncounter start code
Control1..1
Must Supporttrue
32. PlanDefinition.action:encounterStart.id
Control1..?
Must Supporttrue
Fixed Value
{
  "id" : "start-workflow"
}
<id value="start-workflow"/>
34. PlanDefinition.action:encounterStart.description
Definition

Description of the "start" action.

ShortDescription of the "start" action.
Control1..?
Fixed Value
{
  "description" : "This action represents the start of the reporting workflow in response to the encounter-start event."
}
<description value="This action represents the start of the reporting workflow in response to the encounter-start event."/>
36. PlanDefinition.action:encounterStart.textEquivalent
Definition

Text equivalent of the "start" action.

ShortText equivalent of the "start" action.
Control1..?
Must Supporttrue
Fixed Value
{
  "textEquivalent" : "Start the reporting workflow in response to an encounter-start event"
}
<textEquivalent value="Start the reporting workflow in response to an encounter-start event"/>
38. PlanDefinition.action:encounterStart.code
Definition

The US-PH-PlanDefinition-Action code for the "start" action.

ShortCode for the "start" action.
Control1..?
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "initiate-reporting-workflow"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="initiate-reporting-workflow"/>
  </coding>
</code>
40. PlanDefinition.action:encounterStart.trigger
Definition

When the "start" action should be triggered.

ShortWhen the "start" action should be triggered.
Control1..?
Invariantsepd-1: The code value of the namedEventType SHALL be the same as the name element (name.supersetOf(extension('http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-named-eventtype-extension').value.coding.code))
42. PlanDefinition.action:encounterStart.trigger.extension:namedEventType
Slice NamenamedEventType
ShortIndicates the types of named events to subscribe to from the EHR.
44. PlanDefinition.action:encounterStart.trigger.name
Definition

The name of the event, encounter-start in this case. For any action invoked as a result of this trigger, the triggering encounter is accessible via the context variable %encounter

Fixed Value
{
  "name" : "encounter-start"
}
<name value="encounter-start"/>
46. PlanDefinition.action:encounterStart.input
48. PlanDefinition.action:encounterStart.input.extension:fhirquerypattern
Slice Namefhirquerypattern
Control0..1
TypeExtension(FHIR Query Pattern) (Extension Type: string)
Must Supporttrue
50. PlanDefinition.action:encounterStart.relatedAction
Control1..1
52. PlanDefinition.action:encounterStart.relatedAction.actionId
Fixed Value
{
  "actionId" : "check-for-immediate-reporting"
}
<actionId value="check-for-immediate-reporting"/>
54. PlanDefinition.action:encounterStart.relatedAction.relationship
Fixed Value
{
  "relationship" : "before-start"
}
<relationship value="before-start"/>
56. PlanDefinition.action:encounterStart.relatedAction.offset[x]:offsetDuration
Slice NameoffsetDuration
TypeDuration
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
ExampleWait 1 hour before next action.: { "value" : 1, "unit" : "h" }
58. PlanDefinition.action:checkForImmediateReporting
Slice NamecheckForImmediateReporting
Definition

Defines the "check-for-immediate-reporting" action, which checks for immediately reportable evidence and schedules the subsequent reportability checks.

ShortCheck for immediate reporting
Control1..1
Must Supporttrue
60. PlanDefinition.action:checkForImmediateReporting.id
Control1..?
Must Supporttrue
Fixed Value
{
  "id" : "check-for-immediate-reporting"
}
<id value="check-for-immediate-reporting"/>
62. PlanDefinition.action:checkForImmediateReporting.description
Definition

Description of the check for immediate reporting action.

ShortDescription of the check for immediate reporting action.
Control1..?
Fixed Value
{
  "description" : "This action represents the start of the check suspected disorder reporting workflow in response to the encounter-start event."
}
<description value="This action represents the start of the check suspected disorder reporting workflow in response to the encounter-start event."/>
64. PlanDefinition.action:checkForImmediateReporting.code
Definition

The US-PH-PlanDefinition-Action code for the "check-for-immediate-reporting" action.

ShortCode for the "check-for-immediate-reporting" action.
Control1..?
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "execute-reporting-workflow"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="execute-reporting-workflow"/>
  </coding>
</code>
66. PlanDefinition.action:checkForImmediateReporting.input
68. PlanDefinition.action:checkForImmediateReporting.input.extension:fhirquerypattern
Slice Namefhirquerypattern
Control0..1
TypeExtension(FHIR Query Pattern) (Extension Type: string)
Must Supporttrue
70. PlanDefinition.action:checkForImmediateReporting.action
Control4..?
SlicingThis element introduces a set of slices on PlanDefinition.action.action. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ id
72. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable
Slice NameisEncounterImmediatelyReportable
Control1..1
TypeBackboneElement
Must Supporttrue
74. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.id
Control1..?
Must Supporttrue
Fixed Value
{
  "id" : "is-encounter-immediately-reportable"
}
<id value="is-encounter-immediately-reportable"/>
76. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.code
Control1..?
Must Supporttrue
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "check-trigger-codes"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="check-trigger-codes"/>
  </coding>
</code>
78. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.condition
Must Supporttrue
80. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.condition.kind
Fixed Value
{
  "kind" : "applicability"
}
<kind value="applicability"/>
82. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.condition.expression
Control1..?
Must Supporttrue
84. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.condition.expression.language
Fixed Value
{
  "language" : "text/fhirpath"
}
<language value="text/fhirpath"/>
86. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.input
Definition

Defines input data requirements for the action. Required data is accessible via a context variable named '%[id]' using the 'id' of the input data requirement

Must Supporttrue
88. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.input.id
Definition

The id of the input requirement, allowing the data to be referenced via a context variable named '%[id]'

Control1..?
Must Supporttrue
90. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.relatedAction
92. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.relatedAction.actionId
Fixed Value
{
  "actionId" : "create-eicr"
}
<actionId value="create-eicr"/>
94. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.relatedAction.relationship
Fixed Value
{
  "relationship" : "before-start"
}
<relationship value="before-start"/>
96. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable
Slice NamecontinueCheckReportable
Control1..1
TypeBackboneElement
Must Supporttrue
98. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.id
Control1..?
Must Supporttrue
Fixed Value
{
  "id" : "continue-check-reportable"
}
<id value="continue-check-reportable"/>
100. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.code
Control1..?
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "evaluate-condition"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="evaluate-condition"/>
  </coding>
</code>
102. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.condition
104. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.condition.kind
Fixed Value
{
  "kind" : "applicability"
}
<kind value="applicability"/>
106. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.condition.expression
Control1..?
Must Supporttrue
108. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.condition.expression.language
Fixed Value
{
  "language" : "text/fhirpath"
}
<language value="text/fhirpath"/>
110. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.relatedAction
112. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.relatedAction.actionId
Fixed Value
{
  "actionId" : "check-reportable"
}
<actionId value="check-reportable"/>
114. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.relatedAction.relationship
Fixed Value
{
  "relationship" : "before-start"
}
<relationship value="before-start"/>
116. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.relatedAction.offset[x]
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
SlicingThis element introduces a set of slices on PlanDefinition.action.action.relatedAction.offset[x]. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this

Slicing Note: Other type slices that contain no new information are not shown in this view

118. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.relatedAction.offset[x]:offsetDuration
Slice NameoffsetDuration
Control0..1
TypeDuration
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
ExampleWait 6 hours before next action.: { "value" : 6, "unit" : "h" }
120. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter
Slice NameterminateLateEncounter
Definition

Terminates the reporting workflow for an encounter that is still in progress beyond the normal reporting duration, or that ended more than the post-encounter grace period ago.

ShortTerminate a late encounter
Control1..1
TypeBackboneElement
Must Supporttrue
122. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.id
Control1..?
Must Supporttrue
Fixed Value
{
  "id" : "terminate-late-encounter"
}
<id value="terminate-late-encounter"/>
124. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.code
Control1..?
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "terminate-reporting-workflow"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="terminate-reporting-workflow"/>
  </coding>
</code>
126. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.condition
Must Supporttrue
128. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.condition.kind
Fixed Value
{
  "kind" : "applicability"
}
<kind value="applicability"/>
130. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.condition.expression
Control1..?
Must Supporttrue
132. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.condition.expression.language
Fixed Value
{
  "language" : "text/fhirpath"
}
<language value="text/fhirpath"/>
134. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted
Slice NameisLateEncounterCompleted
Definition

Records completion of reporting for an encounter that finished after its reporting window had elapsed. Ambulatory encounters use the ambulatory reporting duration; inpatient encounters use the normal reporting duration.

ShortLate encounter completed
Control1..1
TypeBackboneElement
Must Supporttrue
136. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.id
Control1..?
Must Supporttrue
Fixed Value
{
  "id" : "is-late-encounter-completed"
}
<id value="is-late-encounter-completed"/>
138. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.code
Control1..?
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "complete-reporting"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="complete-reporting"/>
  </coding>
</code>
140. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.condition
Must Supporttrue
142. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.condition.kind
Fixed Value
{
  "kind" : "applicability"
}
<kind value="applicability"/>
144. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.condition.expression
Control1..?
Must Supporttrue
146. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.condition.expression.language
Fixed Value
{
  "language" : "text/fhirpath"
}
<language value="text/fhirpath"/>
148. PlanDefinition.action:checkReportable
Slice NamecheckReportable
Definition

Defines the checking of the encounter for reportability.

ShortCheck the encounter for reportability
Control1..1
Must Supporttrue
150. PlanDefinition.action:checkReportable.id
Control1..?
Must Supporttrue
Fixed Value
{
  "id" : "check-reportable"
}
<id value="check-reportable"/>
152. PlanDefinition.action:checkReportable.description
Definition

Description of the Periodic Update of eICR action within the eICR action.

ShortDescription of the Periodic Update of eICR action.
Fixed Value
{
  "description" : "This action represents the check for suspected reportability of the eICR."
}
<description value="This action represents the check for suspected reportability of the eICR."/>
154. PlanDefinition.action:checkReportable.code
Control1..?
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "execute-reporting-workflow"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="execute-reporting-workflow"/>
  </coding>
</code>
156. PlanDefinition.action:checkReportable.input
158. PlanDefinition.action:checkReportable.input.extension:fhirquerypattern
Slice Namefhirquerypattern
Control0..1
TypeExtension(FHIR Query Pattern) (Extension Type: string)
Must Supporttrue
160. PlanDefinition.action:checkReportable.action
Control7..?
SlicingThis element introduces a set of slices on PlanDefinition.action.action. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ id
162. PlanDefinition.action:checkReportable.action:isEncounterReportable
Slice NameisEncounterReportable
Control1..1
TypeBackboneElement
Must Supporttrue
164. PlanDefinition.action:checkReportable.action:isEncounterReportable.id
Control1..?
Must Supporttrue
Fixed Value
{
  "id" : "is-encounter-reportable"
}
<id value="is-encounter-reportable"/>
166. PlanDefinition.action:checkReportable.action:isEncounterReportable.code
Control1..?
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "check-trigger-codes"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="check-trigger-codes"/>
  </coding>
</code>
168. PlanDefinition.action:checkReportable.action:isEncounterReportable.condition
170. PlanDefinition.action:checkReportable.action:isEncounterReportable.condition.kind
Fixed Value
{
  "kind" : "applicability"
}
<kind value="applicability"/>
172. PlanDefinition.action:checkReportable.action:isEncounterReportable.condition.expression
Control1..?
Must Supporttrue
174. PlanDefinition.action:checkReportable.action:isEncounterReportable.condition.expression.language
Fixed Value
{
  "language" : "text/fhirpath"
}
<language value="text/fhirpath"/>
176. PlanDefinition.action:checkReportable.action:isEncounterReportable.input
Definition

Defines input data requirements for the action. Required data is accessible via a context variable named %[id] using the id of the input data requirement

Must Supporttrue
178. PlanDefinition.action:checkReportable.action:isEncounterReportable.input.id
Definition

The id of the input requirement, allowing the data to be referenced via a context variable named %[id]

Control1..?
Must Supporttrue
180. PlanDefinition.action:checkReportable.action:isEncounterReportable.relatedAction
182. PlanDefinition.action:checkReportable.action:isEncounterReportable.relatedAction.actionId
Fixed Value
{
  "actionId" : "create-eicr"
}
<actionId value="create-eicr"/>
184. PlanDefinition.action:checkReportable.action:isEncounterReportable.relatedAction.relationship
Fixed Value
{
  "relationship" : "before-start"
}
<relationship value="before-start"/>
186. PlanDefinition.action:checkReportable.action:checkUpdateEicr
Slice NamecheckUpdateEicr
Control1..1
TypeBackboneElement
Must Supporttrue
188. PlanDefinition.action:checkReportable.action:checkUpdateEicr.id
Control1..?
Must Supporttrue
Fixed Value
{
  "id" : "check-update-eicr"
}
<id value="check-update-eicr"/>
190. PlanDefinition.action:checkReportable.action:checkUpdateEicr.code
Control1..?
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "evaluate-condition"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="evaluate-condition"/>
  </coding>
</code>
192. PlanDefinition.action:checkReportable.action:checkUpdateEicr.condition
194. PlanDefinition.action:checkReportable.action:checkUpdateEicr.condition.kind
Fixed Value
{
  "kind" : "applicability"
}
<kind value="applicability"/>
196. PlanDefinition.action:checkReportable.action:checkUpdateEicr.condition.expression
Control1..?
Must Supporttrue
198. PlanDefinition.action:checkReportable.action:checkUpdateEicr.condition.expression.language
Fixed Value
{
  "language" : "text/fhirpath"
}
<language value="text/fhirpath"/>
200. PlanDefinition.action:checkReportable.action:checkUpdateEicr.relatedAction
202. PlanDefinition.action:checkReportable.action:checkUpdateEicr.relatedAction.actionId
Fixed Value
{
  "actionId" : "create-eicr"
}
<actionId value="create-eicr"/>
204. PlanDefinition.action:checkReportable.action:checkUpdateEicr.relatedAction.relationship
Fixed Value
{
  "relationship" : "before-start"
}
<relationship value="before-start"/>
206. PlanDefinition.action:checkReportable.action:encounterInProgress
Slice NameencounterInProgress
Control1..1
TypeBackboneElement
Must Supporttrue
208. PlanDefinition.action:checkReportable.action:encounterInProgress.id
Control1..?
Must Supporttrue
Fixed Value
{
  "id" : "is-encounter-in-progress"
}
<id value="is-encounter-in-progress"/>
210. PlanDefinition.action:checkReportable.action:encounterInProgress.code
Control1..?
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "evaluate-condition"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="evaluate-condition"/>
  </coding>
</code>
212. PlanDefinition.action:checkReportable.action:encounterInProgress.condition
214. PlanDefinition.action:checkReportable.action:encounterInProgress.condition.kind
Fixed Value
{
  "kind" : "applicability"
}
<kind value="applicability"/>
216. PlanDefinition.action:checkReportable.action:encounterInProgress.condition.expression
Control1..?
Must Supporttrue
218. PlanDefinition.action:checkReportable.action:encounterInProgress.condition.expression.language
Fixed Value
{
  "language" : "text/fhirpath"
}
<language value="text/fhirpath"/>
220. PlanDefinition.action:checkReportable.action:encounterInProgress.relatedAction
222. PlanDefinition.action:checkReportable.action:encounterInProgress.relatedAction.actionId
Fixed Value
{
  "actionId" : "check-reportable"
}
<actionId value="check-reportable"/>
224. PlanDefinition.action:checkReportable.action:encounterInProgress.relatedAction.relationship
Fixed Value
{
  "relationship" : "before-start"
}
<relationship value="before-start"/>
226. PlanDefinition.action:checkReportable.action:encounterInProgress.relatedAction.offset[x]
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
SlicingThis element introduces a set of slices on PlanDefinition.action.action.relatedAction.offset[x]. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this

Slicing Note: Other type slices that contain no new information are not shown in this view

228. PlanDefinition.action:checkReportable.action:encounterInProgress.relatedAction.offset[x]:offsetDuration
Slice NameoffsetDuration
Control0..1
TypeDuration
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
ExampleWait 6 hours before next action.: { "value" : 6, "unit" : "h" }
230. PlanDefinition.action:checkReportable.action:ambEncounterInProgress
Slice NameambEncounterInProgress
Definition

Continues the reportability check loop for an ambulatory encounter that is still in progress and within the ambulatory reporting duration.

ShortAmbulatory encounter in progress
Control1..1
TypeBackboneElement
Must Supporttrue
232. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.id
Control1..?
Must Supporttrue
Fixed Value
{
  "id" : "is-amb-encounter-in-progress"
}
<id value="is-amb-encounter-in-progress"/>
234. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.code
Control1..?
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "evaluate-condition"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="evaluate-condition"/>
  </coding>
</code>
236. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.condition
Must Supporttrue
238. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.condition.kind
Fixed Value
{
  "kind" : "applicability"
}
<kind value="applicability"/>
240. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.condition.expression
Control1..?
Must Supporttrue
242. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.condition.expression.language
Fixed Value
{
  "language" : "text/fhirpath"
}
<language value="text/fhirpath"/>
244. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.relatedAction
246. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.relatedAction.actionId
Fixed Value
{
  "actionId" : "check-reportable"
}
<actionId value="check-reportable"/>
248. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.relatedAction.relationship
Fixed Value
{
  "relationship" : "before-start"
}
<relationship value="before-start"/>
250. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.relatedAction.offset[x]
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
SlicingThis element introduces a set of slices on PlanDefinition.action.action.relatedAction.offset[x]. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this

Slicing Note: Other type slices that contain no new information are not shown in this view

252. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.relatedAction.offset[x]:offsetDuration
Slice NameoffsetDuration
Control0..1
TypeDuration
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
254. PlanDefinition.action:checkReportable.action:terminateEncounter
Slice NameterminateEncounter
Definition

Terminates the reporting workflow for an inpatient, emergency or observation encounter that has passed the normal reporting duration or the post-encounter grace period.

ShortTerminate an inpatient encounter
Control1..1
TypeBackboneElement
Must Supporttrue
256. PlanDefinition.action:checkReportable.action:terminateEncounter.id
Control1..?
Must Supporttrue
Fixed Value
{
  "id" : "terminate-encounter"
}
<id value="terminate-encounter"/>
258. PlanDefinition.action:checkReportable.action:terminateEncounter.code
Control1..?
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "terminate-reporting-workflow"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="terminate-reporting-workflow"/>
  </coding>
</code>
260. PlanDefinition.action:checkReportable.action:terminateEncounter.condition
Must Supporttrue
262. PlanDefinition.action:checkReportable.action:terminateEncounter.condition.kind
Fixed Value
{
  "kind" : "applicability"
}
<kind value="applicability"/>
264. PlanDefinition.action:checkReportable.action:terminateEncounter.condition.expression
Control1..?
Must Supporttrue
266. PlanDefinition.action:checkReportable.action:terminateEncounter.condition.expression.language
Fixed Value
{
  "language" : "text/fhirpath"
}
<language value="text/fhirpath"/>
268. PlanDefinition.action:checkReportable.action:terminateAmbEncounter
Slice NameterminateAmbEncounter
Definition

Terminates the reporting workflow for an ambulatory, virtual or home health encounter that has passed the ambulatory reporting duration or the post-encounter grace period.

ShortTerminate an ambulatory encounter
Control1..1
TypeBackboneElement
Must Supporttrue
270. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.id
Control1..?
Must Supporttrue
Fixed Value
{
  "id" : "terminate-amb-encounter"
}
<id value="terminate-amb-encounter"/>
272. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.code
Control1..?
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "terminate-reporting-workflow"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="terminate-reporting-workflow"/>
  </coding>
</code>
274. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.condition
Must Supporttrue
276. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.condition.kind
Fixed Value
{
  "kind" : "applicability"
}
<kind value="applicability"/>
278. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.condition.expression
Control1..?
Must Supporttrue
280. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.condition.expression.language
Fixed Value
{
  "language" : "text/fhirpath"
}
<language value="text/fhirpath"/>
282. PlanDefinition.action:checkReportable.action:encounterComplete
Slice NameencounterComplete
Control1..1
TypeBackboneElement
Must Supporttrue
284. PlanDefinition.action:checkReportable.action:encounterComplete.id
Control1..?
Must Supporttrue
Fixed Value
{
  "id" : "is-encounter-completed"
}
<id value="is-encounter-completed"/>
286. PlanDefinition.action:checkReportable.action:encounterComplete.code
Control1..?
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "complete-reporting"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="complete-reporting"/>
  </coding>
</code>
288. PlanDefinition.action:checkReportable.action:encounterComplete.condition
290. PlanDefinition.action:checkReportable.action:encounterComplete.condition.kind
Fixed Value
{
  "kind" : "applicability"
}
<kind value="applicability"/>
292. PlanDefinition.action:checkReportable.action:encounterComplete.condition.expression
Control1..?
Must Supporttrue
294. PlanDefinition.action:checkReportable.action:encounterComplete.condition.expression.language
Fixed Value
{
  "language" : "text/fhirpath"
}
<language value="text/fhirpath"/>
296. PlanDefinition.action:createEicr
Slice NamecreateEicr
Definition

Defines the "create-eicr" action

ShortCreate the eICR
Control1..1
Must Supporttrue
298. PlanDefinition.action:createEicr.id
Control1..?
Must Supporttrue
Fixed Value
{
  "id" : "create-eicr"
}
<id value="create-eicr"/>
300. PlanDefinition.action:createEicr.description
Fixed Value
{
  "description" : "This action represents the creation of the eICR. It subsequently calls validate."
}
<description value="This action represents the creation of the eICR. It subsequently calls validate."/>
302. PlanDefinition.action:createEicr.code
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "create-report"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="create-report"/>
  </coding>
</code>
304. PlanDefinition.action:createEicr.input
306. PlanDefinition.action:createEicr.input.extension:fhirquerypattern
Slice Namefhirquerypattern
Control0..1
TypeExtension(FHIR Query Pattern) (Extension Type: string)
Must Supporttrue
308. PlanDefinition.action:createEicr.output
Definition

Defines the output of the action, the created eICR. The output is consumed as the input of the next action in the sequence.

ShortThe eICR document bundle produced by this action.
Control1..1
310. PlanDefinition.action:createEicr.output.id
Control1..?
Must Supporttrue
312. PlanDefinition.action:createEicr.output.type
Fixed Value
{
  "type" : "Bundle"
}
<type value="Bundle"/>
314. PlanDefinition.action:createEicr.output.profile
Control1..1
Must Supporttrue
Fixed Value
{
  "profile" : "http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle"
}
<profile value="http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle"/>
316. PlanDefinition.action:createEicr.relatedAction
Control1..1
318. PlanDefinition.action:createEicr.relatedAction.actionId
Fixed Value
{
  "actionId" : "validate-eicr"
}
<actionId value="validate-eicr"/>
320. PlanDefinition.action:createEicr.relatedAction.relationship
Fixed Value
{
  "relationship" : "before-start"
}
<relationship value="before-start"/>
322. PlanDefinition.action:validateEicr
Slice NamevalidateEicr
Definition

Defines the "validate-eicr" action

ShortValidate the eICR
Control1..1
Must Supporttrue
324. PlanDefinition.action:validateEicr.id
Control1..?
Must Supporttrue
Fixed Value
{
  "id" : "validate-eicr"
}
<id value="validate-eicr"/>
326. PlanDefinition.action:validateEicr.description
Fixed Value
{
  "description" : "This action represents the validation of the eICR. It subsequently calls route-and-send."
}
<description value="This action represents the validation of the eICR. It subsequently calls route-and-send."/>
328. PlanDefinition.action:validateEicr.code
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "validate-report"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="validate-report"/>
  </coding>
</code>
330. PlanDefinition.action:validateEicr.input
332. PlanDefinition.action:validateEicr.input.extension:fhirquerypattern
Slice Namefhirquerypattern
Control0..1
TypeExtension(FHIR Query Pattern) (Extension Type: string)
Must Supporttrue
334. PlanDefinition.action:validateEicr.output
Definition

Defines the output of the action, the validated eICR. The output is consumed as the input of the next action in the sequence.

ShortThe eICR document bundle produced by this action.
Control1..1
336. PlanDefinition.action:validateEicr.output.id
Control1..?
Must Supporttrue
338. PlanDefinition.action:validateEicr.output.type
Fixed Value
{
  "type" : "Bundle"
}
<type value="Bundle"/>
340. PlanDefinition.action:validateEicr.output.profile
Control1..1
Must Supporttrue
Fixed Value
{
  "profile" : "http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle"
}
<profile value="http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle"/>
342. PlanDefinition.action:validateEicr.relatedAction
Control1..1
344. PlanDefinition.action:validateEicr.relatedAction.actionId
Fixed Value
{
  "actionId" : "route-and-send-eicr"
}
<actionId value="route-and-send-eicr"/>
346. PlanDefinition.action:validateEicr.relatedAction.relationship
Fixed Value
{
  "relationship" : "before-start"
}
<relationship value="before-start"/>
348. PlanDefinition.action:routeAndSendEicr
Slice NamerouteAndSendEicr
Definition

Defines the routing and sending of the eICR.

ShortRoute and send eICR
Control1..1
Must Supporttrue
350. PlanDefinition.action:routeAndSendEicr.id
Control1..?
Must Supporttrue
Fixed Value
{
  "id" : "route-and-send-eicr"
}
<id value="route-and-send-eicr"/>
352. PlanDefinition.action:routeAndSendEicr.description
Definition

Description of the route and send action.

ShortDescription of the route and send action.
Control1..?
Fixed Value
{
  "description" : "This action represents the routing and sending of the eICR."
}
<description value="This action represents the routing and sending of the eICR."/>
354. PlanDefinition.action:routeAndSendEicr.textEquivalent
Control1..?
Must Supporttrue
Fixed Value
{
  "textEquivalent" : "Route and send eICR"
}
<textEquivalent value="Route and send eICR"/>
356. PlanDefinition.action:routeAndSendEicr.code
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "submit-report"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="submit-report"/>
  </coding>
</code>
358. PlanDefinition.action:routeAndSendEicr.input
360. PlanDefinition.action:routeAndSendEicr.input.extension:fhirquerypattern
Slice Namefhirquerypattern
Control0..1
TypeExtension(FHIR Query Pattern) (Extension Type: string)
Must Supporttrue
362. PlanDefinition.action:routeAndSendEicr.output
Definition

Defines the output of the action, the submitted eICR. The output is consumed as the input of the next action in the sequence.

ShortThe eICR document bundle produced by this action.
Control1..1
364. PlanDefinition.action:routeAndSendEicr.output.id
Control1..?
Must Supporttrue
366. PlanDefinition.action:routeAndSendEicr.output.type
Fixed Value
{
  "type" : "Bundle"
}
<type value="Bundle"/>
368. PlanDefinition.action:routeAndSendEicr.output.profile
Control1..1
Must Supporttrue
Fixed Value
{
  "profile" : "http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle"
}
<profile value="http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle"/>
370. PlanDefinition.action:encounterModified
Slice NameencounterModified
Definition

Defines the "encounter-modified" action

ShortEncounter modified code
Control1..1
Must Supporttrue
372. PlanDefinition.action:encounterModified.id
Control1..?
Must Supporttrue
Fixed Value
{
  "id" : "encounter-modified"
}
<id value="encounter-modified"/>
374. PlanDefinition.action:encounterModified.description
Definition

Description of the "encounter-modified" action.

ShortDescription of the "encounter-modified" action.
Control1..?
Fixed Value
{
  "description" : "This action represents the start of the reporting workflow in response to the encounter-modified event"
}
<description value="This action represents the start of the reporting workflow in response to the encounter-modified event"/>
376. PlanDefinition.action:encounterModified.textEquivalent
Definition

Text equivalent of the "encounter-modified" action.

ShortText equivalent of the "encounter-modified" action.
Control1..?
Must Supporttrue
Fixed Value
{
  "textEquivalent" : "Start the reporting workflow in response to an encounter-modified event"
}
<textEquivalent value="Start the reporting workflow in response to an encounter-modified event"/>
378. PlanDefinition.action:encounterModified.code
Definition

The US-PH-PlanDefinition-Action code for the "encounter-modified" action.

ShortCode for the "encounter-modified" action.
Control1..?
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "initiate-reporting-workflow"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="initiate-reporting-workflow"/>
  </coding>
</code>
380. PlanDefinition.action:encounterModified.trigger
Definition

When the "encounter-modified" action should be triggered.

ShortWhen the "encounter-modified" action should be triggered.
Control1..?
Invariantsepd-1: The code value of the namedEventType SHALL be the same as the name element (name.supersetOf(extension('http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-named-eventtype-extension').value.coding.code))
382. PlanDefinition.action:encounterModified.trigger.extension:namedEventType
Slice NamenamedEventType
ShortIndicates the types of named events to subscribe to from the EHR.
384. PlanDefinition.action:encounterModified.trigger.name
Definition

The name of the event, encounter-start in this case. For any action invoked as a result of this trigger, the triggering encounter is accessible via the context variable %encounter

Fixed Value
{
  "name" : "encounter-modified"
}
<name value="encounter-modified"/>
386. PlanDefinition.action:encounterModified.input
388. PlanDefinition.action:encounterModified.input.extension:fhirquerypattern
Slice Namefhirquerypattern
Control0..1
TypeExtension(FHIR Query Pattern) (Extension Type: string)
Must Supporttrue
390. PlanDefinition.action:encounterModified.relatedAction
Control1..1
392. PlanDefinition.action:encounterModified.relatedAction.actionId
Fixed Value
{
  "actionId" : "is-modified-encounter-reportable"
}
<actionId value="is-modified-encounter-reportable"/>
394. PlanDefinition.action:encounterModified.relatedAction.relationship
Fixed Value
{
  "relationship" : "before-start"
}
<relationship value="before-start"/>
396. PlanDefinition.action:isModifiedEncounterReportable
Slice NameisModifiedEncounterReportable
Definition

Checks a modified encounter against the trigger code value sets. Invoked by the "encounter-modified" action and, when reportable, invokes "create-eicr".

ShortCheck a modified encounter for reportability
Control1..1
Must Supporttrue
398. PlanDefinition.action:isModifiedEncounterReportable.id
Control1..?
Must Supporttrue
Fixed Value
{
  "id" : "is-modified-encounter-reportable"
}
<id value="is-modified-encounter-reportable"/>
400. PlanDefinition.action:isModifiedEncounterReportable.description
Control1..?
402. PlanDefinition.action:isModifiedEncounterReportable.code
Control1..?
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "check-trigger-codes"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="check-trigger-codes"/>
  </coding>
</code>
404. PlanDefinition.action:isModifiedEncounterReportable.condition
ShortApplicability condition for the modified-encounter reportability check.
Control1..?
406. PlanDefinition.action:isModifiedEncounterReportable.condition.kind
Fixed Value
{
  "kind" : "applicability"
}
<kind value="applicability"/>
408. PlanDefinition.action:isModifiedEncounterReportable.condition.expression
Control1..?
410. PlanDefinition.action:isModifiedEncounterReportable.condition.expression.language
Fixed Value
{
  "language" : "text/fhirpath"
}
<language value="text/fhirpath"/>
412. PlanDefinition.action:isModifiedEncounterReportable.input
414. PlanDefinition.action:isModifiedEncounterReportable.input.id
Control1..?
Must Supporttrue
416. PlanDefinition.action:isModifiedEncounterReportable.input.extension:fhirquerypattern
Slice Namefhirquerypattern
Control0..1
TypeExtension(FHIR Query Pattern) (Extension Type: string)
Must Supporttrue
418. PlanDefinition.action:isModifiedEncounterReportable.relatedAction
Control1..1
420. PlanDefinition.action:isModifiedEncounterReportable.relatedAction.actionId
Fixed Value
{
  "actionId" : "create-eicr"
}
<actionId value="create-eicr"/>
422. PlanDefinition.action:isModifiedEncounterReportable.relatedAction.relationship
Fixed Value
{
  "relationship" : "before-start"
}
<relationship value="before-start"/>

See the documentation on how to interpret the contents of this table

0. PlanDefinition
Definition

Defines the logic and rules around determining: whether or not a condition is reportable to public health, which jurisdiction(s) is/are responsible, which jurisdiction(s) need to be notified, and if the condition is reportable, gives timing information, next steps and condition information to the clinician.

ShorteRSD - electronic Reporting and Surveillance Distribution
Control1..1
Is Modifierfalse
Summaryfalse
Invariantsdom-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 or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
pdf-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.matches('[A-Z]([A-Za-z0-9_]){0,254}'))
2. PlanDefinition.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

ShortLogical id of this artifact
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Control0..1
Typeid
Is Modifierfalse
Summarytrue
4. PlanDefinition.meta
Definition

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.

ShortMetadata about the resource
Control0..1
TypeMeta
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. 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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
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. 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.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. PlanDefinition.language
Definition

The base language in which the resource is written.

ShortLanguage of the resource content
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).

Control0..1
BindingThe codes SHOULD be taken from CommonLanguages
(preferred to http://hl7.org/fhir/ValueSet/languages)

A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. PlanDefinition.text
Definition

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.

ShortText summary of the resource, for human interpretation
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 information is added later.

Control0..1
TypeNarrative
Is Modifierfalse
Summaryfalse
Alternate Namesnarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. PlanDefinition.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

ShortContained, inline Resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Control0..*
TypeResource
Is Modifierfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
14. PlanDefinition.extension
Definition

Defines variables for the PlanDefinition.

ShortExtension
Control0..*
TypeExtension
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

16. PlanDefinition.extension:knowledgeCapability
Slice NameknowledgeCapability
Definition

Defines a knowledge capability afforded by this knowledge artifact.

Shortshareable | computable | publishable | executable
Control0..*
TypeExtension(CQF Knowledge capability) (Extension Type: code)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
18. PlanDefinition.extension:artifactComment
Slice NameartifactComment
Definition

A comment containing additional documentation, a review comment, usage guidance, or other relevant information from a particular user.

ShortAdditional documentation, review, or usage guidance
Control0..*
TypeExtension(Artifact Comment) (Complex Extension)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
20. PlanDefinition.extension:versionAlgorithm
Slice NameversionAlgorithm
Definition

Indicates the mechanism used to compare versions to determine which is more current.

ShortHow to compare versions
Comments

If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.

Control0..1
TypeExtension(Artifact Version Algorithm) (Extension Type: Choice of: string, Coding)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
22. PlanDefinition.extension:versionPolicy
Slice NameversionPolicy
Definition

Defines the versioning policy of the artifact.

Shortmetadata | strict
Control0..1
TypeExtension(Artifact Version Policy) (Extension Type: CodeableConcept)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
24. PlanDefinition.extension:receiverAddress
Slice NamereceiverAddress
Definition

Indicates the address where the report has to be sent.

ShortIndicates the address where the report has to be sent.
Control0..1
TypeExtension(US Public Health Receiver Address Extension) (Extension Type: Reference(Endpoint))
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
26. PlanDefinition.extension:asyncIndicator
Slice NameasyncIndicator
Definition

This Extension profile represents the expectation of whether messages resulting from the PlanDefinition are expected to be processed asynchronously.

ShortUS Public Health Async Indicator Extension
Control0..1
TypeExtension(US Public Health Async Indicator Extension) (Extension Type: boolean)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
28. PlanDefinition.extension:contentEncrypted
Slice NamecontentEncrypted
Definition

Indicates whether the data in the content bundle is encrypted or not.

ShortUS Public Health Data Encrypted Extension
Control0..1
TypeExtension(US Public Health Data Encrypted Extension) (Extension Type: boolean)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
30. PlanDefinition.extension:jwksForContentEncryption
Slice NamejwksForContentEncryption
Definition

This Extension profile indicates the location of the public key that needs to be used for encryption when sending data to the receiver.

ShortUS Public Health Receiver Jwks Url
Control0..1
TypeExtension(US Public Health Receiver JWKS Url Extension) (Extension Type: url)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
32. PlanDefinition.extension:contentEncryptionAlgorithm
Slice NamecontentEncryptionAlgorithm
Definition

This Extension profile represents algorithms that would be acceptable for encryption of the data prior to submitting to the data receiver.

ShortUS Public Health Data Encryption Algorithm
Control0..1
TypeExtension(US Public Health Data Encryption Algorithm Extension) (Extension Type: code)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
34. PlanDefinition.extension:expectedResponseDuration
Slice NameexpectedResponseDuration
Definition

This Extension profile represents the maximum time the sender has to wait to get a response, beyond which the message is assumed to have failed to reach the destination.

ShortUS Public Health Expected Response Time Extension
Control0..1
TypeExtension(US Public Health Expected Response Time Extension) (Extension Type: Duration)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
36. PlanDefinition.extension:variable
Slice Namevariable
Definition

Variable specifying a logic to generate a variable for use in subsequent logic. The name of the variable will be added to FHIRPath's context when processing descendants of the element that contains this extension as well as extensions within the same element.

ShortDefines variables for the PlanDefinition.
Comments

Ordering of variable extension declarations is significant as variables declared in one repetition of this extension might be used in subsequent extension repetitions

​For questionnaires, see additional guidance and examples in the SDC implementation guide.

Control0..*
TypeExtension(Variable) (Extension Type: Expression)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
38. PlanDefinition.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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).

ShortExtensions that cannot be ignored
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summaryfalse
Requirements

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.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
40. PlanDefinition.url
Definition

An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance; 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.

ShortCanonical identifier for this plan definition, represented as a URI (globally unique)
Comments

Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

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.

Control1..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. PlanDefinition.identifier
Definition

A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance.

ShortAdditional identifier for the plan definition
Comments

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.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Is Modifierfalse
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. PlanDefinition.version
Definition

The identifier that is used to identify this version of the plan definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the plan definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.

ShortBusiness version of the plan definition
Comments

There may be different plan definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the plan definition with the format [url]|[version].

NoteThis is a business version Id, not a resource version Id (see discussion)
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. 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.

ShortName for this plan definition (computer friendly)
Comments

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.

Control1..1
This element is affected by the following invariants: inv-0
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Support human navigation and code generation.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. PlanDefinition.title
Definition

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

ShortName for this plan definition (human friendly)
Comments

This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. PlanDefinition.subtitle
Definition

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

ShortSubordinate title of the plan definition
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. PlanDefinition.type
Definition

Type of this PlanDefinition

ShortType of this PlanDefinition
Control1..1
BindingUnless not suitable, these codes SHALL be taken from PlanDefinitionType
(extensible to http://hl7.org/fhir/ValueSet/plan-definition-type)

The type of PlanDefinition.

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/plan-definition-type",
      "code" : "workflow-definition",
      "display" : "Workflow Definition"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/plan-definition-type"/>
    <code value="workflow-definition"/>
    <display value="Workflow Definition"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. PlanDefinition.status
Definition

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

Shortdraft | active | retired | unknown
Comments

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

Control1..1
BindingThe codes SHALL be taken from PublicationStatus
(required to http://hl7.org/fhir/ValueSet/publication-status|4.0.1)

The lifecycle status of an artifact.

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
56. PlanDefinition.experimental
Definition

A Boolean value to indicate that this plan definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

ShortFor testing purposes, not real usage
Comments

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

Control0..1
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
58. PlanDefinition.subject[x]
Definition

A code or group definition that describes the intended subject of the plan definition.

ShortType of individual the plan definition is focused on
Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType
(extensible to http://hl7.org/fhir/ValueSet/subject-type)

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

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
Summaryfalse
Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
60. PlanDefinition.date
Definition

Date the PlanDefinition was last changed

ShortDate the PlanDefinition was last changed
Comments

Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the plan definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

Control1..1
TypedateTime
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Alternate NamesRevision Date
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
62. PlanDefinition.publisher
Definition

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

ShortName of the publisher (organization or individual)
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.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
64. PlanDefinition.contact
Definition

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

ShortContact details for the publisher
Comments

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

Control0..*
TypeContactDetail
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
66. PlanDefinition.description
Definition

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

ShortNatural language description of the plan definition
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 plan definition is presumed to be the predominant language in the place the plan definition was created).

Control1..1
Typemarkdown
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
68. PlanDefinition.useContext
Definition

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.

ShortThe context that the content is intended to support
Comments

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

Control0..*
TypeUsageContext
Is Modifierfalse
Summarytrue
Requirements

Assist in searching for appropriate content.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
70. PlanDefinition.jurisdiction
Definition

A legal or geographic region in which the plan definition is intended to be used.

ShortIntended jurisdiction for plan definition (if applicable)
Comments

It may be possible for the plan definition to be used in jurisdictions other than those for which it was originally designed or intended.

Control0..*
BindingUnless not suitable, these codes SHALL be taken from Jurisdiction ValueSet
(extensible to http://hl7.org/fhir/ValueSet/jurisdiction)

Countries and regions within which this artifact is targeted for use.

TypeCodeableConcept
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
72. PlanDefinition.purpose
Definition

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

ShortWhy this plan definition is defined
Comments

This element does not describe the usage of the plan definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this plan definition.

Control0..1
Typemarkdown
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
74. PlanDefinition.usage
Definition

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

ShortDescribes the clinical usage of the plan
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
76. 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.

ShortUse and/or publishing restrictions
Control0..1
Typemarkdown
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Requirements

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

Alternate NamesLicense, Restrictions
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
78. PlanDefinition.approvalDate
Definition

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

ShortWhen the plan definition was approved by publisher
Comments

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

Control0..1
Typedate
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
80. PlanDefinition.lastReviewDate
Definition

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

ShortWhen the plan definition was last reviewed
Comments

If specified, this date follows the original approval date.

Control0..1
Typedate
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Requirements

Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
82. PlanDefinition.effectivePeriod
Definition

The period during which this specification is expected to be in use. The start date indicates when the specification takes effect.

ShortWhen the eRSD specification is expected to be in use.
Comments

The effective period for a plan definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.

Control0..1
TypePeriod
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

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.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
84. PlanDefinition.effectivePeriod.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
86. PlanDefinition.effectivePeriod.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.effectivePeriod.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
88. PlanDefinition.effectivePeriod.start
Definition

The start of the time period when this PlanDefinition goes into effect

ShortThe start of the time period when this PlanDefinition goes into effect
Comments

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

Control1..1
This element is affected by the following invariants: per-1
TypedateTime
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
90. PlanDefinition.effectivePeriod.end
Definition

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.

ShortEnd time with inclusive boundary, if not ongoing
Comments

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.

Control0..1
This element is affected by the following invariants: per-1
TypedateTime
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Meaning if MissingIf the end of the period is missing, it means that the period is ongoing
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
92. 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.

ShortE.g. Education, Treatment, Assessment
Control0..*
BindingFor example codes, see DefinitionTopic
(example to http://hl7.org/fhir/ValueSet/definition-topic)

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

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
94. PlanDefinition.author
Definition

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

ShortWho authored the content
Control0..*
TypeContactDetail
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
96. PlanDefinition.editor
Definition

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

ShortWho edited the content
Control0..*
TypeContactDetail
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
98. PlanDefinition.reviewer
Definition

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

ShortWho reviewed the content
Control0..*
TypeContactDetail
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
100. PlanDefinition.endorser
Definition

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

ShortWho endorsed the content
Control0..*
TypeContactDetail
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
102. PlanDefinition.relatedArtifact
Definition

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

ShortAdditional documentation, citations
Comments

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

Control1..*
TypeRelatedArtifact
Is Modifierfalse
Must Supporttrue
Summaryfalse
Requirements

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.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.relatedArtifact. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

104. PlanDefinition.relatedArtifact:triggeringValueSetLibrary
Slice NametriggeringValueSetLibrary
Definition

A dependency on the Reportable Conditions Trigger Codes (RCTC) value set library. The reference SHOULD be version-pinned, so that it is unambiguous which trigger code content this specification was authored against.

ShortThe RCTC value set library this specification was authored against.
Comments

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

Control1..1
TypeRelatedArtifact
Is Modifierfalse
Must Supporttrue
Summaryfalse
Requirements

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.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
106. PlanDefinition.relatedArtifact:triggeringValueSetLibrary.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
108. PlanDefinition.relatedArtifact:triggeringValueSetLibrary.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.relatedArtifact.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
110. PlanDefinition.relatedArtifact:triggeringValueSetLibrary.type
Definition

The type of relationship to the related artifact.

Shortdocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Control1..1
BindingThe codes SHALL be taken from RelatedArtifactType
(required to http://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1)

The type of relationship to the related artifact.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Fixed Value
{
  "type" : "depends-on"
}
<type value="depends-on"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
112. PlanDefinition.relatedArtifact:triggeringValueSetLibrary.label
Definition

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

ShortShort label
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
114. PlanDefinition.relatedArtifact:triggeringValueSetLibrary.display
Definition

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

ShortBrief description of the related artifact
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
116. PlanDefinition.relatedArtifact:triggeringValueSetLibrary.citation
Definition

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

ShortBibliographic citation for the artifact
Comments

Additional structured information about citations should be captured as extensions.

Control0..1
Typemarkdown
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
118. PlanDefinition.relatedArtifact:triggeringValueSetLibrary.url
Definition

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

ShortWhere the artifact can be accessed
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).

Control0..1
Typeurl
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
120. PlanDefinition.relatedArtifact:triggeringValueSetLibrary.document
Definition

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

ShortWhat document is being referenced
Control0..1
TypeAttachment
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
122. PlanDefinition.relatedArtifact:triggeringValueSetLibrary.resource
Definition

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

ShortWhat resource is being referenced
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.

Control1..1
Typecanonical(Resource)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
124. PlanDefinition.library
Definition

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

ShortLogic used by the plan definition
Control0..*
Typecanonical(Library)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
126. 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.

ShortWhat the plan is trying to accomplish
Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
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.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
128. 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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
130. PlanDefinition.goal.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
132. 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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
134. PlanDefinition.goal.category
Definition

Indicates a category the goal falls within.

ShortE.g. Treatment, dietary, behavioral
Control0..1
BindingFor example codes, see GoalCategory
(example to http://hl7.org/fhir/ValueSet/goal-category)

Example codes for grouping goals for filtering or presentation.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
136. 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".

ShortCode or text describing the goal
Comments

If no code is available, use CodeableConcept.text.

Control1..1
BindingFor example codes, see SNOMEDCTClinicalFindings
(example to http://hl7.org/fhir/ValueSet/clinical-findings)

Describes goals that can be achieved.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
138. PlanDefinition.goal.priority
Definition

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

Shorthigh-priority | medium-priority | low-priority
Control0..1
BindingThe codes SHOULD be taken from GoalPriority
(preferred to http://hl7.org/fhir/ValueSet/goal-priority)

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

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
140. PlanDefinition.goal.start
Definition

The event after which the goal should begin being pursued.

ShortWhen goal pursuit begins
Control0..1
BindingFor example codes, see GoalStartEvent
(example to http://hl7.org/fhir/ValueSet/goal-start-event)

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

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
142. PlanDefinition.goal.addresses
Definition

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

ShortWhat does the goal address
Control0..*
BindingFor example codes, see Condition/Problem/DiagnosisCodes
(example to http://hl7.org/fhir/ValueSet/condition-code)

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

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
144. 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.

ShortSupporting documentation for the goal
Control0..*
TypeRelatedArtifact
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
146. PlanDefinition.goal.target
Definition

Indicates what should be done and within what timeframe.

ShortTarget outcome for the goal
Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
148. 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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
150. PlanDefinition.goal.target.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
152. 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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
154. PlanDefinition.goal.target.measure
Definition

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

ShortThe parameter whose value is to be tracked
Control0..1
BindingFor example codes, see LOINCCodes
(example to http://hl7.org/fhir/ValueSet/observation-codes)

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

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
156. 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. When 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.

ShortThe target value to be achieved
Control0..1
TypeChoice of: Quantity, Range, CodeableConcept
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
158. PlanDefinition.goal.target.due
Definition

Indicates the timeframe after the start of the goal in which the goal should be met.

ShortReach goal within
Control0..1
TypeDuration
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
160. PlanDefinition.action
Definition

An action or group of actions to be taken as part of the plan.

ShortAll constraints on action are intended to apply to any nested constraints.
Comments

Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.

Control8..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action. The slices are Ordered and Open, and can be differentiated using the following discriminators:
  • value @ id

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
164. PlanDefinition.action.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
166. PlanDefinition.action.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
168. PlanDefinition.action.prefix
Definition

A user-visible prefix for the action.

ShortUser-visible prefix for the action (e.g. 1. or A.)
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
170. PlanDefinition.action.title
Definition

The title of the action displayed to a user.

ShortUser-visible title
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
172. PlanDefinition.action.description
Definition

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

ShortBrief description of the action
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
174. 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 might not be capable of interpreting it dynamically.

ShortStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
176. PlanDefinition.action.priority
Definition

Indicates how quickly the action should be addressed with respect to other actions.

Shortroutine | urgent | asap | stat
Control0..1
BindingThe codes SHALL be taken from RequestPriority
(required to http://hl7.org/fhir/ValueSet/request-priority|4.0.1)

Identifies the level of importance to be assigned to actioning the request.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
178. 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 the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control0..1
BindingUnless not suitable, these codes SHALL be taken from US Public Health ValueSet - PlanDefinition Action
(extensible to http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-plandefinition-action)

The set of actions that can be used to create plan definition

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
180. PlanDefinition.action.reason
Definition

A description of why this action is necessary or appropriate.

ShortWhy the action should be performed
Comments

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

Control0..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
182. 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.

ShortSupporting documentation for the intended performer of the action
Control0..*
TypeRelatedArtifact
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
184. PlanDefinition.action.goalId
Definition

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

ShortWhat goals this action supports
Control0..*
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
186. PlanDefinition.action.subject[x]
Definition

A code or group definition that describes the intended subject of the action and its children, if any.

ShortType of individual the action is focused on
Comments

The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified.

In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType
(extensible to http://hl7.org/fhir/ValueSet/subject-type)

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

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Requirements

Multiple steps in a protocol often have different groups of steps that are focused on testing different things. The subject of an action specifies the focus of the action and any child actions.

Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
188. PlanDefinition.action.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
190. PlanDefinition.action.trigger.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
192. PlanDefinition.action.trigger.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control1..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.trigger.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
194. PlanDefinition.action.trigger.extension:namedEventType
Slice NamenamedEventType
Definition

Indicates the types of named events to subscribe to from the EHR.

ShortUS Public Health Named Event Type Extension
Control1..1
TypeExtension(US Public Health Named Event Type Extension) (Extension Type: CodeableConcept)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
196. PlanDefinition.action.trigger.type
Definition

The type of triggering event.

Shortnamed-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Control1..1
BindingThe codes SHALL be taken from TriggerType
(required to http://hl7.org/fhir/ValueSet/trigger-type|4.0.1)

The type of trigger.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Value
{
  "type" : "named-event"
}
<type value="named-event"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
198. PlanDefinition.action.trigger.name
Definition

A formal name for the event. This may be an absolute URI that identifies the event formally (e.g. from a trigger registry), or a simple relative URI that identifies the event in a local context.

ShortName or URI that identifies the event
Comments

An event name can be provided for all event types, but is required for named events. If a name is provided for a type other than named events, it is considered to be a shorthand for the semantics described by the formal description of the event.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
200. PlanDefinition.action.trigger.timing[x]
Definition

The timing of the event (if this is a periodic trigger).

ShortTiming of the event
Control0..1
TypeChoice of: Timing, Reference(Schedule), date, dateTime
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
202. PlanDefinition.action.trigger.data
Definition

The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.

ShortTriggering data of the event (multiple = 'and')
Comments

This element shall be present for any data type trigger.

Control0..*
TypeDataRequirement
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
204. PlanDefinition.action.trigger.condition
Definition

A boolean-valued expression that is evaluated in the context of the container of the trigger definition and returns whether or not the trigger fires.

ShortWhether the event triggers (boolean expression)
Comments

This element can be only be specified for data type triggers and provides additional semantics for the trigger. The context available within the condition is based on the type of data event. For all events, the current resource will be available as context. In addition, for modification events, the previous resource will also be available. The expression may be inlined, or may be a simple absolute URI, which is a reference to a named expression within a logic library referenced by a library element or extension within the containing resource. If the expression is a FHIR Path expression, it evaluates in the context of a resource of one of the type identified in the data requirement, and may also refer to the variable %previous for delta comparisons on events of type data-changed, data-modified, and data-deleted which will always have the same type.

Control0..1
TypeExpression
Is Modifierfalse
Summarytrue
Requirements

Need to be able to formally describe the triggering criteria.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
206. PlanDefinition.action.condition
Definition

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

ShortWhether or not the action is applicable
Comments

When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
208. 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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
210. PlanDefinition.action.condition.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
212. 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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
214. PlanDefinition.action.condition.kind
Definition

The kind of condition.

Shortapplicability | start | stop
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 enter/exit criteria for an action.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKind
(required to http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1)

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
216. PlanDefinition.action.condition.expression
Definition

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

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
218. PlanDefinition.action.input
Definition

Defines input data requirements for the action.

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
220. PlanDefinition.action.input.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
222. PlanDefinition.action.input.extension
Definition

Defines extensions for the action.

ShortExtension
Control0..*
TypeExtension
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

224. PlanDefinition.action.input.extension:fhirquerypattern
Slice Namefhirquerypattern
Definition

A FHIR Query URL pattern that corresponds to the data specified by the data requirement. If multiple FHIR Query URLs are present, they each contribute to the data specified by the data requirement (i.e. the union of the results of the FHIR Queries represents the complete data for the data requirement). This is not a resolveable URL, in that it will contain 1) No base canonical (i.e. it's a relative query), and 2) Parameters using tokens that are delimited using double-braces and the context parameters are dependent solely on the subjectType, according to the following: Patient: context.patientId, Practitioner: context.practitionerId, Organization: context.organizationId, Location: context.locationId, Device: context.deviceId. For example, for a Library with a subjectType of Patient, the context parameter {{context.patientId}} will be used as a token to be replaced with the id of the Patient in context. This extension is used primarily to address the use case for satisfying a data requirement for a single subject. However, the query pattern could also be used to satisfy population level requests by removing the subject-level filter from the query.

ShortWhat FHIR query?
Comments

Supports communicating a FHIR query (or set of queries) for the given data requirement. The query is server-specific, and will need to be created as informed by a CapabilityStatement. The $data-requirements operation should be expected to be able to provide an Endpoint or CapabilityStatement to provide this information.; If no endpoint or capability statement is provided, the capability statement of the server performing the operation is used.

Control0..1
TypeExtension(FHIR Query Pattern) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
226. PlanDefinition.action.input.extension:fhirquerypattern.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
228. PlanDefinition.action.input.extension:fhirquerypattern.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
230. PlanDefinition.action.input.extension:fhirquerypattern.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "http://hl7.org/fhir/StructureDefinition/cqf-fhirQueryPattern"
}
<url value="http://hl7.org/fhir/StructureDefinition/cqf-fhirQueryPattern"/>
232. PlanDefinition.action.input.extension:fhirquerypattern.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortValue of extension
Control1..1
Typestring
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
234. PlanDefinition.action.input.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypes
(required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
236. PlanDefinition.action.input.profile
Definition

The profile of the required data, specified as the uri of the profile definition.

ShortThe profile of the required data
Control0..*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
238. PlanDefinition.action.input.subject[x]
Definition

The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.

ShortE.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments

The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType
(extensible to http://hl7.org/fhir/ValueSet/subject-type|4.0.1)

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

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summarytrue
Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
240. PlanDefinition.action.input.mustSupport
Definition

Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available.

The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).

ShortIndicates specific structure elements that are referenced by the knowledge module
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
242. PlanDefinition.action.input.codeFilter
Definition

Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.

ShortWhat codes are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-1: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
244. PlanDefinition.action.input.codeFilter.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
246. PlanDefinition.action.input.codeFilter.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.codeFilter.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
248. PlanDefinition.action.input.codeFilter.path
Definition

The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.

ShortA code-valued attribute to filter on
Comments

The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
250. PlanDefinition.action.input.codeFilter.searchParam
Definition

A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.

ShortA coded (token) parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
252. PlanDefinition.action.input.codeFilter.valueSet
Definition

The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.

ShortValueset for the filter
Control0..1
Typecanonical(ValueSet)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
254. PlanDefinition.action.input.codeFilter.code
Definition

The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.

ShortWhat code is expected
Control0..*
TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
256. PlanDefinition.action.input.dateFilter
Definition

Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.

ShortWhat dates/date ranges are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-2: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
258. PlanDefinition.action.input.dateFilter.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
260. PlanDefinition.action.input.dateFilter.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.dateFilter.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
262. PlanDefinition.action.input.dateFilter.path
Definition

The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.

ShortA date-valued attribute to filter on
Comments

The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
264. PlanDefinition.action.input.dateFilter.searchParam
Definition

A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.

ShortA date valued parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
266. PlanDefinition.action.input.dateFilter.value[x]
Definition

The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.

ShortThe value of the filter, as a Period, DateTime, or Duration value
Control0..1
TypeChoice of: dateTime, Period, Duration
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
268. PlanDefinition.action.input.limit
Definition

Specifies a maximum number of results that are required (uses the _count search parameter).

ShortNumber of results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".

Control0..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
270. PlanDefinition.action.input.sort
Definition

Specifies the order of the results to be returned.

ShortOrder of the results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.

Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
272. PlanDefinition.action.input.sort.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
274. PlanDefinition.action.input.sort.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.sort.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
276. PlanDefinition.action.input.sort.path
Definition

The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.

ShortThe name of the attribute to perform the sort
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
278. PlanDefinition.action.input.sort.direction
Definition

The direction of the sort, ascending or descending.

Shortascending | descending
Control1..1
BindingThe codes SHALL be taken from SortDirection
(required to http://hl7.org/fhir/ValueSet/sort-direction|4.0.1)

The possible sort directions, ascending or descending.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
280. PlanDefinition.action.output
Definition

Defines the outputs of the action, if any.

ShortOutput data definition
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
282. PlanDefinition.action.output.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
284. PlanDefinition.action.output.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
286. PlanDefinition.action.output.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypes
(required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
288. PlanDefinition.action.output.profile
Definition

The profile of the required data, specified as the uri of the profile definition.

ShortThe profile of the required data
Control0..*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
290. PlanDefinition.action.output.subject[x]
Definition

The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.

ShortE.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments

The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType
(extensible to http://hl7.org/fhir/ValueSet/subject-type|4.0.1)

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

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summarytrue
Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
292. PlanDefinition.action.output.mustSupport
Definition

Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available.

The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).

ShortIndicates specific structure elements that are referenced by the knowledge module
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
294. PlanDefinition.action.output.codeFilter
Definition

Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.

ShortWhat codes are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-1: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
296. PlanDefinition.action.output.codeFilter.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
298. PlanDefinition.action.output.codeFilter.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.codeFilter.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
300. PlanDefinition.action.output.codeFilter.path
Definition

The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.

ShortA code-valued attribute to filter on
Comments

The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
302. PlanDefinition.action.output.codeFilter.searchParam
Definition

A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.

ShortA coded (token) parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
304. PlanDefinition.action.output.codeFilter.valueSet
Definition

The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.

ShortValueset for the filter
Control0..1
Typecanonical(ValueSet)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
306. PlanDefinition.action.output.codeFilter.code
Definition

The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.

ShortWhat code is expected
Control0..*
TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
308. PlanDefinition.action.output.dateFilter
Definition

Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.

ShortWhat dates/date ranges are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-2: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
310. PlanDefinition.action.output.dateFilter.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
312. PlanDefinition.action.output.dateFilter.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.dateFilter.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
314. PlanDefinition.action.output.dateFilter.path
Definition

The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.

ShortA date-valued attribute to filter on
Comments

The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
316. PlanDefinition.action.output.dateFilter.searchParam
Definition

A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.

ShortA date valued parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
318. PlanDefinition.action.output.dateFilter.value[x]
Definition

The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.

ShortThe value of the filter, as a Period, DateTime, or Duration value
Control0..1
TypeChoice of: dateTime, Period, Duration
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
320. PlanDefinition.action.output.limit
Definition

Specifies a maximum number of results that are required (uses the _count search parameter).

ShortNumber of results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".

Control0..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
322. PlanDefinition.action.output.sort
Definition

Specifies the order of the results to be returned.

ShortOrder of the results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.

Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
324. PlanDefinition.action.output.sort.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
326. PlanDefinition.action.output.sort.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.sort.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
328. PlanDefinition.action.output.sort.path
Definition

The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.

ShortThe name of the attribute to perform the sort
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
330. PlanDefinition.action.output.sort.direction
Definition

The direction of the sort, ascending or descending.

Shortascending | descending
Control1..1
BindingThe codes SHALL be taken from SortDirection
(required to http://hl7.org/fhir/ValueSet/sort-direction|4.0.1)

The possible sort directions, ascending or descending.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
332. PlanDefinition.action.relatedAction
Definition

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

ShortRelationship to another action
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.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
334. 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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
336. PlanDefinition.action.relatedAction.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
338. 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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
340. PlanDefinition.action.relatedAction.actionId
Definition

The element id of the related action.

ShortWhat action is this related to
Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
342. PlanDefinition.action.relatedAction.relationship
Definition

The relationship of this action to the related action.

Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control1..1
BindingThe codes SHALL be taken from ActionRelationshipType
(required to http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1)

Defines the types of relationships between actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
344. PlanDefinition.action.relatedAction.offset[x]
Definition

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

ShortTime offset for the relationship
Control0..1
TypeChoice of: Duration, Range
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action.relatedAction.offset[x]. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this

Slicing Note: Other type slices that contain no new information are not shown in this view

346. PlanDefinition.action.relatedAction.offset[x]:offsetDuration
Slice NameoffsetDuration
Definition

The duration quantity may include a comparator, indicating how the offset should be applied. For example, <= 1 hour, meaning that the offset should be no more than 1 hour. This allows systems flexibility in scheduling the actions to isolate reporting activities to off hours.

ShortTime offset for the relationship
Control0..1
TypeDuration
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
349. PlanDefinition.action.timing[x]
Definition

An optional value describing when the action should be performed.

ShortWhen the action should take place
Control0..1
TypeDuration
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
351. PlanDefinition.action.participant
Definition

Indicates who should participate in performing the action described.

ShortWho should participate in the action
Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
353. 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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
355. PlanDefinition.action.participant.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
357. 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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
359. PlanDefinition.action.participant.type
Definition

The type of participant in the action.

Shortpatient | practitioner | related-person | device
Control1..1
BindingThe codes SHALL be taken from ActionParticipantType
(required to http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1)

The type of participant for the action.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
361. PlanDefinition.action.participant.role
Definition

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

ShortE.g. Nurse, Surgeon, Parent
Control0..1
BindingFor example codes, see ActionParticipantRole
(example to http://hl7.org/fhir/ValueSet/action-participant-role)

Defines roles played by participants for the action.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
363. PlanDefinition.action.type
Definition

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

Shortcreate | update | remove | fire-event
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ActionType
(extensible to http://hl7.org/fhir/ValueSet/action-type)

The type of action to be performed.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
365. PlanDefinition.action.groupingBehavior
Definition

Defines the grouping behavior for the action and its children.

Shortvisual-group | logical-group | sentence-group
Control0..1
BindingThe codes SHALL be taken from ActionGroupingBehavior
(required to http://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.1)

Defines organization behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
367. PlanDefinition.action.selectionBehavior
Definition

Defines the selection behavior for the action and its children.

Shortany | all | all-or-none | exactly-one | at-most-one | one-or-more
Control0..1
BindingThe codes SHALL be taken from ActionSelectionBehavior
(required to http://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.1)

Defines selection behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
369. PlanDefinition.action.requiredBehavior
Definition

Defines the required behavior for the action.

Shortmust | could | must-unless-documented
Control0..1
BindingThe codes SHALL be taken from ActionRequiredBehavior
(required to http://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1)

Defines expectations around whether an action or action group is required.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
371. PlanDefinition.action.precheckBehavior
Definition

Defines whether the action should usually be preselected.

Shortyes | no
Control0..1
BindingThe codes SHALL be taken from ActionPrecheckBehavior
(required to http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1)

Defines selection frequency behavior for an action or group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
373. PlanDefinition.action.cardinalityBehavior
Definition

Defines whether the action can be selected multiple times.

Shortsingle | multiple
Control0..1
BindingThe codes SHALL be taken from ActionCardinalityBehavior
(required to http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1)

Defines behavior for an action or a group for how many times that item may be repeated.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
375. PlanDefinition.action.definition[x]
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.

ShortDescription of the activity to be performed
Comments

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

Control0..1
TypeChoice of: canonical(ActivityDefinition, PlanDefinition, Questionnaire), uri
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
377. 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.

ShortTransform to apply the template
Comments

Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..1
Typecanonical(StructureMap)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
379. 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.

ShortDynamic aspects of the definition
Comments

Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
381. 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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
383. PlanDefinition.action.dynamicValue.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
385. 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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
387. 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. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details).

ShortThe path to the element to be set dynamically
Comments

To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
389. PlanDefinition.action.dynamicValue.expression
Definition

An expression specifying the value of the customized element.

ShortAn expression that provides the dynamic value for the customization
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
391. PlanDefinition.action.action
Definition

Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.

ShortA sub-action
Control0..*
TypeSeettp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
393. PlanDefinition.action:encounterStart
Slice NameencounterStart
Definition

Defines the "start" action

ShortEncounter start code
Comments

Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.

Control1..1
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
395. PlanDefinition.action:encounterStart.id
Definition

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

ShortUnique id for inter-element referencing
Control1..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "id" : "start-workflow"
}
<id value="start-workflow"/>
397. PlanDefinition.action:encounterStart.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
399. PlanDefinition.action:encounterStart.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
401. PlanDefinition.action:encounterStart.prefix
Definition

A user-visible prefix for the action.

ShortUser-visible prefix for the action (e.g. 1. or A.)
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
403. PlanDefinition.action:encounterStart.title
Definition

The title of the action displayed to a user.

ShortUser-visible title
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
405. PlanDefinition.action:encounterStart.description
Definition

Description of the "start" action.

ShortDescription of the "start" action.
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Value
{
  "description" : "This action represents the start of the reporting workflow in response to the encounter-start event."
}
<description value="This action represents the start of the reporting workflow in response to the encounter-start event."/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
407. PlanDefinition.action:encounterStart.textEquivalent
Definition

Text equivalent of the "start" action.

ShortText equivalent of the "start" action.
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Value
{
  "textEquivalent" : "Start the reporting workflow in response to an encounter-start event"
}
<textEquivalent value="Start the reporting workflow in response to an encounter-start event"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
409. PlanDefinition.action:encounterStart.priority
Definition

Indicates how quickly the action should be addressed with respect to other actions.

Shortroutine | urgent | asap | stat
Control0..1
BindingThe codes SHALL be taken from RequestPriority
(required to http://hl7.org/fhir/ValueSet/request-priority|4.0.1)

Identifies the level of importance to be assigned to actioning the request.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
411. PlanDefinition.action:encounterStart.code
Definition

The US-PH-PlanDefinition-Action code for the "start" action.

ShortCode for the "start" action.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from US Public Health ValueSet - PlanDefinition Action
(extensible to http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-plandefinition-action)

The set of actions that can be used to create plan definition

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "initiate-reporting-workflow"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="initiate-reporting-workflow"/>
  </coding>
</code>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
413. PlanDefinition.action:encounterStart.reason
Definition

A description of why this action is necessary or appropriate.

ShortWhy the action should be performed
Comments

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

Control0..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
415. PlanDefinition.action:encounterStart.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.

ShortSupporting documentation for the intended performer of the action
Control0..*
TypeRelatedArtifact
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
417. PlanDefinition.action:encounterStart.goalId
Definition

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

ShortWhat goals this action supports
Control0..*
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
419. PlanDefinition.action:encounterStart.subject[x]
Definition

A code or group definition that describes the intended subject of the action and its children, if any.

ShortType of individual the action is focused on
Comments

The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified.

In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType
(extensible to http://hl7.org/fhir/ValueSet/subject-type)

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

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Requirements

Multiple steps in a protocol often have different groups of steps that are focused on testing different things. The subject of an action specifies the focus of the action and any child actions.

Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
421. PlanDefinition.action:encounterStart.trigger
Definition

When the "start" action should be triggered.

ShortWhen the "start" action should be triggered.
Control1..*
TypeTriggerDefinition
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
epd-1: The code value of the namedEventType SHALL be the same as the name element (name.supersetOf(extension('http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-named-eventtype-extension').value.coding.code))
423. PlanDefinition.action:encounterStart.trigger.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
425. PlanDefinition.action:encounterStart.trigger.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control1..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.trigger.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
427. PlanDefinition.action:encounterStart.trigger.extension:namedEventType
Slice NamenamedEventType
Definition

Indicates the types of named events to subscribe to from the EHR.

ShortIndicates the types of named events to subscribe to from the EHR.
Control1..1
TypeExtension(US Public Health Named Event Type Extension) (Extension Type: CodeableConcept)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
429. PlanDefinition.action:encounterStart.trigger.type
Definition

The type of triggering event.

Shortnamed-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Control1..1
BindingThe codes SHALL be taken from TriggerType
(required to http://hl7.org/fhir/ValueSet/trigger-type|4.0.1)

The type of trigger.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Value
{
  "type" : "named-event"
}
<type value="named-event"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
431. PlanDefinition.action:encounterStart.trigger.name
Definition

The name of the event, encounter-start in this case. For any action invoked as a result of this trigger, the triggering encounter is accessible via the context variable %encounter

ShortName or URI that identifies the event
Comments

An event name can be provided for all event types, but is required for named events. If a name is provided for a type other than named events, it is considered to be a shorthand for the semantics described by the formal description of the event.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Fixed Value
{
  "name" : "encounter-start"
}
<name value="encounter-start"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
433. PlanDefinition.action:encounterStart.trigger.timing[x]
Definition

The timing of the event (if this is a periodic trigger).

ShortTiming of the event
Control0..1
TypeChoice of: Timing, Reference(Schedule), date, dateTime
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
435. PlanDefinition.action:encounterStart.trigger.data
Definition

The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.

ShortTriggering data of the event (multiple = 'and')
Comments

This element shall be present for any data type trigger.

Control0..*
TypeDataRequirement
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
437. PlanDefinition.action:encounterStart.trigger.condition
Definition

A boolean-valued expression that is evaluated in the context of the container of the trigger definition and returns whether or not the trigger fires.

ShortWhether the event triggers (boolean expression)
Comments

This element can be only be specified for data type triggers and provides additional semantics for the trigger. The context available within the condition is based on the type of data event. For all events, the current resource will be available as context. In addition, for modification events, the previous resource will also be available. The expression may be inlined, or may be a simple absolute URI, which is a reference to a named expression within a logic library referenced by a library element or extension within the containing resource. If the expression is a FHIR Path expression, it evaluates in the context of a resource of one of the type identified in the data requirement, and may also refer to the variable %previous for delta comparisons on events of type data-changed, data-modified, and data-deleted which will always have the same type.

Control0..1
TypeExpression
Is Modifierfalse
Summarytrue
Requirements

Need to be able to formally describe the triggering criteria.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
439. PlanDefinition.action:encounterStart.condition
Definition

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

ShortWhether or not the action is applicable
Comments

When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
441. PlanDefinition.action:encounterStart.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
443. PlanDefinition.action:encounterStart.condition.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
445. PlanDefinition.action:encounterStart.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
447. PlanDefinition.action:encounterStart.condition.kind
Definition

The kind of condition.

Shortapplicability | start | stop
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 enter/exit criteria for an action.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKind
(required to http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1)

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
449. PlanDefinition.action:encounterStart.condition.expression
Definition

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

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
451. PlanDefinition.action:encounterStart.input
Definition

Defines input data requirements for the action.

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
453. PlanDefinition.action:encounterStart.input.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
455. PlanDefinition.action:encounterStart.input.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
457. PlanDefinition.action:encounterStart.input.extension:fhirquerypattern
Slice Namefhirquerypattern
Definition

A FHIR Query URL pattern that corresponds to the data specified by the data requirement. If multiple FHIR Query URLs are present, they each contribute to the data specified by the data requirement (i.e. the union of the results of the FHIR Queries represents the complete data for the data requirement). This is not a resolveable URL, in that it will contain 1) No base canonical (i.e. it's a relative query), and 2) Parameters using tokens that are delimited using double-braces and the context parameters are dependent solely on the subjectType, according to the following: Patient: context.patientId, Practitioner: context.practitionerId, Organization: context.organizationId, Location: context.locationId, Device: context.deviceId. For example, for a Library with a subjectType of Patient, the context parameter {{context.patientId}} will be used as a token to be replaced with the id of the Patient in context. This extension is used primarily to address the use case for satisfying a data requirement for a single subject. However, the query pattern could also be used to satisfy population level requests by removing the subject-level filter from the query.

ShortWhat FHIR query?
Comments

Supports communicating a FHIR query (or set of queries) for the given data requirement. The query is server-specific, and will need to be created as informed by a CapabilityStatement. The $data-requirements operation should be expected to be able to provide an Endpoint or CapabilityStatement to provide this information.; If no endpoint or capability statement is provided, the capability statement of the server performing the operation is used.

Control0..1
TypeExtension(FHIR Query Pattern) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
459. PlanDefinition.action:encounterStart.input.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypes
(required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
461. PlanDefinition.action:encounterStart.input.profile
Definition

The profile of the required data, specified as the uri of the profile definition.

ShortThe profile of the required data
Control0..*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
463. PlanDefinition.action:encounterStart.input.subject[x]
Definition

The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.

ShortE.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments

The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType
(extensible to http://hl7.org/fhir/ValueSet/subject-type|4.0.1)

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

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summarytrue
Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
465. PlanDefinition.action:encounterStart.input.mustSupport
Definition

Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available.

The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).

ShortIndicates specific structure elements that are referenced by the knowledge module
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
467. PlanDefinition.action:encounterStart.input.codeFilter
Definition

Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.

ShortWhat codes are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-1: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
469. PlanDefinition.action:encounterStart.input.codeFilter.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
471. PlanDefinition.action:encounterStart.input.codeFilter.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.codeFilter.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
473. PlanDefinition.action:encounterStart.input.codeFilter.path
Definition

The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.

ShortA code-valued attribute to filter on
Comments

The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
475. PlanDefinition.action:encounterStart.input.codeFilter.searchParam
Definition

A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.

ShortA coded (token) parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
477. PlanDefinition.action:encounterStart.input.codeFilter.valueSet
Definition

The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.

ShortValueset for the filter
Control0..1
Typecanonical(ValueSet)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
479. PlanDefinition.action:encounterStart.input.codeFilter.code
Definition

The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.

ShortWhat code is expected
Control0..*
TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
481. PlanDefinition.action:encounterStart.input.dateFilter
Definition

Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.

ShortWhat dates/date ranges are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-2: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
483. PlanDefinition.action:encounterStart.input.dateFilter.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
485. PlanDefinition.action:encounterStart.input.dateFilter.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.dateFilter.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
487. PlanDefinition.action:encounterStart.input.dateFilter.path
Definition

The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.

ShortA date-valued attribute to filter on
Comments

The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
489. PlanDefinition.action:encounterStart.input.dateFilter.searchParam
Definition

A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.

ShortA date valued parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
491. PlanDefinition.action:encounterStart.input.dateFilter.value[x]
Definition

The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.

ShortThe value of the filter, as a Period, DateTime, or Duration value
Control0..1
TypeChoice of: dateTime, Period, Duration
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
493. PlanDefinition.action:encounterStart.input.limit
Definition

Specifies a maximum number of results that are required (uses the _count search parameter).

ShortNumber of results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".

Control0..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
495. PlanDefinition.action:encounterStart.input.sort
Definition

Specifies the order of the results to be returned.

ShortOrder of the results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.

Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
497. PlanDefinition.action:encounterStart.input.sort.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
499. PlanDefinition.action:encounterStart.input.sort.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.sort.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
501. PlanDefinition.action:encounterStart.input.sort.path
Definition

The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.

ShortThe name of the attribute to perform the sort
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
503. PlanDefinition.action:encounterStart.input.sort.direction
Definition

The direction of the sort, ascending or descending.

Shortascending | descending
Control1..1
BindingThe codes SHALL be taken from SortDirection
(required to http://hl7.org/fhir/ValueSet/sort-direction|4.0.1)

The possible sort directions, ascending or descending.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
505. PlanDefinition.action:encounterStart.output
Definition

Defines the outputs of the action, if any.

ShortOutput data definition
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
507. PlanDefinition.action:encounterStart.output.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
509. PlanDefinition.action:encounterStart.output.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
511. PlanDefinition.action:encounterStart.output.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypes
(required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
513. PlanDefinition.action:encounterStart.output.profile
Definition

The profile of the required data, specified as the uri of the profile definition.

ShortThe profile of the required data
Control0..*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
515. PlanDefinition.action:encounterStart.output.subject[x]
Definition

The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.

ShortE.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments

The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType
(extensible to http://hl7.org/fhir/ValueSet/subject-type|4.0.1)

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

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summarytrue
Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
517. PlanDefinition.action:encounterStart.output.mustSupport
Definition

Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available.

The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).

ShortIndicates specific structure elements that are referenced by the knowledge module
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
519. PlanDefinition.action:encounterStart.output.codeFilter
Definition

Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.

ShortWhat codes are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-1: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
521. PlanDefinition.action:encounterStart.output.codeFilter.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
523. PlanDefinition.action:encounterStart.output.codeFilter.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.codeFilter.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
525. PlanDefinition.action:encounterStart.output.codeFilter.path
Definition

The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.

ShortA code-valued attribute to filter on
Comments

The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
527. PlanDefinition.action:encounterStart.output.codeFilter.searchParam
Definition

A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.

ShortA coded (token) parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
529. PlanDefinition.action:encounterStart.output.codeFilter.valueSet
Definition

The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.

ShortValueset for the filter
Control0..1
Typecanonical(ValueSet)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
531. PlanDefinition.action:encounterStart.output.codeFilter.code
Definition

The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.

ShortWhat code is expected
Control0..*
TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
533. PlanDefinition.action:encounterStart.output.dateFilter
Definition

Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.

ShortWhat dates/date ranges are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-2: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
535. PlanDefinition.action:encounterStart.output.dateFilter.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
537. PlanDefinition.action:encounterStart.output.dateFilter.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.dateFilter.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
539. PlanDefinition.action:encounterStart.output.dateFilter.path
Definition

The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.

ShortA date-valued attribute to filter on
Comments

The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
541. PlanDefinition.action:encounterStart.output.dateFilter.searchParam
Definition

A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.

ShortA date valued parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
543. PlanDefinition.action:encounterStart.output.dateFilter.value[x]
Definition

The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.

ShortThe value of the filter, as a Period, DateTime, or Duration value
Control0..1
TypeChoice of: dateTime, Period, Duration
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
545. PlanDefinition.action:encounterStart.output.limit
Definition

Specifies a maximum number of results that are required (uses the _count search parameter).

ShortNumber of results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".

Control0..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
547. PlanDefinition.action:encounterStart.output.sort
Definition

Specifies the order of the results to be returned.

ShortOrder of the results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.

Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
549. PlanDefinition.action:encounterStart.output.sort.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
551. PlanDefinition.action:encounterStart.output.sort.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.sort.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
553. PlanDefinition.action:encounterStart.output.sort.path
Definition

The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.

ShortThe name of the attribute to perform the sort
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
555. PlanDefinition.action:encounterStart.output.sort.direction
Definition

The direction of the sort, ascending or descending.

Shortascending | descending
Control1..1
BindingThe codes SHALL be taken from SortDirection
(required to http://hl7.org/fhir/ValueSet/sort-direction|4.0.1)

The possible sort directions, ascending or descending.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
557. PlanDefinition.action:encounterStart.relatedAction
Definition

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

ShortRelationship to another action
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.

Control1..1
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
559. PlanDefinition.action:encounterStart.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
561. PlanDefinition.action:encounterStart.relatedAction.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
563. PlanDefinition.action:encounterStart.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
565. PlanDefinition.action:encounterStart.relatedAction.actionId
Definition

The element id of the related action.

ShortWhat action is this related to
Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Value
{
  "actionId" : "check-for-immediate-reporting"
}
<actionId value="check-for-immediate-reporting"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
567. PlanDefinition.action:encounterStart.relatedAction.relationship
Definition

The relationship of this action to the related action.

Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control1..1
BindingThe codes SHALL be taken from ActionRelationshipType
(required to http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1)

Defines the types of relationships between actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Value
{
  "relationship" : "before-start"
}
<relationship value="before-start"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
569. PlanDefinition.action:encounterStart.relatedAction.offset[x]
Definition

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

ShortTime offset for the relationship
Control0..1
TypeChoice of: Duration, Range
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action.relatedAction.offset[x]. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this

Slicing Note: Other type slices that contain no new information are not shown in this view

571. PlanDefinition.action:encounterStart.relatedAction.offset[x]:offsetDuration
Slice NameoffsetDuration
Definition

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

ShortTime offset for the relationship
Control0..1
TypeDuration
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
ExampleWait 1 hour before next action.: { "value" : 1, "unit" : "h" }
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
574. PlanDefinition.action:encounterStart.timing[x]
Definition

An optional value describing when the action should be performed.

ShortWhen the action should take place
Control0..1
TypeDuration
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
576. PlanDefinition.action:encounterStart.participant
Definition

Indicates who should participate in performing the action described.

ShortWho should participate in the action
Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
578. PlanDefinition.action:encounterStart.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
580. PlanDefinition.action:encounterStart.participant.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
582. PlanDefinition.action:encounterStart.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
584. PlanDefinition.action:encounterStart.participant.type
Definition

The type of participant in the action.

Shortpatient | practitioner | related-person | device
Control1..1
BindingThe codes SHALL be taken from ActionParticipantType
(required to http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1)

The type of participant for the action.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
586. PlanDefinition.action:encounterStart.participant.role
Definition

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

ShortE.g. Nurse, Surgeon, Parent
Control0..1
BindingFor example codes, see ActionParticipantRole
(example to http://hl7.org/fhir/ValueSet/action-participant-role)

Defines roles played by participants for the action.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
588. PlanDefinition.action:encounterStart.type
Definition

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

Shortcreate | update | remove | fire-event
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ActionType
(extensible to http://hl7.org/fhir/ValueSet/action-type)

The type of action to be performed.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
590. PlanDefinition.action:encounterStart.groupingBehavior
Definition

Defines the grouping behavior for the action and its children.

Shortvisual-group | logical-group | sentence-group
Control0..1
BindingThe codes SHALL be taken from ActionGroupingBehavior
(required to http://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.1)

Defines organization behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
592. PlanDefinition.action:encounterStart.selectionBehavior
Definition

Defines the selection behavior for the action and its children.

Shortany | all | all-or-none | exactly-one | at-most-one | one-or-more
Control0..1
BindingThe codes SHALL be taken from ActionSelectionBehavior
(required to http://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.1)

Defines selection behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
594. PlanDefinition.action:encounterStart.requiredBehavior
Definition

Defines the required behavior for the action.

Shortmust | could | must-unless-documented
Control0..1
BindingThe codes SHALL be taken from ActionRequiredBehavior
(required to http://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1)

Defines expectations around whether an action or action group is required.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
596. PlanDefinition.action:encounterStart.precheckBehavior
Definition

Defines whether the action should usually be preselected.

Shortyes | no
Control0..1
BindingThe codes SHALL be taken from ActionPrecheckBehavior
(required to http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1)

Defines selection frequency behavior for an action or group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
598. PlanDefinition.action:encounterStart.cardinalityBehavior
Definition

Defines whether the action can be selected multiple times.

Shortsingle | multiple
Control0..1
BindingThe codes SHALL be taken from ActionCardinalityBehavior
(required to http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1)

Defines behavior for an action or a group for how many times that item may be repeated.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
600. PlanDefinition.action:encounterStart.definition[x]
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.

ShortDescription of the activity to be performed
Comments

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

Control0..1
TypeChoice of: canonical(ActivityDefinition, PlanDefinition, Questionnaire), uri
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
602. PlanDefinition.action:encounterStart.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.

ShortTransform to apply the template
Comments

Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..1
Typecanonical(StructureMap)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
604. PlanDefinition.action:encounterStart.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.

ShortDynamic aspects of the definition
Comments

Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
606. PlanDefinition.action:encounterStart.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
608. PlanDefinition.action:encounterStart.dynamicValue.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
610. PlanDefinition.action:encounterStart.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
612. PlanDefinition.action:encounterStart.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. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details).

ShortThe path to the element to be set dynamically
Comments

To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
614. PlanDefinition.action:encounterStart.dynamicValue.expression
Definition

An expression specifying the value of the customized element.

ShortAn expression that provides the dynamic value for the customization
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
616. PlanDefinition.action:encounterStart.action
Definition

Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.

ShortA sub-action
Control0..*
TypeSeettp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
618. PlanDefinition.action:checkForImmediateReporting
Slice NamecheckForImmediateReporting
Definition

Defines the "check-for-immediate-reporting" action, which checks for immediately reportable evidence and schedules the subsequent reportability checks.

ShortCheck for immediate reporting
Comments

Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.

Control1..1
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
620. PlanDefinition.action:checkForImmediateReporting.id
Definition

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

ShortUnique id for inter-element referencing
Control1..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "id" : "check-for-immediate-reporting"
}
<id value="check-for-immediate-reporting"/>
622. PlanDefinition.action:checkForImmediateReporting.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
624. PlanDefinition.action:checkForImmediateReporting.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
626. PlanDefinition.action:checkForImmediateReporting.prefix
Definition

A user-visible prefix for the action.

ShortUser-visible prefix for the action (e.g. 1. or A.)
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
628. PlanDefinition.action:checkForImmediateReporting.title
Definition

The title of the action displayed to a user.

ShortUser-visible title
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
630. PlanDefinition.action:checkForImmediateReporting.description
Definition

Description of the check for immediate reporting action.

ShortDescription of the check for immediate reporting action.
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Value
{
  "description" : "This action represents the start of the check suspected disorder reporting workflow in response to the encounter-start event."
}
<description value="This action represents the start of the check suspected disorder reporting workflow in response to the encounter-start event."/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
632. PlanDefinition.action:checkForImmediateReporting.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 might not be capable of interpreting it dynamically.

ShortStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
634. PlanDefinition.action:checkForImmediateReporting.priority
Definition

Indicates how quickly the action should be addressed with respect to other actions.

Shortroutine | urgent | asap | stat
Control0..1
BindingThe codes SHALL be taken from RequestPriority
(required to http://hl7.org/fhir/ValueSet/request-priority|4.0.1)

Identifies the level of importance to be assigned to actioning the request.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
636. PlanDefinition.action:checkForImmediateReporting.code
Definition

The US-PH-PlanDefinition-Action code for the "check-for-immediate-reporting" action.

ShortCode for the "check-for-immediate-reporting" action.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from US Public Health ValueSet - PlanDefinition Action
(extensible to http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-plandefinition-action)

The set of actions that can be used to create plan definition

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "execute-reporting-workflow"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="execute-reporting-workflow"/>
  </coding>
</code>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
638. PlanDefinition.action:checkForImmediateReporting.reason
Definition

A description of why this action is necessary or appropriate.

ShortWhy the action should be performed
Comments

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

Control0..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
640. PlanDefinition.action:checkForImmediateReporting.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.

ShortSupporting documentation for the intended performer of the action
Control0..*
TypeRelatedArtifact
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
642. PlanDefinition.action:checkForImmediateReporting.goalId
Definition

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

ShortWhat goals this action supports
Control0..*
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
644. PlanDefinition.action:checkForImmediateReporting.subject[x]
Definition

A code or group definition that describes the intended subject of the action and its children, if any.

ShortType of individual the action is focused on
Comments

The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified.

In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType
(extensible to http://hl7.org/fhir/ValueSet/subject-type)

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

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Requirements

Multiple steps in a protocol often have different groups of steps that are focused on testing different things. The subject of an action specifies the focus of the action and any child actions.

Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
646. PlanDefinition.action:checkForImmediateReporting.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
648. PlanDefinition.action:checkForImmediateReporting.trigger.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
650. PlanDefinition.action:checkForImmediateReporting.trigger.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control1..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.trigger.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
652. PlanDefinition.action:checkForImmediateReporting.trigger.extension:namedEventType
Slice NamenamedEventType
Definition

Indicates the types of named events to subscribe to from the EHR.

ShortUS Public Health Named Event Type Extension
Control1..1
TypeExtension(US Public Health Named Event Type Extension) (Extension Type: CodeableConcept)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
654. PlanDefinition.action:checkForImmediateReporting.trigger.type
Definition

The type of triggering event.

Shortnamed-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Control1..1
BindingThe codes SHALL be taken from TriggerType
(required to http://hl7.org/fhir/ValueSet/trigger-type|4.0.1)

The type of trigger.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Value
{
  "type" : "named-event"
}
<type value="named-event"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
656. PlanDefinition.action:checkForImmediateReporting.trigger.name
Definition

A formal name for the event. This may be an absolute URI that identifies the event formally (e.g. from a trigger registry), or a simple relative URI that identifies the event in a local context.

ShortName or URI that identifies the event
Comments

An event name can be provided for all event types, but is required for named events. If a name is provided for a type other than named events, it is considered to be a shorthand for the semantics described by the formal description of the event.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
658. PlanDefinition.action:checkForImmediateReporting.trigger.timing[x]
Definition

The timing of the event (if this is a periodic trigger).

ShortTiming of the event
Control0..1
TypeChoice of: Timing, Reference(Schedule), date, dateTime
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
660. PlanDefinition.action:checkForImmediateReporting.trigger.data
Definition

The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.

ShortTriggering data of the event (multiple = 'and')
Comments

This element shall be present for any data type trigger.

Control0..*
TypeDataRequirement
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
662. PlanDefinition.action:checkForImmediateReporting.trigger.condition
Definition

A boolean-valued expression that is evaluated in the context of the container of the trigger definition and returns whether or not the trigger fires.

ShortWhether the event triggers (boolean expression)
Comments

This element can be only be specified for data type triggers and provides additional semantics for the trigger. The context available within the condition is based on the type of data event. For all events, the current resource will be available as context. In addition, for modification events, the previous resource will also be available. The expression may be inlined, or may be a simple absolute URI, which is a reference to a named expression within a logic library referenced by a library element or extension within the containing resource. If the expression is a FHIR Path expression, it evaluates in the context of a resource of one of the type identified in the data requirement, and may also refer to the variable %previous for delta comparisons on events of type data-changed, data-modified, and data-deleted which will always have the same type.

Control0..1
TypeExpression
Is Modifierfalse
Summarytrue
Requirements

Need to be able to formally describe the triggering criteria.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
664. PlanDefinition.action:checkForImmediateReporting.condition
Definition

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

ShortWhether or not the action is applicable
Comments

When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
666. PlanDefinition.action:checkForImmediateReporting.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
668. PlanDefinition.action:checkForImmediateReporting.condition.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
670. PlanDefinition.action:checkForImmediateReporting.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
672. PlanDefinition.action:checkForImmediateReporting.condition.kind
Definition

The kind of condition.

Shortapplicability | start | stop
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 enter/exit criteria for an action.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKind
(required to http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1)

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
674. PlanDefinition.action:checkForImmediateReporting.condition.expression
Definition

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

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
676. PlanDefinition.action:checkForImmediateReporting.input
Definition

Defines input data requirements for the action.

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
678. PlanDefinition.action:checkForImmediateReporting.input.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
680. PlanDefinition.action:checkForImmediateReporting.input.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
682. PlanDefinition.action:checkForImmediateReporting.input.extension:fhirquerypattern
Slice Namefhirquerypattern
Definition

A FHIR Query URL pattern that corresponds to the data specified by the data requirement. If multiple FHIR Query URLs are present, they each contribute to the data specified by the data requirement (i.e. the union of the results of the FHIR Queries represents the complete data for the data requirement). This is not a resolveable URL, in that it will contain 1) No base canonical (i.e. it's a relative query), and 2) Parameters using tokens that are delimited using double-braces and the context parameters are dependent solely on the subjectType, according to the following: Patient: context.patientId, Practitioner: context.practitionerId, Organization: context.organizationId, Location: context.locationId, Device: context.deviceId. For example, for a Library with a subjectType of Patient, the context parameter {{context.patientId}} will be used as a token to be replaced with the id of the Patient in context. This extension is used primarily to address the use case for satisfying a data requirement for a single subject. However, the query pattern could also be used to satisfy population level requests by removing the subject-level filter from the query.

ShortWhat FHIR query?
Comments

Supports communicating a FHIR query (or set of queries) for the given data requirement. The query is server-specific, and will need to be created as informed by a CapabilityStatement. The $data-requirements operation should be expected to be able to provide an Endpoint or CapabilityStatement to provide this information.; If no endpoint or capability statement is provided, the capability statement of the server performing the operation is used.

Control0..1
TypeExtension(FHIR Query Pattern) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
684. PlanDefinition.action:checkForImmediateReporting.input.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypes
(required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
686. PlanDefinition.action:checkForImmediateReporting.input.profile
Definition

The profile of the required data, specified as the uri of the profile definition.

ShortThe profile of the required data
Control0..*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
688. PlanDefinition.action:checkForImmediateReporting.input.subject[x]
Definition

The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.

ShortE.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments

The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType
(extensible to http://hl7.org/fhir/ValueSet/subject-type|4.0.1)

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

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summarytrue
Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
690. PlanDefinition.action:checkForImmediateReporting.input.mustSupport
Definition

Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available.

The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).

ShortIndicates specific structure elements that are referenced by the knowledge module
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
692. PlanDefinition.action:checkForImmediateReporting.input.codeFilter
Definition

Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.

ShortWhat codes are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-1: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
694. PlanDefinition.action:checkForImmediateReporting.input.codeFilter.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
696. PlanDefinition.action:checkForImmediateReporting.input.codeFilter.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.codeFilter.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
698. PlanDefinition.action:checkForImmediateReporting.input.codeFilter.path
Definition

The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.

ShortA code-valued attribute to filter on
Comments

The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
700. PlanDefinition.action:checkForImmediateReporting.input.codeFilter.searchParam
Definition

A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.

ShortA coded (token) parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
702. PlanDefinition.action:checkForImmediateReporting.input.codeFilter.valueSet
Definition

The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.

ShortValueset for the filter
Control0..1
Typecanonical(ValueSet)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
704. PlanDefinition.action:checkForImmediateReporting.input.codeFilter.code
Definition

The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.

ShortWhat code is expected
Control0..*
TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
706. PlanDefinition.action:checkForImmediateReporting.input.dateFilter
Definition

Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.

ShortWhat dates/date ranges are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-2: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
708. PlanDefinition.action:checkForImmediateReporting.input.dateFilter.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
710. PlanDefinition.action:checkForImmediateReporting.input.dateFilter.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.dateFilter.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
712. PlanDefinition.action:checkForImmediateReporting.input.dateFilter.path
Definition

The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.

ShortA date-valued attribute to filter on
Comments

The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
714. PlanDefinition.action:checkForImmediateReporting.input.dateFilter.searchParam
Definition

A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.

ShortA date valued parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
716. PlanDefinition.action:checkForImmediateReporting.input.dateFilter.value[x]
Definition

The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.

ShortThe value of the filter, as a Period, DateTime, or Duration value
Control0..1
TypeChoice of: dateTime, Period, Duration
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
718. PlanDefinition.action:checkForImmediateReporting.input.limit
Definition

Specifies a maximum number of results that are required (uses the _count search parameter).

ShortNumber of results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".

Control0..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
720. PlanDefinition.action:checkForImmediateReporting.input.sort
Definition

Specifies the order of the results to be returned.

ShortOrder of the results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.

Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
722. PlanDefinition.action:checkForImmediateReporting.input.sort.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
724. PlanDefinition.action:checkForImmediateReporting.input.sort.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.sort.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
726. PlanDefinition.action:checkForImmediateReporting.input.sort.path
Definition

The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.

ShortThe name of the attribute to perform the sort
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
728. PlanDefinition.action:checkForImmediateReporting.input.sort.direction
Definition

The direction of the sort, ascending or descending.

Shortascending | descending
Control1..1
BindingThe codes SHALL be taken from SortDirection
(required to http://hl7.org/fhir/ValueSet/sort-direction|4.0.1)

The possible sort directions, ascending or descending.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
730. PlanDefinition.action:checkForImmediateReporting.output
Definition

Defines the outputs of the action, if any.

ShortOutput data definition
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
732. PlanDefinition.action:checkForImmediateReporting.output.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
734. PlanDefinition.action:checkForImmediateReporting.output.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
736. PlanDefinition.action:checkForImmediateReporting.output.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypes
(required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
738. PlanDefinition.action:checkForImmediateReporting.output.profile
Definition

The profile of the required data, specified as the uri of the profile definition.

ShortThe profile of the required data
Control0..*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
740. PlanDefinition.action:checkForImmediateReporting.output.subject[x]
Definition

The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.

ShortE.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments

The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType
(extensible to http://hl7.org/fhir/ValueSet/subject-type|4.0.1)

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

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summarytrue
Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
742. PlanDefinition.action:checkForImmediateReporting.output.mustSupport
Definition

Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available.

The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).

ShortIndicates specific structure elements that are referenced by the knowledge module
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
744. PlanDefinition.action:checkForImmediateReporting.output.codeFilter
Definition

Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.

ShortWhat codes are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-1: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
746. PlanDefinition.action:checkForImmediateReporting.output.codeFilter.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
748. PlanDefinition.action:checkForImmediateReporting.output.codeFilter.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.codeFilter.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
750. PlanDefinition.action:checkForImmediateReporting.output.codeFilter.path
Definition

The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.

ShortA code-valued attribute to filter on
Comments

The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
752. PlanDefinition.action:checkForImmediateReporting.output.codeFilter.searchParam
Definition

A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.

ShortA coded (token) parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
754. PlanDefinition.action:checkForImmediateReporting.output.codeFilter.valueSet
Definition

The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.

ShortValueset for the filter
Control0..1
Typecanonical(ValueSet)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
756. PlanDefinition.action:checkForImmediateReporting.output.codeFilter.code
Definition

The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.

ShortWhat code is expected
Control0..*
TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
758. PlanDefinition.action:checkForImmediateReporting.output.dateFilter
Definition

Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.

ShortWhat dates/date ranges are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-2: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
760. PlanDefinition.action:checkForImmediateReporting.output.dateFilter.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
762. PlanDefinition.action:checkForImmediateReporting.output.dateFilter.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.dateFilter.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
764. PlanDefinition.action:checkForImmediateReporting.output.dateFilter.path
Definition

The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.

ShortA date-valued attribute to filter on
Comments

The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
766. PlanDefinition.action:checkForImmediateReporting.output.dateFilter.searchParam
Definition

A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.

ShortA date valued parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
768. PlanDefinition.action:checkForImmediateReporting.output.dateFilter.value[x]
Definition

The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.

ShortThe value of the filter, as a Period, DateTime, or Duration value
Control0..1
TypeChoice of: dateTime, Period, Duration
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
770. PlanDefinition.action:checkForImmediateReporting.output.limit
Definition

Specifies a maximum number of results that are required (uses the _count search parameter).

ShortNumber of results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".

Control0..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
772. PlanDefinition.action:checkForImmediateReporting.output.sort
Definition

Specifies the order of the results to be returned.

ShortOrder of the results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.

Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
774. PlanDefinition.action:checkForImmediateReporting.output.sort.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
776. PlanDefinition.action:checkForImmediateReporting.output.sort.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.sort.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
778. PlanDefinition.action:checkForImmediateReporting.output.sort.path
Definition

The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.

ShortThe name of the attribute to perform the sort
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
780. PlanDefinition.action:checkForImmediateReporting.output.sort.direction
Definition

The direction of the sort, ascending or descending.

Shortascending | descending
Control1..1
BindingThe codes SHALL be taken from SortDirection
(required to http://hl7.org/fhir/ValueSet/sort-direction|4.0.1)

The possible sort directions, ascending or descending.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
782. PlanDefinition.action:checkForImmediateReporting.relatedAction
Definition

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

ShortRelationship to another action
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.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
784. PlanDefinition.action:checkForImmediateReporting.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
786. PlanDefinition.action:checkForImmediateReporting.relatedAction.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
788. PlanDefinition.action:checkForImmediateReporting.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
790. PlanDefinition.action:checkForImmediateReporting.relatedAction.actionId
Definition

The element id of the related action.

ShortWhat action is this related to
Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
792. PlanDefinition.action:checkForImmediateReporting.relatedAction.relationship
Definition

The relationship of this action to the related action.

Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control1..1
BindingThe codes SHALL be taken from ActionRelationshipType
(required to http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1)

Defines the types of relationships between actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
794. PlanDefinition.action:checkForImmediateReporting.relatedAction.offset[x]
Definition

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

ShortTime offset for the relationship
Control0..1
TypeChoice of: Duration, Range
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action.relatedAction.offset[x]. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this
796. PlanDefinition.action:checkForImmediateReporting.relatedAction.offset[x]:offsetDuration
Slice NameoffsetDuration
Definition

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

ShortTime offset for the relationship
Control0..1
TypeDuration
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
798. PlanDefinition.action:checkForImmediateReporting.timing[x]
Definition

An optional value describing when the action should be performed.

ShortWhen the action should take place
Control0..1
TypeDuration
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
800. PlanDefinition.action:checkForImmediateReporting.participant
Definition

Indicates who should participate in performing the action described.

ShortWho should participate in the action
Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
802. PlanDefinition.action:checkForImmediateReporting.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
804. PlanDefinition.action:checkForImmediateReporting.participant.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
806. PlanDefinition.action:checkForImmediateReporting.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
808. PlanDefinition.action:checkForImmediateReporting.participant.type
Definition

The type of participant in the action.

Shortpatient | practitioner | related-person | device
Control1..1
BindingThe codes SHALL be taken from ActionParticipantType
(required to http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1)

The type of participant for the action.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
810. PlanDefinition.action:checkForImmediateReporting.participant.role
Definition

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

ShortE.g. Nurse, Surgeon, Parent
Control0..1
BindingFor example codes, see ActionParticipantRole
(example to http://hl7.org/fhir/ValueSet/action-participant-role)

Defines roles played by participants for the action.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
812. PlanDefinition.action:checkForImmediateReporting.type
Definition

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

Shortcreate | update | remove | fire-event
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ActionType
(extensible to http://hl7.org/fhir/ValueSet/action-type)

The type of action to be performed.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
814. PlanDefinition.action:checkForImmediateReporting.groupingBehavior
Definition

Defines the grouping behavior for the action and its children.

Shortvisual-group | logical-group | sentence-group
Control0..1
BindingThe codes SHALL be taken from ActionGroupingBehavior
(required to http://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.1)

Defines organization behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
816. PlanDefinition.action:checkForImmediateReporting.selectionBehavior
Definition

Defines the selection behavior for the action and its children.

Shortany | all | all-or-none | exactly-one | at-most-one | one-or-more
Control0..1
BindingThe codes SHALL be taken from ActionSelectionBehavior
(required to http://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.1)

Defines selection behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
818. PlanDefinition.action:checkForImmediateReporting.requiredBehavior
Definition

Defines the required behavior for the action.

Shortmust | could | must-unless-documented
Control0..1
BindingThe codes SHALL be taken from ActionRequiredBehavior
(required to http://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1)

Defines expectations around whether an action or action group is required.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
820. PlanDefinition.action:checkForImmediateReporting.precheckBehavior
Definition

Defines whether the action should usually be preselected.

Shortyes | no
Control0..1
BindingThe codes SHALL be taken from ActionPrecheckBehavior
(required to http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1)

Defines selection frequency behavior for an action or group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
822. PlanDefinition.action:checkForImmediateReporting.cardinalityBehavior
Definition

Defines whether the action can be selected multiple times.

Shortsingle | multiple
Control0..1
BindingThe codes SHALL be taken from ActionCardinalityBehavior
(required to http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1)

Defines behavior for an action or a group for how many times that item may be repeated.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
824. PlanDefinition.action:checkForImmediateReporting.definition[x]
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.

ShortDescription of the activity to be performed
Comments

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

Control0..1
TypeChoice of: canonical(ActivityDefinition, PlanDefinition, Questionnaire), uri
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
826. PlanDefinition.action:checkForImmediateReporting.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.

ShortTransform to apply the template
Comments

Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..1
Typecanonical(StructureMap)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
828. PlanDefinition.action:checkForImmediateReporting.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.

ShortDynamic aspects of the definition
Comments

Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
830. PlanDefinition.action:checkForImmediateReporting.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
832. PlanDefinition.action:checkForImmediateReporting.dynamicValue.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
834. PlanDefinition.action:checkForImmediateReporting.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
836. PlanDefinition.action:checkForImmediateReporting.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. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details).

ShortThe path to the element to be set dynamically
Comments

To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
838. PlanDefinition.action:checkForImmediateReporting.dynamicValue.expression
Definition

An expression specifying the value of the customized element.

ShortAn expression that provides the dynamic value for the customization
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
840. PlanDefinition.action:checkForImmediateReporting.action
Definition

Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.

ShortA sub-action
Control4..*
TypeSeettp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action.action. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ id
842. PlanDefinition.action:checkForImmediateReporting.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
844. PlanDefinition.action:checkForImmediateReporting.action.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
846. PlanDefinition.action:checkForImmediateReporting.action.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
848. PlanDefinition.action:checkForImmediateReporting.action.prefix
Definition

A user-visible prefix for the action.

ShortUser-visible prefix for the action (e.g. 1. or A.)
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
850. PlanDefinition.action:checkForImmediateReporting.action.title
Definition

The title of the action displayed to a user.

ShortUser-visible title
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
852. PlanDefinition.action:checkForImmediateReporting.action.description
Definition

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

ShortBrief description of the action
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
854. PlanDefinition.action:checkForImmediateReporting.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 might not be capable of interpreting it dynamically.

ShortStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
856. PlanDefinition.action:checkForImmediateReporting.action.priority
Definition

Indicates how quickly the action should be addressed with respect to other actions.

Shortroutine | urgent | asap | stat
Control0..1
BindingThe codes SHALL be taken from RequestPriority
(required to http://hl7.org/fhir/ValueSet/request-priority|4.0.1)

Identifies the level of importance to be assigned to actioning the request.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
858. PlanDefinition.action:checkForImmediateReporting.action.code
Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control0..1
BindingUnless not suitable, these codes SHALL be taken from US Public Health ValueSet - PlanDefinition Action
(extensible to http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-plandefinition-action)

The set of actions that can be used to create plan definition

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
860. PlanDefinition.action:checkForImmediateReporting.action.reason
Definition

A description of why this action is necessary or appropriate.

ShortWhy the action should be performed
Comments

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

Control0..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
862. PlanDefinition.action:checkForImmediateReporting.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.

ShortSupporting documentation for the intended performer of the action
Control0..*
TypeRelatedArtifact
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
864. PlanDefinition.action:checkForImmediateReporting.action.goalId
Definition

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

ShortWhat goals this action supports
Control0..*
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
866. PlanDefinition.action:checkForImmediateReporting.action.subject[x]
Definition

A code or group definition that describes the intended subject of the action and its children, if any.

ShortType of individual the action is focused on
Comments

The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified.

In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType
(extensible to http://hl7.org/fhir/ValueSet/subject-type)

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

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Requirements

Multiple steps in a protocol often have different groups of steps that are focused on testing different things. The subject of an action specifies the focus of the action and any child actions.

Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
868. PlanDefinition.action:checkForImmediateReporting.action.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
870. PlanDefinition.action:checkForImmediateReporting.action.trigger.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
872. PlanDefinition.action:checkForImmediateReporting.action.trigger.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control1..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.action.trigger.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
874. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable
Slice NameisEncounterImmediatelyReportable
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.

ShortA sub-action
Control1..1
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
876. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.id
Definition

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

ShortUnique id for inter-element referencing
Control1..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "id" : "is-encounter-immediately-reportable"
}
<id value="is-encounter-immediately-reportable"/>
878. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
880. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
882. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.prefix
Definition

A user-visible prefix for the action.

ShortUser-visible prefix for the action (e.g. 1. or A.)
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
884. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.title
Definition

The title of the action displayed to a user.

ShortUser-visible title
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
886. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.description
Definition

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

ShortBrief description of the action
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
888. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.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 might not be capable of interpreting it dynamically.

ShortStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
890. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.priority
Definition

Indicates how quickly the action should be addressed with respect to other actions.

Shortroutine | urgent | asap | stat
Control0..1
BindingThe codes SHALL be taken from RequestPriority
(required to http://hl7.org/fhir/ValueSet/request-priority|4.0.1)

Identifies the level of importance to be assigned to actioning the request.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
892. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.code
Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control1..*
TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "check-trigger-codes"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="check-trigger-codes"/>
  </coding>
</code>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
894. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.reason
Definition

A description of why this action is necessary or appropriate.

ShortWhy the action should be performed
Comments

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

Control0..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
896. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.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.

ShortSupporting documentation for the intended performer of the action
Control0..*
TypeRelatedArtifact
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
898. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.goalId
Definition

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

ShortWhat goals this action supports
Control0..*
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
900. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.subject[x]
Definition

A code or group definition that describes the intended subject of the action and its children, if any.

ShortType of individual the action is focused on
Comments

The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified.

In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType
(extensible to http://hl7.org/fhir/ValueSet/subject-type|4.0.1)

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

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Requirements

Multiple steps in a protocol often have different groups of steps that are focused on testing different things. The subject of an action specifies the focus of the action and any child actions.

Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
902. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
904. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.condition
Definition

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

ShortWhether or not the action is applicable
Comments

When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
906. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
908. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.condition.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
910. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
912. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.condition.kind
Definition

The kind of condition.

Shortapplicability | start | stop
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 enter/exit criteria for an action.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKind
(required to http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1)

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Value
{
  "kind" : "applicability"
}
<kind value="applicability"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
914. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.condition.expression
Definition

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

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control1..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
916. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.condition.expression.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
918. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.condition.expression.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.action.condition.expression.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
920. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.condition.expression.description
Definition

A brief, natural language description of the condition that effectively communicates the intended semantics.

ShortNatural language description of the condition
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
922. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.condition.expression.name
Definition

A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.

ShortShort name assigned to expression for reuse
Control0..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
924. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.condition.expression.language
Definition

The media type of the language for the expression.

Shorttext/cql | text/fhirpath | application/x-fhir-query | etc.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from ExpressionLanguage
(extensible to http://hl7.org/fhir/ValueSet/expression-language|4.0.1)

The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Fixed Value
{
  "language" : "text/fhirpath"
}
<language value="text/fhirpath"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
926. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.condition.expression.expression
Definition

An expression in the specified language that returns a value.

ShortExpression in specified language
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
928. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.condition.expression.reference
Definition

A URI that defines where the expression is found.

ShortWhere the expression is found
Comments

If both a reference and an expression is found, the reference SHALL point to the same expression.

Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
930. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.input
Definition

Defines input data requirements for the action. Required data is accessible via a context variable named '%[id]' using the 'id' of the input data requirement

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
932. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.input.id
Definition

The id of the input requirement, allowing the data to be referenced via a context variable named '%[id]'

ShortUnique id for inter-element referencing
Control1..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
934. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.input.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.action.input.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
936. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.input.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypes
(required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
938. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.input.profile
Definition

The profile of the required data, specified as the uri of the profile definition.

ShortThe profile of the required data
Control0..*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
940. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.input.subject[x]
Definition

The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.

ShortE.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments

The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType
(extensible to http://hl7.org/fhir/ValueSet/subject-type|4.0.1)

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

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summarytrue
Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
942. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.input.mustSupport
Definition

Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available.

The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).

ShortIndicates specific structure elements that are referenced by the knowledge module
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
944. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.input.codeFilter
Definition

Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.

ShortWhat codes are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-1: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
946. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.input.codeFilter.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
948. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.input.codeFilter.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.action.input.codeFilter.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
950. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.input.codeFilter.path
Definition

The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.

ShortA code-valued attribute to filter on
Comments

The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
952. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.input.codeFilter.searchParam
Definition

A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.

ShortA coded (token) parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
954. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.input.codeFilter.valueSet
Definition

The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.

ShortValueset for the filter
Control0..1
Typecanonical(ValueSet)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
956. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.input.codeFilter.code
Definition

The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.

ShortWhat code is expected
Control0..*
TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
958. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.input.dateFilter
Definition

Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.

ShortWhat dates/date ranges are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-2: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
960. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.input.dateFilter.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
962. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.input.dateFilter.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.action.input.dateFilter.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
964. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.input.dateFilter.path
Definition

The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.

ShortA date-valued attribute to filter on
Comments

The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
966. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.input.dateFilter.searchParam
Definition

A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.

ShortA date valued parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
968. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.input.dateFilter.value[x]
Definition

The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.

ShortThe value of the filter, as a Period, DateTime, or Duration value
Control0..1
TypeChoice of: dateTime, Period, Duration
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
970. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.input.limit
Definition

Specifies a maximum number of results that are required (uses the _count search parameter).

ShortNumber of results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".

Control0..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
972. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.input.sort
Definition

Specifies the order of the results to be returned.

ShortOrder of the results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.

Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
974. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.input.sort.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
976. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.input.sort.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.action.input.sort.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
978. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.input.sort.path
Definition

The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.

ShortThe name of the attribute to perform the sort
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
980. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.input.sort.direction
Definition

The direction of the sort, ascending or descending.

Shortascending | descending
Control1..1
BindingThe codes SHALL be taken from SortDirection
(required to http://hl7.org/fhir/ValueSet/sort-direction|4.0.1)

The possible sort directions, ascending or descending.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
982. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.output
Definition

Defines the outputs of the action, if any.

ShortOutput data definition
Control0..*
TypeDataRequirement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
984. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.relatedAction
Definition

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

ShortRelationship to another action
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.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
986. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
988. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.relatedAction.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
990. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
992. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.relatedAction.actionId
Definition

The element id of the related action.

ShortWhat action is this related to
Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Value
{
  "actionId" : "create-eicr"
}
<actionId value="create-eicr"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
994. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.relatedAction.relationship
Definition

The relationship of this action to the related action.

Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control1..1
BindingThe codes SHALL be taken from ActionRelationshipType
(required to http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1)

Defines the types of relationships between actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Value
{
  "relationship" : "before-start"
}
<relationship value="before-start"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
996. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.relatedAction.offset[x]
Definition

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

ShortTime offset for the relationship
Control0..1
TypeChoice of: Duration, Range
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
998. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.timing[x]
Definition

An optional value describing when the action should be performed.

ShortWhen the action should take place
Control0..1
TypeChoice of: dateTime, Age, Period, Duration, Range, Timing
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1000. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.participant
Definition

Indicates who should participate in performing the action described.

ShortWho should participate in the action
Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1002. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1004. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.participant.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1006. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1008. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.participant.type
Definition

The type of participant in the action.

Shortpatient | practitioner | related-person | device
Control1..1
BindingThe codes SHALL be taken from ActionParticipantType
(required to http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1)

The type of participant for the action.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1010. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.participant.role
Definition

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

ShortE.g. Nurse, Surgeon, Parent
Control0..1
BindingFor example codes, see ActionParticipantRole
(example to http://hl7.org/fhir/ValueSet/action-participant-role|4.0.1)

Defines roles played by participants for the action.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1012. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.type
Definition

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

Shortcreate | update | remove | fire-event
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ActionType
(extensible to http://hl7.org/fhir/ValueSet/action-type|4.0.1)

The type of action to be performed.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1014. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.groupingBehavior
Definition

Defines the grouping behavior for the action and its children.

Shortvisual-group | logical-group | sentence-group
Control0..1
BindingThe codes SHALL be taken from ActionGroupingBehavior
(required to http://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.1)

Defines organization behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1016. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.selectionBehavior
Definition

Defines the selection behavior for the action and its children.

Shortany | all | all-or-none | exactly-one | at-most-one | one-or-more
Control0..1
BindingThe codes SHALL be taken from ActionSelectionBehavior
(required to http://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.1)

Defines selection behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1018. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.requiredBehavior
Definition

Defines the required behavior for the action.

Shortmust | could | must-unless-documented
Control0..1
BindingThe codes SHALL be taken from ActionRequiredBehavior
(required to http://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1)

Defines expectations around whether an action or action group is required.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1020. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.precheckBehavior
Definition

Defines whether the action should usually be preselected.

Shortyes | no
Control0..1
BindingThe codes SHALL be taken from ActionPrecheckBehavior
(required to http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1)

Defines selection frequency behavior for an action or group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1022. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.cardinalityBehavior
Definition

Defines whether the action can be selected multiple times.

Shortsingle | multiple
Control0..1
BindingThe codes SHALL be taken from ActionCardinalityBehavior
(required to http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1)

Defines behavior for an action or a group for how many times that item may be repeated.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1024. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.definition[x]
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.

ShortDescription of the activity to be performed
Comments

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

Control0..1
TypeChoice of: canonical(ActivityDefinition, PlanDefinition, Questionnaire), uri
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1026. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.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.

ShortTransform to apply the template
Comments

Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..1
Typecanonical(StructureMap)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1028. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.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.

ShortDynamic aspects of the definition
Comments

Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1030. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1032. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.dynamicValue.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1034. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1036. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.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. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details).

ShortThe path to the element to be set dynamically
Comments

To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1038. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.dynamicValue.expression
Definition

An expression specifying the value of the customized element.

ShortAn expression that provides the dynamic value for the customization
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1040. PlanDefinition.action:checkForImmediateReporting.action:isEncounterImmediatelyReportable.action
Definition

Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.

ShortA sub-action
Control0..*
TypeSeettp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1042. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable
Slice NamecontinueCheckReportable
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.

ShortA sub-action
Control1..1
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1044. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.id
Definition

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

ShortUnique id for inter-element referencing
Control1..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "id" : "continue-check-reportable"
}
<id value="continue-check-reportable"/>
1046. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1048. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1050. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.prefix
Definition

A user-visible prefix for the action.

ShortUser-visible prefix for the action (e.g. 1. or A.)
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1052. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.title
Definition

The title of the action displayed to a user.

ShortUser-visible title
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1054. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.description
Definition

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

ShortBrief description of the action
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1056. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.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 might not be capable of interpreting it dynamically.

ShortStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1058. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.priority
Definition

Indicates how quickly the action should be addressed with respect to other actions.

Shortroutine | urgent | asap | stat
Control0..1
BindingThe codes SHALL be taken from RequestPriority
(required to http://hl7.org/fhir/ValueSet/request-priority|4.0.1)

Identifies the level of importance to be assigned to actioning the request.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1060. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.code
Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control1..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "evaluate-condition"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="evaluate-condition"/>
  </coding>
</code>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1062. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.reason
Definition

A description of why this action is necessary or appropriate.

ShortWhy the action should be performed
Comments

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

Control0..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1064. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.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.

ShortSupporting documentation for the intended performer of the action
Control0..*
TypeRelatedArtifact
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1066. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.goalId
Definition

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

ShortWhat goals this action supports
Control0..*
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1068. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.subject[x]
Definition

A code or group definition that describes the intended subject of the action and its children, if any.

ShortType of individual the action is focused on
Comments

The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified.

In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType
(extensible to http://hl7.org/fhir/ValueSet/subject-type|4.0.1)

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

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Requirements

Multiple steps in a protocol often have different groups of steps that are focused on testing different things. The subject of an action specifies the focus of the action and any child actions.

Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1070. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1072. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.condition
Definition

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

ShortWhether or not the action is applicable
Comments

When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1074. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1076. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.condition.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1078. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1080. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.condition.kind
Definition

The kind of condition.

Shortapplicability | start | stop
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 enter/exit criteria for an action.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKind
(required to http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1)

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Value
{
  "kind" : "applicability"
}
<kind value="applicability"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1082. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.condition.expression
Definition

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

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control1..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1084. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.condition.expression.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1086. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.condition.expression.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.action.condition.expression.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1088. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.condition.expression.description
Definition

A brief, natural language description of the condition that effectively communicates the intended semantics.

ShortNatural language description of the condition
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1090. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.condition.expression.name
Definition

A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.

ShortShort name assigned to expression for reuse
Control0..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1092. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.condition.expression.language
Definition

The media type of the language for the expression.

Shorttext/cql | text/fhirpath | application/x-fhir-query | etc.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from ExpressionLanguage
(extensible to http://hl7.org/fhir/ValueSet/expression-language|4.0.1)

The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Fixed Value
{
  "language" : "text/fhirpath"
}
<language value="text/fhirpath"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1094. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.condition.expression.expression
Definition

An expression in the specified language that returns a value.

ShortExpression in specified language
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1096. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.condition.expression.reference
Definition

A URI that defines where the expression is found.

ShortWhere the expression is found
Comments

If both a reference and an expression is found, the reference SHALL point to the same expression.

Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1098. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.input
Definition

Defines input data requirements for the action.

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1100. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.output
Definition

Defines the outputs of the action, if any.

ShortOutput data definition
Control0..*
TypeDataRequirement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1102. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.relatedAction
Definition

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

ShortRelationship to another action
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.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1104. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1106. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.relatedAction.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1108. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1110. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.relatedAction.actionId
Definition

The element id of the related action.

ShortWhat action is this related to
Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Value
{
  "actionId" : "check-reportable"
}
<actionId value="check-reportable"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1112. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.relatedAction.relationship
Definition

The relationship of this action to the related action.

Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control1..1
BindingThe codes SHALL be taken from ActionRelationshipType
(required to http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1)

Defines the types of relationships between actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Value
{
  "relationship" : "before-start"
}
<relationship value="before-start"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1114. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.relatedAction.offset[x]
Definition

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

ShortTime offset for the relationship
Control0..1
TypeChoice of: Duration, Range
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action.action.relatedAction.offset[x]. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this

Slicing Note: Other type slices that contain no new information are not shown in this view

1116. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.relatedAction.offset[x]:offsetDuration
Slice NameoffsetDuration
Definition

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

ShortTime offset for the relationship
Control0..1
TypeDuration
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
ExampleWait 6 hours before next action.: { "value" : 6, "unit" : "h" }
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1119. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.timing[x]
Definition

An optional value describing when the action should be performed.

ShortWhen the action should take place
Control0..1
TypeChoice of: dateTime, Age, Period, Duration, Range, Timing
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1121. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.participant
Definition

Indicates who should participate in performing the action described.

ShortWho should participate in the action
Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1123. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1125. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.participant.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1127. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1129. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.participant.type
Definition

The type of participant in the action.

Shortpatient | practitioner | related-person | device
Control1..1
BindingThe codes SHALL be taken from ActionParticipantType
(required to http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1)

The type of participant for the action.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1131. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.participant.role
Definition

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

ShortE.g. Nurse, Surgeon, Parent
Control0..1
BindingFor example codes, see ActionParticipantRole
(example to http://hl7.org/fhir/ValueSet/action-participant-role|4.0.1)

Defines roles played by participants for the action.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1133. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.type
Definition

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

Shortcreate | update | remove | fire-event
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ActionType
(extensible to http://hl7.org/fhir/ValueSet/action-type|4.0.1)

The type of action to be performed.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1135. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.groupingBehavior
Definition

Defines the grouping behavior for the action and its children.

Shortvisual-group | logical-group | sentence-group
Control0..1
BindingThe codes SHALL be taken from ActionGroupingBehavior
(required to http://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.1)

Defines organization behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1137. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.selectionBehavior
Definition

Defines the selection behavior for the action and its children.

Shortany | all | all-or-none | exactly-one | at-most-one | one-or-more
Control0..1
BindingThe codes SHALL be taken from ActionSelectionBehavior
(required to http://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.1)

Defines selection behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1139. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.requiredBehavior
Definition

Defines the required behavior for the action.

Shortmust | could | must-unless-documented
Control0..1
BindingThe codes SHALL be taken from ActionRequiredBehavior
(required to http://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1)

Defines expectations around whether an action or action group is required.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1141. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.precheckBehavior
Definition

Defines whether the action should usually be preselected.

Shortyes | no
Control0..1
BindingThe codes SHALL be taken from ActionPrecheckBehavior
(required to http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1)

Defines selection frequency behavior for an action or group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1143. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.cardinalityBehavior
Definition

Defines whether the action can be selected multiple times.

Shortsingle | multiple
Control0..1
BindingThe codes SHALL be taken from ActionCardinalityBehavior
(required to http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1)

Defines behavior for an action or a group for how many times that item may be repeated.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1145. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.definition[x]
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.

ShortDescription of the activity to be performed
Comments

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

Control0..1
TypeChoice of: canonical(ActivityDefinition, PlanDefinition, Questionnaire), uri
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1147. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.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.

ShortTransform to apply the template
Comments

Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..1
Typecanonical(StructureMap)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1149. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.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.

ShortDynamic aspects of the definition
Comments

Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1151. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1153. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.dynamicValue.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1155. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1157. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.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. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details).

ShortThe path to the element to be set dynamically
Comments

To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1159. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.dynamicValue.expression
Definition

An expression specifying the value of the customized element.

ShortAn expression that provides the dynamic value for the customization
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1161. PlanDefinition.action:checkForImmediateReporting.action:continueCheckReportable.action
Definition

Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.

ShortA sub-action
Control0..*
TypeSeettp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1163. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter
Slice NameterminateLateEncounter
Definition

Terminates the reporting workflow for an encounter that is still in progress beyond the normal reporting duration, or that ended more than the post-encounter grace period ago.

ShortTerminate a late encounter
Control1..1
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1165. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.id
Definition

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

ShortUnique id for inter-element referencing
Control1..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "id" : "terminate-late-encounter"
}
<id value="terminate-late-encounter"/>
1167. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1169. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1171. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.prefix
Definition

A user-visible prefix for the action.

ShortUser-visible prefix for the action (e.g. 1. or A.)
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1173. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.title
Definition

The title of the action displayed to a user.

ShortUser-visible title
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1175. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.description
Definition

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

ShortBrief description of the action
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1177. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.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 might not be capable of interpreting it dynamically.

ShortStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1179. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.priority
Definition

Indicates how quickly the action should be addressed with respect to other actions.

Shortroutine | urgent | asap | stat
Control0..1
BindingThe codes SHALL be taken from RequestPriority
(required to http://hl7.org/fhir/ValueSet/request-priority|4.0.1)

Identifies the level of importance to be assigned to actioning the request.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1181. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.code
Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control1..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "terminate-reporting-workflow"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="terminate-reporting-workflow"/>
  </coding>
</code>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1183. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.reason
Definition

A description of why this action is necessary or appropriate.

ShortWhy the action should be performed
Comments

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

Control0..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1185. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.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.

ShortSupporting documentation for the intended performer of the action
Control0..*
TypeRelatedArtifact
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1187. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.goalId
Definition

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

ShortWhat goals this action supports
Control0..*
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1189. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.subject[x]
Definition

A code or group definition that describes the intended subject of the action and its children, if any.

ShortType of individual the action is focused on
Comments

The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified.

In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType
(extensible to http://hl7.org/fhir/ValueSet/subject-type|4.0.1)

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

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Requirements

Multiple steps in a protocol often have different groups of steps that are focused on testing different things. The subject of an action specifies the focus of the action and any child actions.

Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1191. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1193. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.condition
Definition

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

ShortWhether or not the action is applicable
Comments

When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1195. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1197. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.condition.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1199. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1201. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.condition.kind
Definition

The kind of condition.

Shortapplicability | start | stop
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 enter/exit criteria for an action.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKind
(required to http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1)

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Value
{
  "kind" : "applicability"
}
<kind value="applicability"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1203. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.condition.expression
Definition

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

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control1..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1205. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.condition.expression.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1207. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.condition.expression.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.action.condition.expression.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1209. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.condition.expression.description
Definition

A brief, natural language description of the condition that effectively communicates the intended semantics.

ShortNatural language description of the condition
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1211. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.condition.expression.name
Definition

A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.

ShortShort name assigned to expression for reuse
Control0..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1213. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.condition.expression.language
Definition

The media type of the language for the expression.

Shorttext/cql | text/fhirpath | application/x-fhir-query | etc.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from ExpressionLanguage
(extensible to http://hl7.org/fhir/ValueSet/expression-language|4.0.1)

The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Fixed Value
{
  "language" : "text/fhirpath"
}
<language value="text/fhirpath"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1215. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.condition.expression.expression
Definition

An expression in the specified language that returns a value.

ShortExpression in specified language
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1217. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.condition.expression.reference
Definition

A URI that defines where the expression is found.

ShortWhere the expression is found
Comments

If both a reference and an expression is found, the reference SHALL point to the same expression.

Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1219. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.input
Definition

Defines input data requirements for the action.

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1221. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.output
Definition

Defines the outputs of the action, if any.

ShortOutput data definition
Control0..*
TypeDataRequirement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1223. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.relatedAction
Definition

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

ShortRelationship to another action
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.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1225. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1227. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.relatedAction.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1229. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1231. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.relatedAction.actionId
Definition

The element id of the related action.

ShortWhat action is this related to
Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1233. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.relatedAction.relationship
Definition

The relationship of this action to the related action.

Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control1..1
BindingThe codes SHALL be taken from ActionRelationshipType
(required to http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1)

Defines the types of relationships between actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1235. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.relatedAction.offset[x]
Definition

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

ShortTime offset for the relationship
Control0..1
TypeChoice of: Duration, Range
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1237. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.timing[x]
Definition

An optional value describing when the action should be performed.

ShortWhen the action should take place
Control0..1
TypeChoice of: dateTime, Age, Period, Duration, Range, Timing
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1239. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.participant
Definition

Indicates who should participate in performing the action described.

ShortWho should participate in the action
Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1241. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1243. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.participant.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1245. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1247. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.participant.type
Definition

The type of participant in the action.

Shortpatient | practitioner | related-person | device
Control1..1
BindingThe codes SHALL be taken from ActionParticipantType
(required to http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1)

The type of participant for the action.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1249. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.participant.role
Definition

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

ShortE.g. Nurse, Surgeon, Parent
Control0..1
BindingFor example codes, see ActionParticipantRole
(example to http://hl7.org/fhir/ValueSet/action-participant-role|4.0.1)

Defines roles played by participants for the action.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1251. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.type
Definition

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

Shortcreate | update | remove | fire-event
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ActionType
(extensible to http://hl7.org/fhir/ValueSet/action-type|4.0.1)

The type of action to be performed.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1253. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.groupingBehavior
Definition

Defines the grouping behavior for the action and its children.

Shortvisual-group | logical-group | sentence-group
Control0..1
BindingThe codes SHALL be taken from ActionGroupingBehavior
(required to http://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.1)

Defines organization behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1255. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.selectionBehavior
Definition

Defines the selection behavior for the action and its children.

Shortany | all | all-or-none | exactly-one | at-most-one | one-or-more
Control0..1
BindingThe codes SHALL be taken from ActionSelectionBehavior
(required to http://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.1)

Defines selection behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1257. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.requiredBehavior
Definition

Defines the required behavior for the action.

Shortmust | could | must-unless-documented
Control0..1
BindingThe codes SHALL be taken from ActionRequiredBehavior
(required to http://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1)

Defines expectations around whether an action or action group is required.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1259. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.precheckBehavior
Definition

Defines whether the action should usually be preselected.

Shortyes | no
Control0..1
BindingThe codes SHALL be taken from ActionPrecheckBehavior
(required to http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1)

Defines selection frequency behavior for an action or group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1261. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.cardinalityBehavior
Definition

Defines whether the action can be selected multiple times.

Shortsingle | multiple
Control0..1
BindingThe codes SHALL be taken from ActionCardinalityBehavior
(required to http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1)

Defines behavior for an action or a group for how many times that item may be repeated.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1263. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.definition[x]
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.

ShortDescription of the activity to be performed
Comments

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

Control0..1
TypeChoice of: canonical(ActivityDefinition, PlanDefinition, Questionnaire), uri
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1265. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.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.

ShortTransform to apply the template
Comments

Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..1
Typecanonical(StructureMap)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1267. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.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.

ShortDynamic aspects of the definition
Comments

Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1269. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1271. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.dynamicValue.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1273. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1275. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.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. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details).

ShortThe path to the element to be set dynamically
Comments

To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1277. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.dynamicValue.expression
Definition

An expression specifying the value of the customized element.

ShortAn expression that provides the dynamic value for the customization
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1279. PlanDefinition.action:checkForImmediateReporting.action:terminateLateEncounter.action
Definition

Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.

ShortA sub-action
Control0..*
TypeSeettp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1281. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted
Slice NameisLateEncounterCompleted
Definition

Records completion of reporting for an encounter that finished after its reporting window had elapsed. Ambulatory encounters use the ambulatory reporting duration; inpatient encounters use the normal reporting duration.

ShortLate encounter completed
Control1..1
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1283. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.id
Definition

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

ShortUnique id for inter-element referencing
Control1..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "id" : "is-late-encounter-completed"
}
<id value="is-late-encounter-completed"/>
1285. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1287. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1289. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.prefix
Definition

A user-visible prefix for the action.

ShortUser-visible prefix for the action (e.g. 1. or A.)
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1291. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.title
Definition

The title of the action displayed to a user.

ShortUser-visible title
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1293. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.description
Definition

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

ShortBrief description of the action
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1295. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.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 might not be capable of interpreting it dynamically.

ShortStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1297. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.priority
Definition

Indicates how quickly the action should be addressed with respect to other actions.

Shortroutine | urgent | asap | stat
Control0..1
BindingThe codes SHALL be taken from RequestPriority
(required to http://hl7.org/fhir/ValueSet/request-priority|4.0.1)

Identifies the level of importance to be assigned to actioning the request.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1299. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.code
Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control1..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "complete-reporting"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="complete-reporting"/>
  </coding>
</code>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1301. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.reason
Definition

A description of why this action is necessary or appropriate.

ShortWhy the action should be performed
Comments

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

Control0..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1303. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.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.

ShortSupporting documentation for the intended performer of the action
Control0..*
TypeRelatedArtifact
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1305. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.goalId
Definition

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

ShortWhat goals this action supports
Control0..*
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1307. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.subject[x]
Definition

A code or group definition that describes the intended subject of the action and its children, if any.

ShortType of individual the action is focused on
Comments

The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified.

In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType
(extensible to http://hl7.org/fhir/ValueSet/subject-type|4.0.1)

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

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Requirements

Multiple steps in a protocol often have different groups of steps that are focused on testing different things. The subject of an action specifies the focus of the action and any child actions.

Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1309. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1311. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.condition
Definition

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

ShortWhether or not the action is applicable
Comments

When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1313. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1315. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.condition.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1317. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1319. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.condition.kind
Definition

The kind of condition.

Shortapplicability | start | stop
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 enter/exit criteria for an action.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKind
(required to http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1)

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Value
{
  "kind" : "applicability"
}
<kind value="applicability"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1321. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.condition.expression
Definition

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

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control1..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1323. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.condition.expression.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1325. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.condition.expression.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.action.condition.expression.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1327. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.condition.expression.description
Definition

A brief, natural language description of the condition that effectively communicates the intended semantics.

ShortNatural language description of the condition
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1329. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.condition.expression.name
Definition

A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.

ShortShort name assigned to expression for reuse
Control0..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1331. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.condition.expression.language
Definition

The media type of the language for the expression.

Shorttext/cql | text/fhirpath | application/x-fhir-query | etc.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from ExpressionLanguage
(extensible to http://hl7.org/fhir/ValueSet/expression-language|4.0.1)

The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Fixed Value
{
  "language" : "text/fhirpath"
}
<language value="text/fhirpath"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1333. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.condition.expression.expression
Definition

An expression in the specified language that returns a value.

ShortExpression in specified language
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1335. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.condition.expression.reference
Definition

A URI that defines where the expression is found.

ShortWhere the expression is found
Comments

If both a reference and an expression is found, the reference SHALL point to the same expression.

Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1337. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.input
Definition

Defines input data requirements for the action.

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1339. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.output
Definition

Defines the outputs of the action, if any.

ShortOutput data definition
Control0..*
TypeDataRequirement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1341. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.relatedAction
Definition

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

ShortRelationship to another action
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.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1343. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1345. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.relatedAction.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1347. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1349. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.relatedAction.actionId
Definition

The element id of the related action.

ShortWhat action is this related to
Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1351. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.relatedAction.relationship
Definition

The relationship of this action to the related action.

Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control1..1
BindingThe codes SHALL be taken from ActionRelationshipType
(required to http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1)

Defines the types of relationships between actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1353. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.relatedAction.offset[x]
Definition

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

ShortTime offset for the relationship
Control0..1
TypeChoice of: Duration, Range
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1355. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.timing[x]
Definition

An optional value describing when the action should be performed.

ShortWhen the action should take place
Control0..1
TypeChoice of: dateTime, Age, Period, Duration, Range, Timing
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1357. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.participant
Definition

Indicates who should participate in performing the action described.

ShortWho should participate in the action
Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1359. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1361. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.participant.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1363. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1365. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.participant.type
Definition

The type of participant in the action.

Shortpatient | practitioner | related-person | device
Control1..1
BindingThe codes SHALL be taken from ActionParticipantType
(required to http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1)

The type of participant for the action.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1367. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.participant.role
Definition

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

ShortE.g. Nurse, Surgeon, Parent
Control0..1
BindingFor example codes, see ActionParticipantRole
(example to http://hl7.org/fhir/ValueSet/action-participant-role|4.0.1)

Defines roles played by participants for the action.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1369. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.type
Definition

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

Shortcreate | update | remove | fire-event
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ActionType
(extensible to http://hl7.org/fhir/ValueSet/action-type|4.0.1)

The type of action to be performed.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1371. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.groupingBehavior
Definition

Defines the grouping behavior for the action and its children.

Shortvisual-group | logical-group | sentence-group
Control0..1
BindingThe codes SHALL be taken from ActionGroupingBehavior
(required to http://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.1)

Defines organization behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1373. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.selectionBehavior
Definition

Defines the selection behavior for the action and its children.

Shortany | all | all-or-none | exactly-one | at-most-one | one-or-more
Control0..1
BindingThe codes SHALL be taken from ActionSelectionBehavior
(required to http://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.1)

Defines selection behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1375. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.requiredBehavior
Definition

Defines the required behavior for the action.

Shortmust | could | must-unless-documented
Control0..1
BindingThe codes SHALL be taken from ActionRequiredBehavior
(required to http://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1)

Defines expectations around whether an action or action group is required.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1377. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.precheckBehavior
Definition

Defines whether the action should usually be preselected.

Shortyes | no
Control0..1
BindingThe codes SHALL be taken from ActionPrecheckBehavior
(required to http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1)

Defines selection frequency behavior for an action or group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1379. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.cardinalityBehavior
Definition

Defines whether the action can be selected multiple times.

Shortsingle | multiple
Control0..1
BindingThe codes SHALL be taken from ActionCardinalityBehavior
(required to http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1)

Defines behavior for an action or a group for how many times that item may be repeated.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1381. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.definition[x]
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.

ShortDescription of the activity to be performed
Comments

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

Control0..1
TypeChoice of: canonical(ActivityDefinition, PlanDefinition, Questionnaire), uri
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1383. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.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.

ShortTransform to apply the template
Comments

Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..1
Typecanonical(StructureMap)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1385. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.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.

ShortDynamic aspects of the definition
Comments

Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1387. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1389. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.dynamicValue.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1391. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1393. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.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. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details).

ShortThe path to the element to be set dynamically
Comments

To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1395. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.dynamicValue.expression
Definition

An expression specifying the value of the customized element.

ShortAn expression that provides the dynamic value for the customization
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1397. PlanDefinition.action:checkForImmediateReporting.action:isLateEncounterCompleted.action
Definition

Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.

ShortA sub-action
Control0..*
TypeSeettp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1399. PlanDefinition.action:checkReportable
Slice NamecheckReportable
Definition

Defines the checking of the encounter for reportability.

ShortCheck the encounter for reportability
Comments

Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.

Control1..1
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1401. PlanDefinition.action:checkReportable.id
Definition

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

ShortUnique id for inter-element referencing
Control1..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "id" : "check-reportable"
}
<id value="check-reportable"/>
1403. PlanDefinition.action:checkReportable.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1405. PlanDefinition.action:checkReportable.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1407. PlanDefinition.action:checkReportable.prefix
Definition

A user-visible prefix for the action.

ShortUser-visible prefix for the action (e.g. 1. or A.)
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1409. PlanDefinition.action:checkReportable.title
Definition

The title of the action displayed to a user.

ShortUser-visible title
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1411. PlanDefinition.action:checkReportable.description
Definition

Description of the Periodic Update of eICR action within the eICR action.

ShortDescription of the Periodic Update of eICR action.
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Value
{
  "description" : "This action represents the check for suspected reportability of the eICR."
}
<description value="This action represents the check for suspected reportability of the eICR."/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1413. PlanDefinition.action:checkReportable.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 might not be capable of interpreting it dynamically.

ShortStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1415. PlanDefinition.action:checkReportable.priority
Definition

Indicates how quickly the action should be addressed with respect to other actions.

Shortroutine | urgent | asap | stat
Control0..1
BindingThe codes SHALL be taken from RequestPriority
(required to http://hl7.org/fhir/ValueSet/request-priority|4.0.1)

Identifies the level of importance to be assigned to actioning the request.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1417. PlanDefinition.action:checkReportable.code
Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control1..1
BindingUnless not suitable, these codes SHALL be taken from US Public Health ValueSet - PlanDefinition Action
(extensible to http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-plandefinition-action)

The set of actions that can be used to create plan definition

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "execute-reporting-workflow"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="execute-reporting-workflow"/>
  </coding>
</code>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1419. PlanDefinition.action:checkReportable.reason
Definition

A description of why this action is necessary or appropriate.

ShortWhy the action should be performed
Comments

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

Control0..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1421. PlanDefinition.action:checkReportable.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.

ShortSupporting documentation for the intended performer of the action
Control0..*
TypeRelatedArtifact
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1423. PlanDefinition.action:checkReportable.goalId
Definition

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

ShortWhat goals this action supports
Control0..*
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1425. PlanDefinition.action:checkReportable.subject[x]
Definition

A code or group definition that describes the intended subject of the action and its children, if any.

ShortType of individual the action is focused on
Comments

The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified.

In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType
(extensible to http://hl7.org/fhir/ValueSet/subject-type)

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

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Requirements

Multiple steps in a protocol often have different groups of steps that are focused on testing different things. The subject of an action specifies the focus of the action and any child actions.

Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1427. PlanDefinition.action:checkReportable.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1429. PlanDefinition.action:checkReportable.trigger.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1431. PlanDefinition.action:checkReportable.trigger.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control1..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.trigger.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1433. PlanDefinition.action:checkReportable.trigger.extension:namedEventType
Slice NamenamedEventType
Definition

Indicates the types of named events to subscribe to from the EHR.

ShortUS Public Health Named Event Type Extension
Control1..1
TypeExtension(US Public Health Named Event Type Extension) (Extension Type: CodeableConcept)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1435. PlanDefinition.action:checkReportable.trigger.type
Definition

The type of triggering event.

Shortnamed-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Control1..1
BindingThe codes SHALL be taken from TriggerType
(required to http://hl7.org/fhir/ValueSet/trigger-type|4.0.1)

The type of trigger.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Value
{
  "type" : "named-event"
}
<type value="named-event"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1437. PlanDefinition.action:checkReportable.trigger.name
Definition

A formal name for the event. This may be an absolute URI that identifies the event formally (e.g. from a trigger registry), or a simple relative URI that identifies the event in a local context.

ShortName or URI that identifies the event
Comments

An event name can be provided for all event types, but is required for named events. If a name is provided for a type other than named events, it is considered to be a shorthand for the semantics described by the formal description of the event.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1439. PlanDefinition.action:checkReportable.trigger.timing[x]
Definition

The timing of the event (if this is a periodic trigger).

ShortTiming of the event
Control0..1
TypeChoice of: Timing, Reference(Schedule), date, dateTime
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1441. PlanDefinition.action:checkReportable.trigger.data
Definition

The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.

ShortTriggering data of the event (multiple = 'and')
Comments

This element shall be present for any data type trigger.

Control0..*
TypeDataRequirement
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1443. PlanDefinition.action:checkReportable.trigger.condition
Definition

A boolean-valued expression that is evaluated in the context of the container of the trigger definition and returns whether or not the trigger fires.

ShortWhether the event triggers (boolean expression)
Comments

This element can be only be specified for data type triggers and provides additional semantics for the trigger. The context available within the condition is based on the type of data event. For all events, the current resource will be available as context. In addition, for modification events, the previous resource will also be available. The expression may be inlined, or may be a simple absolute URI, which is a reference to a named expression within a logic library referenced by a library element or extension within the containing resource. If the expression is a FHIR Path expression, it evaluates in the context of a resource of one of the type identified in the data requirement, and may also refer to the variable %previous for delta comparisons on events of type data-changed, data-modified, and data-deleted which will always have the same type.

Control0..1
TypeExpression
Is Modifierfalse
Summarytrue
Requirements

Need to be able to formally describe the triggering criteria.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1445. PlanDefinition.action:checkReportable.condition
Definition

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

ShortWhether or not the action is applicable
Comments

When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1447. PlanDefinition.action:checkReportable.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1449. PlanDefinition.action:checkReportable.condition.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1451. PlanDefinition.action:checkReportable.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1453. PlanDefinition.action:checkReportable.condition.kind
Definition

The kind of condition.

Shortapplicability | start | stop
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 enter/exit criteria for an action.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKind
(required to http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1)

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1455. PlanDefinition.action:checkReportable.condition.expression
Definition

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

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1457. PlanDefinition.action:checkReportable.input
Definition

Defines input data requirements for the action.

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1459. PlanDefinition.action:checkReportable.input.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1461. PlanDefinition.action:checkReportable.input.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1463. PlanDefinition.action:checkReportable.input.extension:fhirquerypattern
Slice Namefhirquerypattern
Definition

A FHIR Query URL pattern that corresponds to the data specified by the data requirement. If multiple FHIR Query URLs are present, they each contribute to the data specified by the data requirement (i.e. the union of the results of the FHIR Queries represents the complete data for the data requirement). This is not a resolveable URL, in that it will contain 1) No base canonical (i.e. it's a relative query), and 2) Parameters using tokens that are delimited using double-braces and the context parameters are dependent solely on the subjectType, according to the following: Patient: context.patientId, Practitioner: context.practitionerId, Organization: context.organizationId, Location: context.locationId, Device: context.deviceId. For example, for a Library with a subjectType of Patient, the context parameter {{context.patientId}} will be used as a token to be replaced with the id of the Patient in context. This extension is used primarily to address the use case for satisfying a data requirement for a single subject. However, the query pattern could also be used to satisfy population level requests by removing the subject-level filter from the query.

ShortWhat FHIR query?
Comments

Supports communicating a FHIR query (or set of queries) for the given data requirement. The query is server-specific, and will need to be created as informed by a CapabilityStatement. The $data-requirements operation should be expected to be able to provide an Endpoint or CapabilityStatement to provide this information.; If no endpoint or capability statement is provided, the capability statement of the server performing the operation is used.

Control0..1
TypeExtension(FHIR Query Pattern) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1465. PlanDefinition.action:checkReportable.input.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypes
(required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1467. PlanDefinition.action:checkReportable.input.profile
Definition

The profile of the required data, specified as the uri of the profile definition.

ShortThe profile of the required data
Control0..*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1469. PlanDefinition.action:checkReportable.input.subject[x]
Definition

The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.

ShortE.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments

The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType
(extensible to http://hl7.org/fhir/ValueSet/subject-type|4.0.1)

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

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summarytrue
Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1471. PlanDefinition.action:checkReportable.input.mustSupport
Definition

Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available.

The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).

ShortIndicates specific structure elements that are referenced by the knowledge module
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1473. PlanDefinition.action:checkReportable.input.codeFilter
Definition

Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.

ShortWhat codes are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-1: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1475. PlanDefinition.action:checkReportable.input.codeFilter.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1477. PlanDefinition.action:checkReportable.input.codeFilter.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.codeFilter.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1479. PlanDefinition.action:checkReportable.input.codeFilter.path
Definition

The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.

ShortA code-valued attribute to filter on
Comments

The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1481. PlanDefinition.action:checkReportable.input.codeFilter.searchParam
Definition

A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.

ShortA coded (token) parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1483. PlanDefinition.action:checkReportable.input.codeFilter.valueSet
Definition

The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.

ShortValueset for the filter
Control0..1
Typecanonical(ValueSet)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1485. PlanDefinition.action:checkReportable.input.codeFilter.code
Definition

The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.

ShortWhat code is expected
Control0..*
TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1487. PlanDefinition.action:checkReportable.input.dateFilter
Definition

Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.

ShortWhat dates/date ranges are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-2: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1489. PlanDefinition.action:checkReportable.input.dateFilter.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1491. PlanDefinition.action:checkReportable.input.dateFilter.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.dateFilter.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1493. PlanDefinition.action:checkReportable.input.dateFilter.path
Definition

The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.

ShortA date-valued attribute to filter on
Comments

The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1495. PlanDefinition.action:checkReportable.input.dateFilter.searchParam
Definition

A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.

ShortA date valued parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1497. PlanDefinition.action:checkReportable.input.dateFilter.value[x]
Definition

The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.

ShortThe value of the filter, as a Period, DateTime, or Duration value
Control0..1
TypeChoice of: dateTime, Period, Duration
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1499. PlanDefinition.action:checkReportable.input.limit
Definition

Specifies a maximum number of results that are required (uses the _count search parameter).

ShortNumber of results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".

Control0..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1501. PlanDefinition.action:checkReportable.input.sort
Definition

Specifies the order of the results to be returned.

ShortOrder of the results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.

Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1503. PlanDefinition.action:checkReportable.input.sort.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1505. PlanDefinition.action:checkReportable.input.sort.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.sort.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1507. PlanDefinition.action:checkReportable.input.sort.path
Definition

The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.

ShortThe name of the attribute to perform the sort
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1509. PlanDefinition.action:checkReportable.input.sort.direction
Definition

The direction of the sort, ascending or descending.

Shortascending | descending
Control1..1
BindingThe codes SHALL be taken from SortDirection
(required to http://hl7.org/fhir/ValueSet/sort-direction|4.0.1)

The possible sort directions, ascending or descending.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1511. PlanDefinition.action:checkReportable.output
Definition

Defines the outputs of the action, if any.

ShortOutput data definition
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1513. PlanDefinition.action:checkReportable.output.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1515. PlanDefinition.action:checkReportable.output.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1517. PlanDefinition.action:checkReportable.output.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypes
(required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1519. PlanDefinition.action:checkReportable.output.profile
Definition

The profile of the required data, specified as the uri of the profile definition.

ShortThe profile of the required data
Control0..*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1521. PlanDefinition.action:checkReportable.output.subject[x]
Definition

The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.

ShortE.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments

The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType
(extensible to http://hl7.org/fhir/ValueSet/subject-type|4.0.1)

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

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summarytrue
Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1523. PlanDefinition.action:checkReportable.output.mustSupport
Definition

Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available.

The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).

ShortIndicates specific structure elements that are referenced by the knowledge module
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1525. PlanDefinition.action:checkReportable.output.codeFilter
Definition

Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.

ShortWhat codes are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-1: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1527. PlanDefinition.action:checkReportable.output.codeFilter.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1529. PlanDefinition.action:checkReportable.output.codeFilter.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.codeFilter.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1531. PlanDefinition.action:checkReportable.output.codeFilter.path
Definition

The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.

ShortA code-valued attribute to filter on
Comments

The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1533. PlanDefinition.action:checkReportable.output.codeFilter.searchParam
Definition

A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.

ShortA coded (token) parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1535. PlanDefinition.action:checkReportable.output.codeFilter.valueSet
Definition

The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.

ShortValueset for the filter
Control0..1
Typecanonical(ValueSet)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1537. PlanDefinition.action:checkReportable.output.codeFilter.code
Definition

The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.

ShortWhat code is expected
Control0..*
TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1539. PlanDefinition.action:checkReportable.output.dateFilter
Definition

Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.

ShortWhat dates/date ranges are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-2: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1541. PlanDefinition.action:checkReportable.output.dateFilter.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1543. PlanDefinition.action:checkReportable.output.dateFilter.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.dateFilter.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1545. PlanDefinition.action:checkReportable.output.dateFilter.path
Definition

The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.

ShortA date-valued attribute to filter on
Comments

The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1547. PlanDefinition.action:checkReportable.output.dateFilter.searchParam
Definition

A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.

ShortA date valued parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1549. PlanDefinition.action:checkReportable.output.dateFilter.value[x]
Definition

The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.

ShortThe value of the filter, as a Period, DateTime, or Duration value
Control0..1
TypeChoice of: dateTime, Period, Duration
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1551. PlanDefinition.action:checkReportable.output.limit
Definition

Specifies a maximum number of results that are required (uses the _count search parameter).

ShortNumber of results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".

Control0..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1553. PlanDefinition.action:checkReportable.output.sort
Definition

Specifies the order of the results to be returned.

ShortOrder of the results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.

Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1555. PlanDefinition.action:checkReportable.output.sort.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1557. PlanDefinition.action:checkReportable.output.sort.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.sort.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1559. PlanDefinition.action:checkReportable.output.sort.path
Definition

The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.

ShortThe name of the attribute to perform the sort
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1561. PlanDefinition.action:checkReportable.output.sort.direction
Definition

The direction of the sort, ascending or descending.

Shortascending | descending
Control1..1
BindingThe codes SHALL be taken from SortDirection
(required to http://hl7.org/fhir/ValueSet/sort-direction|4.0.1)

The possible sort directions, ascending or descending.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1563. PlanDefinition.action:checkReportable.relatedAction
Definition

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

ShortRelationship to another action
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.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1565. PlanDefinition.action:checkReportable.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1567. PlanDefinition.action:checkReportable.relatedAction.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1569. PlanDefinition.action:checkReportable.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1571. PlanDefinition.action:checkReportable.relatedAction.actionId
Definition

The element id of the related action.

ShortWhat action is this related to
Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1573. PlanDefinition.action:checkReportable.relatedAction.relationship
Definition

The relationship of this action to the related action.

Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control1..1
BindingThe codes SHALL be taken from ActionRelationshipType
(required to http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1)

Defines the types of relationships between actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1575. PlanDefinition.action:checkReportable.relatedAction.offset[x]
Definition

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

ShortTime offset for the relationship
Control0..1
TypeChoice of: Duration, Range
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action.relatedAction.offset[x]. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this
1577. PlanDefinition.action:checkReportable.relatedAction.offset[x]:offsetDuration
Slice NameoffsetDuration
Definition

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

ShortTime offset for the relationship
Control0..1
TypeDuration
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1579. PlanDefinition.action:checkReportable.timing[x]
Definition

An optional value describing when the action should be performed.

ShortWhen the action should take place
Control0..1
TypeDuration
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1581. PlanDefinition.action:checkReportable.participant
Definition

Indicates who should participate in performing the action described.

ShortWho should participate in the action
Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1583. PlanDefinition.action:checkReportable.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1585. PlanDefinition.action:checkReportable.participant.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1587. PlanDefinition.action:checkReportable.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1589. PlanDefinition.action:checkReportable.participant.type
Definition

The type of participant in the action.

Shortpatient | practitioner | related-person | device
Control1..1
BindingThe codes SHALL be taken from ActionParticipantType
(required to http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1)

The type of participant for the action.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1591. PlanDefinition.action:checkReportable.participant.role
Definition

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

ShortE.g. Nurse, Surgeon, Parent
Control0..1
BindingFor example codes, see ActionParticipantRole
(example to http://hl7.org/fhir/ValueSet/action-participant-role)

Defines roles played by participants for the action.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1593. PlanDefinition.action:checkReportable.type
Definition

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

Shortcreate | update | remove | fire-event
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ActionType
(extensible to http://hl7.org/fhir/ValueSet/action-type)

The type of action to be performed.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1595. PlanDefinition.action:checkReportable.groupingBehavior
Definition

Defines the grouping behavior for the action and its children.

Shortvisual-group | logical-group | sentence-group
Control0..1
BindingThe codes SHALL be taken from ActionGroupingBehavior
(required to http://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.1)

Defines organization behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1597. PlanDefinition.action:checkReportable.selectionBehavior
Definition

Defines the selection behavior for the action and its children.

Shortany | all | all-or-none | exactly-one | at-most-one | one-or-more
Control0..1
BindingThe codes SHALL be taken from ActionSelectionBehavior
(required to http://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.1)

Defines selection behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1599. PlanDefinition.action:checkReportable.requiredBehavior
Definition

Defines the required behavior for the action.

Shortmust | could | must-unless-documented
Control0..1
BindingThe codes SHALL be taken from ActionRequiredBehavior
(required to http://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1)

Defines expectations around whether an action or action group is required.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1601. PlanDefinition.action:checkReportable.precheckBehavior
Definition

Defines whether the action should usually be preselected.

Shortyes | no
Control0..1
BindingThe codes SHALL be taken from ActionPrecheckBehavior
(required to http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1)

Defines selection frequency behavior for an action or group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1603. PlanDefinition.action:checkReportable.cardinalityBehavior
Definition

Defines whether the action can be selected multiple times.

Shortsingle | multiple
Control0..1
BindingThe codes SHALL be taken from ActionCardinalityBehavior
(required to http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1)

Defines behavior for an action or a group for how many times that item may be repeated.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1605. PlanDefinition.action:checkReportable.definition[x]
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.

ShortDescription of the activity to be performed
Comments

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

Control0..1
TypeChoice of: canonical(ActivityDefinition, PlanDefinition, Questionnaire), uri
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1607. PlanDefinition.action:checkReportable.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.

ShortTransform to apply the template
Comments

Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..1
Typecanonical(StructureMap)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1609. PlanDefinition.action:checkReportable.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.

ShortDynamic aspects of the definition
Comments

Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1611. PlanDefinition.action:checkReportable.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1613. PlanDefinition.action:checkReportable.dynamicValue.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1615. PlanDefinition.action:checkReportable.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1617. PlanDefinition.action:checkReportable.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. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details).

ShortThe path to the element to be set dynamically
Comments

To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1619. PlanDefinition.action:checkReportable.dynamicValue.expression
Definition

An expression specifying the value of the customized element.

ShortAn expression that provides the dynamic value for the customization
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1621. PlanDefinition.action:checkReportable.action
Definition

Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.

ShortA sub-action
Control7..*
TypeSeettp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action.action. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ id
1623. PlanDefinition.action:checkReportable.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1625. PlanDefinition.action:checkReportable.action.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1627. PlanDefinition.action:checkReportable.action.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1629. PlanDefinition.action:checkReportable.action.prefix
Definition

A user-visible prefix for the action.

ShortUser-visible prefix for the action (e.g. 1. or A.)
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1631. PlanDefinition.action:checkReportable.action.title
Definition

The title of the action displayed to a user.

ShortUser-visible title
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1633. PlanDefinition.action:checkReportable.action.description
Definition

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

ShortBrief description of the action
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1635. PlanDefinition.action:checkReportable.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 might not be capable of interpreting it dynamically.

ShortStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1637. PlanDefinition.action:checkReportable.action.priority
Definition

Indicates how quickly the action should be addressed with respect to other actions.

Shortroutine | urgent | asap | stat
Control0..1
BindingThe codes SHALL be taken from RequestPriority
(required to http://hl7.org/fhir/ValueSet/request-priority|4.0.1)

Identifies the level of importance to be assigned to actioning the request.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1639. PlanDefinition.action:checkReportable.action.code
Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control0..1
BindingUnless not suitable, these codes SHALL be taken from US Public Health ValueSet - PlanDefinition Action
(extensible to http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-plandefinition-action)

The set of actions that can be used to create plan definition

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1641. PlanDefinition.action:checkReportable.action.reason
Definition

A description of why this action is necessary or appropriate.

ShortWhy the action should be performed
Comments

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

Control0..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1643. PlanDefinition.action:checkReportable.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.

ShortSupporting documentation for the intended performer of the action
Control0..*
TypeRelatedArtifact
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1645. PlanDefinition.action:checkReportable.action.goalId
Definition

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

ShortWhat goals this action supports
Control0..*
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1647. PlanDefinition.action:checkReportable.action.subject[x]
Definition

A code or group definition that describes the intended subject of the action and its children, if any.

ShortType of individual the action is focused on
Comments

The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified.

In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType
(extensible to http://hl7.org/fhir/ValueSet/subject-type)

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

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Requirements

Multiple steps in a protocol often have different groups of steps that are focused on testing different things. The subject of an action specifies the focus of the action and any child actions.

Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1649. PlanDefinition.action:checkReportable.action.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1651. PlanDefinition.action:checkReportable.action.trigger.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1653. PlanDefinition.action:checkReportable.action.trigger.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control1..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.action.trigger.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1655. PlanDefinition.action:checkReportable.action:isEncounterReportable
Slice NameisEncounterReportable
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.

ShortA sub-action
Control1..1
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1657. PlanDefinition.action:checkReportable.action:isEncounterReportable.id
Definition

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

ShortUnique id for inter-element referencing
Control1..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "id" : "is-encounter-reportable"
}
<id value="is-encounter-reportable"/>
1659. PlanDefinition.action:checkReportable.action:isEncounterReportable.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1661. PlanDefinition.action:checkReportable.action:isEncounterReportable.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1663. PlanDefinition.action:checkReportable.action:isEncounterReportable.prefix
Definition

A user-visible prefix for the action.

ShortUser-visible prefix for the action (e.g. 1. or A.)
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1665. PlanDefinition.action:checkReportable.action:isEncounterReportable.title
Definition

The title of the action displayed to a user.

ShortUser-visible title
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1667. PlanDefinition.action:checkReportable.action:isEncounterReportable.description
Definition

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

ShortBrief description of the action
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1669. PlanDefinition.action:checkReportable.action:isEncounterReportable.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 might not be capable of interpreting it dynamically.

ShortStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1671. PlanDefinition.action:checkReportable.action:isEncounterReportable.priority
Definition

Indicates how quickly the action should be addressed with respect to other actions.

Shortroutine | urgent | asap | stat
Control0..1
BindingThe codes SHALL be taken from RequestPriority
(required to http://hl7.org/fhir/ValueSet/request-priority|4.0.1)

Identifies the level of importance to be assigned to actioning the request.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1673. PlanDefinition.action:checkReportable.action:isEncounterReportable.code
Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control1..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "check-trigger-codes"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="check-trigger-codes"/>
  </coding>
</code>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1675. PlanDefinition.action:checkReportable.action:isEncounterReportable.reason
Definition

A description of why this action is necessary or appropriate.

ShortWhy the action should be performed
Comments

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

Control0..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1677. PlanDefinition.action:checkReportable.action:isEncounterReportable.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.

ShortSupporting documentation for the intended performer of the action
Control0..*
TypeRelatedArtifact
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1679. PlanDefinition.action:checkReportable.action:isEncounterReportable.goalId
Definition

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

ShortWhat goals this action supports
Control0..*
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1681. PlanDefinition.action:checkReportable.action:isEncounterReportable.subject[x]
Definition

A code or group definition that describes the intended subject of the action and its children, if any.

ShortType of individual the action is focused on
Comments

The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified.

In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType
(extensible to http://hl7.org/fhir/ValueSet/subject-type|4.0.1)

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

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Requirements

Multiple steps in a protocol often have different groups of steps that are focused on testing different things. The subject of an action specifies the focus of the action and any child actions.

Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1683. PlanDefinition.action:checkReportable.action:isEncounterReportable.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1685. PlanDefinition.action:checkReportable.action:isEncounterReportable.condition
Definition

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

ShortWhether or not the action is applicable
Comments

When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1687. PlanDefinition.action:checkReportable.action:isEncounterReportable.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1689. PlanDefinition.action:checkReportable.action:isEncounterReportable.condition.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1691. PlanDefinition.action:checkReportable.action:isEncounterReportable.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1693. PlanDefinition.action:checkReportable.action:isEncounterReportable.condition.kind
Definition

The kind of condition.

Shortapplicability | start | stop
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 enter/exit criteria for an action.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKind
(required to http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1)

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Value
{
  "kind" : "applicability"
}
<kind value="applicability"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1695. PlanDefinition.action:checkReportable.action:isEncounterReportable.condition.expression
Definition

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

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control1..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1697. PlanDefinition.action:checkReportable.action:isEncounterReportable.condition.expression.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1699. PlanDefinition.action:checkReportable.action:isEncounterReportable.condition.expression.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.action.condition.expression.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1701. PlanDefinition.action:checkReportable.action:isEncounterReportable.condition.expression.description
Definition

A brief, natural language description of the condition that effectively communicates the intended semantics.

ShortNatural language description of the condition
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1703. PlanDefinition.action:checkReportable.action:isEncounterReportable.condition.expression.name
Definition

A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.

ShortShort name assigned to expression for reuse
Control0..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1705. PlanDefinition.action:checkReportable.action:isEncounterReportable.condition.expression.language
Definition

The media type of the language for the expression.

Shorttext/cql | text/fhirpath | application/x-fhir-query | etc.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from ExpressionLanguage
(extensible to http://hl7.org/fhir/ValueSet/expression-language|4.0.1)

The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Fixed Value
{
  "language" : "text/fhirpath"
}
<language value="text/fhirpath"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1707. PlanDefinition.action:checkReportable.action:isEncounterReportable.condition.expression.expression
Definition

An expression in the specified language that returns a value.

ShortExpression in specified language
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1709. PlanDefinition.action:checkReportable.action:isEncounterReportable.condition.expression.reference
Definition

A URI that defines where the expression is found.

ShortWhere the expression is found
Comments

If both a reference and an expression is found, the reference SHALL point to the same expression.

Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1711. PlanDefinition.action:checkReportable.action:isEncounterReportable.input
Definition

Defines input data requirements for the action. Required data is accessible via a context variable named %[id] using the id of the input data requirement

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1713. PlanDefinition.action:checkReportable.action:isEncounterReportable.input.id
Definition

The id of the input requirement, allowing the data to be referenced via a context variable named %[id]

ShortUnique id for inter-element referencing
Control1..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1715. PlanDefinition.action:checkReportable.action:isEncounterReportable.input.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.action.input.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1717. PlanDefinition.action:checkReportable.action:isEncounterReportable.input.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypes
(required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1719. PlanDefinition.action:checkReportable.action:isEncounterReportable.input.profile
Definition

The profile of the required data, specified as the uri of the profile definition.

ShortThe profile of the required data
Control0..*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1721. PlanDefinition.action:checkReportable.action:isEncounterReportable.input.subject[x]
Definition

The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.

ShortE.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments

The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType
(extensible to http://hl7.org/fhir/ValueSet/subject-type|4.0.1)

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

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summarytrue
Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1723. PlanDefinition.action:checkReportable.action:isEncounterReportable.input.mustSupport
Definition

Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available.

The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).

ShortIndicates specific structure elements that are referenced by the knowledge module
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1725. PlanDefinition.action:checkReportable.action:isEncounterReportable.input.codeFilter
Definition

Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.

ShortWhat codes are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-1: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1727. PlanDefinition.action:checkReportable.action:isEncounterReportable.input.codeFilter.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1729. PlanDefinition.action:checkReportable.action:isEncounterReportable.input.codeFilter.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.action.input.codeFilter.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1731. PlanDefinition.action:checkReportable.action:isEncounterReportable.input.codeFilter.path
Definition

The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.

ShortA code-valued attribute to filter on
Comments

The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1733. PlanDefinition.action:checkReportable.action:isEncounterReportable.input.codeFilter.searchParam
Definition

A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.

ShortA coded (token) parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1735. PlanDefinition.action:checkReportable.action:isEncounterReportable.input.codeFilter.valueSet
Definition

The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.

ShortValueset for the filter
Control0..1
Typecanonical(ValueSet)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1737. PlanDefinition.action:checkReportable.action:isEncounterReportable.input.codeFilter.code
Definition

The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.

ShortWhat code is expected
Control0..*
TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1739. PlanDefinition.action:checkReportable.action:isEncounterReportable.input.dateFilter
Definition

Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.

ShortWhat dates/date ranges are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-2: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1741. PlanDefinition.action:checkReportable.action:isEncounterReportable.input.dateFilter.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1743. PlanDefinition.action:checkReportable.action:isEncounterReportable.input.dateFilter.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.action.input.dateFilter.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1745. PlanDefinition.action:checkReportable.action:isEncounterReportable.input.dateFilter.path
Definition

The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.

ShortA date-valued attribute to filter on
Comments

The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1747. PlanDefinition.action:checkReportable.action:isEncounterReportable.input.dateFilter.searchParam
Definition

A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.

ShortA date valued parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1749. PlanDefinition.action:checkReportable.action:isEncounterReportable.input.dateFilter.value[x]
Definition

The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.

ShortThe value of the filter, as a Period, DateTime, or Duration value
Control0..1
TypeChoice of: dateTime, Period, Duration
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1751. PlanDefinition.action:checkReportable.action:isEncounterReportable.input.limit
Definition

Specifies a maximum number of results that are required (uses the _count search parameter).

ShortNumber of results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".

Control0..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1753. PlanDefinition.action:checkReportable.action:isEncounterReportable.input.sort
Definition

Specifies the order of the results to be returned.

ShortOrder of the results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.

Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1755. PlanDefinition.action:checkReportable.action:isEncounterReportable.input.sort.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1757. PlanDefinition.action:checkReportable.action:isEncounterReportable.input.sort.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.action.input.sort.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1759. PlanDefinition.action:checkReportable.action:isEncounterReportable.input.sort.path
Definition

The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.

ShortThe name of the attribute to perform the sort
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1761. PlanDefinition.action:checkReportable.action:isEncounterReportable.input.sort.direction
Definition

The direction of the sort, ascending or descending.

Shortascending | descending
Control1..1
BindingThe codes SHALL be taken from SortDirection
(required to http://hl7.org/fhir/ValueSet/sort-direction|4.0.1)

The possible sort directions, ascending or descending.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1763. PlanDefinition.action:checkReportable.action:isEncounterReportable.output
Definition

Defines the outputs of the action, if any.

ShortOutput data definition
Control0..*
TypeDataRequirement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1765. PlanDefinition.action:checkReportable.action:isEncounterReportable.relatedAction
Definition

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

ShortRelationship to another action
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.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1767. PlanDefinition.action:checkReportable.action:isEncounterReportable.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1769. PlanDefinition.action:checkReportable.action:isEncounterReportable.relatedAction.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1771. PlanDefinition.action:checkReportable.action:isEncounterReportable.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1773. PlanDefinition.action:checkReportable.action:isEncounterReportable.relatedAction.actionId
Definition

The element id of the related action.

ShortWhat action is this related to
Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Value
{
  "actionId" : "create-eicr"
}
<actionId value="create-eicr"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1775. PlanDefinition.action:checkReportable.action:isEncounterReportable.relatedAction.relationship
Definition

The relationship of this action to the related action.

Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control1..1
BindingThe codes SHALL be taken from ActionRelationshipType
(required to http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1)

Defines the types of relationships between actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Value
{
  "relationship" : "before-start"
}
<relationship value="before-start"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1777. PlanDefinition.action:checkReportable.action:isEncounterReportable.relatedAction.offset[x]
Definition

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

ShortTime offset for the relationship
Control0..1
TypeChoice of: Duration, Range
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1779. PlanDefinition.action:checkReportable.action:isEncounterReportable.timing[x]
Definition

An optional value describing when the action should be performed.

ShortWhen the action should take place
Control0..1
TypeChoice of: dateTime, Age, Period, Duration, Range, Timing
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1781. PlanDefinition.action:checkReportable.action:isEncounterReportable.participant
Definition

Indicates who should participate in performing the action described.

ShortWho should participate in the action
Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1783. PlanDefinition.action:checkReportable.action:isEncounterReportable.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1785. PlanDefinition.action:checkReportable.action:isEncounterReportable.participant.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1787. PlanDefinition.action:checkReportable.action:isEncounterReportable.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1789. PlanDefinition.action:checkReportable.action:isEncounterReportable.participant.type
Definition

The type of participant in the action.

Shortpatient | practitioner | related-person | device
Control1..1
BindingThe codes SHALL be taken from ActionParticipantType
(required to http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1)

The type of participant for the action.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1791. PlanDefinition.action:checkReportable.action:isEncounterReportable.participant.role
Definition

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

ShortE.g. Nurse, Surgeon, Parent
Control0..1
BindingFor example codes, see ActionParticipantRole
(example to http://hl7.org/fhir/ValueSet/action-participant-role|4.0.1)

Defines roles played by participants for the action.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1793. PlanDefinition.action:checkReportable.action:isEncounterReportable.type
Definition

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

Shortcreate | update | remove | fire-event
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ActionType
(extensible to http://hl7.org/fhir/ValueSet/action-type|4.0.1)

The type of action to be performed.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1795. PlanDefinition.action:checkReportable.action:isEncounterReportable.groupingBehavior
Definition

Defines the grouping behavior for the action and its children.

Shortvisual-group | logical-group | sentence-group
Control0..1
BindingThe codes SHALL be taken from ActionGroupingBehavior
(required to http://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.1)

Defines organization behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1797. PlanDefinition.action:checkReportable.action:isEncounterReportable.selectionBehavior
Definition

Defines the selection behavior for the action and its children.

Shortany | all | all-or-none | exactly-one | at-most-one | one-or-more
Control0..1
BindingThe codes SHALL be taken from ActionSelectionBehavior
(required to http://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.1)

Defines selection behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1799. PlanDefinition.action:checkReportable.action:isEncounterReportable.requiredBehavior
Definition

Defines the required behavior for the action.

Shortmust | could | must-unless-documented
Control0..1
BindingThe codes SHALL be taken from ActionRequiredBehavior
(required to http://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1)

Defines expectations around whether an action or action group is required.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1801. PlanDefinition.action:checkReportable.action:isEncounterReportable.precheckBehavior
Definition

Defines whether the action should usually be preselected.

Shortyes | no
Control0..1
BindingThe codes SHALL be taken from ActionPrecheckBehavior
(required to http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1)

Defines selection frequency behavior for an action or group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1803. PlanDefinition.action:checkReportable.action:isEncounterReportable.cardinalityBehavior
Definition

Defines whether the action can be selected multiple times.

Shortsingle | multiple
Control0..1
BindingThe codes SHALL be taken from ActionCardinalityBehavior
(required to http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1)

Defines behavior for an action or a group for how many times that item may be repeated.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1805. PlanDefinition.action:checkReportable.action:isEncounterReportable.definition[x]
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.

ShortDescription of the activity to be performed
Comments

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

Control0..1
TypeChoice of: canonical(ActivityDefinition, PlanDefinition, Questionnaire), uri
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1807. PlanDefinition.action:checkReportable.action:isEncounterReportable.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.

ShortTransform to apply the template
Comments

Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..1
Typecanonical(StructureMap)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1809. PlanDefinition.action:checkReportable.action:isEncounterReportable.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.

ShortDynamic aspects of the definition
Comments

Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1811. PlanDefinition.action:checkReportable.action:isEncounterReportable.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1813. PlanDefinition.action:checkReportable.action:isEncounterReportable.dynamicValue.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1815. PlanDefinition.action:checkReportable.action:isEncounterReportable.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1817. PlanDefinition.action:checkReportable.action:isEncounterReportable.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. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details).

ShortThe path to the element to be set dynamically
Comments

To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1819. PlanDefinition.action:checkReportable.action:isEncounterReportable.dynamicValue.expression
Definition

An expression specifying the value of the customized element.

ShortAn expression that provides the dynamic value for the customization
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1821. PlanDefinition.action:checkReportable.action:isEncounterReportable.action
Definition

Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.

ShortA sub-action
Control0..*
TypeSeettp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1823. PlanDefinition.action:checkReportable.action:checkUpdateEicr
Slice NamecheckUpdateEicr
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.

ShortA sub-action
Control1..1
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1825. PlanDefinition.action:checkReportable.action:checkUpdateEicr.id
Definition

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

ShortUnique id for inter-element referencing
Control1..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "id" : "check-update-eicr"
}
<id value="check-update-eicr"/>
1827. PlanDefinition.action:checkReportable.action:checkUpdateEicr.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1829. PlanDefinition.action:checkReportable.action:checkUpdateEicr.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1831. PlanDefinition.action:checkReportable.action:checkUpdateEicr.prefix
Definition

A user-visible prefix for the action.

ShortUser-visible prefix for the action (e.g. 1. or A.)
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1833. PlanDefinition.action:checkReportable.action:checkUpdateEicr.title
Definition

The title of the action displayed to a user.

ShortUser-visible title
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1835. PlanDefinition.action:checkReportable.action:checkUpdateEicr.description
Definition

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

ShortBrief description of the action
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1837. PlanDefinition.action:checkReportable.action:checkUpdateEicr.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 might not be capable of interpreting it dynamically.

ShortStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1839. PlanDefinition.action:checkReportable.action:checkUpdateEicr.priority
Definition

Indicates how quickly the action should be addressed with respect to other actions.

Shortroutine | urgent | asap | stat
Control0..1
BindingThe codes SHALL be taken from RequestPriority
(required to http://hl7.org/fhir/ValueSet/request-priority|4.0.1)

Identifies the level of importance to be assigned to actioning the request.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1841. PlanDefinition.action:checkReportable.action:checkUpdateEicr.code
Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control1..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "evaluate-condition"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="evaluate-condition"/>
  </coding>
</code>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1843. PlanDefinition.action:checkReportable.action:checkUpdateEicr.reason
Definition

A description of why this action is necessary or appropriate.

ShortWhy the action should be performed
Comments

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

Control0..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1845. PlanDefinition.action:checkReportable.action:checkUpdateEicr.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.

ShortSupporting documentation for the intended performer of the action
Control0..*
TypeRelatedArtifact
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1847. PlanDefinition.action:checkReportable.action:checkUpdateEicr.goalId
Definition

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

ShortWhat goals this action supports
Control0..*
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1849. PlanDefinition.action:checkReportable.action:checkUpdateEicr.subject[x]
Definition

A code or group definition that describes the intended subject of the action and its children, if any.

ShortType of individual the action is focused on
Comments

The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified.

In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType
(extensible to http://hl7.org/fhir/ValueSet/subject-type|4.0.1)

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

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Requirements

Multiple steps in a protocol often have different groups of steps that are focused on testing different things. The subject of an action specifies the focus of the action and any child actions.

Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1851. PlanDefinition.action:checkReportable.action:checkUpdateEicr.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1853. PlanDefinition.action:checkReportable.action:checkUpdateEicr.condition
Definition

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

ShortWhether or not the action is applicable
Comments

When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1855. PlanDefinition.action:checkReportable.action:checkUpdateEicr.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1857. PlanDefinition.action:checkReportable.action:checkUpdateEicr.condition.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1859. PlanDefinition.action:checkReportable.action:checkUpdateEicr.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1861. PlanDefinition.action:checkReportable.action:checkUpdateEicr.condition.kind
Definition

The kind of condition.

Shortapplicability | start | stop
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 enter/exit criteria for an action.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKind
(required to http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1)

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Value
{
  "kind" : "applicability"
}
<kind value="applicability"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1863. PlanDefinition.action:checkReportable.action:checkUpdateEicr.condition.expression
Definition

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

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control1..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1865. PlanDefinition.action:checkReportable.action:checkUpdateEicr.condition.expression.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1867. PlanDefinition.action:checkReportable.action:checkUpdateEicr.condition.expression.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.action.condition.expression.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1869. PlanDefinition.action:checkReportable.action:checkUpdateEicr.condition.expression.description
Definition

A brief, natural language description of the condition that effectively communicates the intended semantics.

ShortNatural language description of the condition
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1871. PlanDefinition.action:checkReportable.action:checkUpdateEicr.condition.expression.name
Definition

A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.

ShortShort name assigned to expression for reuse
Control0..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1873. PlanDefinition.action:checkReportable.action:checkUpdateEicr.condition.expression.language
Definition

The media type of the language for the expression.

Shorttext/cql | text/fhirpath | application/x-fhir-query | etc.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from ExpressionLanguage
(extensible to http://hl7.org/fhir/ValueSet/expression-language|4.0.1)

The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Fixed Value
{
  "language" : "text/fhirpath"
}
<language value="text/fhirpath"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1875. PlanDefinition.action:checkReportable.action:checkUpdateEicr.condition.expression.expression
Definition

An expression in the specified language that returns a value.

ShortExpression in specified language
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1877. PlanDefinition.action:checkReportable.action:checkUpdateEicr.condition.expression.reference
Definition

A URI that defines where the expression is found.

ShortWhere the expression is found
Comments

If both a reference and an expression is found, the reference SHALL point to the same expression.

Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1879. PlanDefinition.action:checkReportable.action:checkUpdateEicr.input
Definition

Defines input data requirements for the action.

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1881. PlanDefinition.action:checkReportable.action:checkUpdateEicr.output
Definition

Defines the outputs of the action, if any.

ShortOutput data definition
Control0..*
TypeDataRequirement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1883. PlanDefinition.action:checkReportable.action:checkUpdateEicr.relatedAction
Definition

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

ShortRelationship to another action
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.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1885. PlanDefinition.action:checkReportable.action:checkUpdateEicr.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1887. PlanDefinition.action:checkReportable.action:checkUpdateEicr.relatedAction.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1889. PlanDefinition.action:checkReportable.action:checkUpdateEicr.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1891. PlanDefinition.action:checkReportable.action:checkUpdateEicr.relatedAction.actionId
Definition

The element id of the related action.

ShortWhat action is this related to
Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Value
{
  "actionId" : "create-eicr"
}
<actionId value="create-eicr"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1893. PlanDefinition.action:checkReportable.action:checkUpdateEicr.relatedAction.relationship
Definition

The relationship of this action to the related action.

Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control1..1
BindingThe codes SHALL be taken from ActionRelationshipType
(required to http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1)

Defines the types of relationships between actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Value
{
  "relationship" : "before-start"
}
<relationship value="before-start"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1895. PlanDefinition.action:checkReportable.action:checkUpdateEicr.relatedAction.offset[x]
Definition

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

ShortTime offset for the relationship
Control0..1
TypeChoice of: Duration, Range
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1897. PlanDefinition.action:checkReportable.action:checkUpdateEicr.timing[x]
Definition

An optional value describing when the action should be performed.

ShortWhen the action should take place
Control0..1
TypeChoice of: dateTime, Age, Period, Duration, Range, Timing
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1899. PlanDefinition.action:checkReportable.action:checkUpdateEicr.participant
Definition

Indicates who should participate in performing the action described.

ShortWho should participate in the action
Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1901. PlanDefinition.action:checkReportable.action:checkUpdateEicr.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1903. PlanDefinition.action:checkReportable.action:checkUpdateEicr.participant.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1905. PlanDefinition.action:checkReportable.action:checkUpdateEicr.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1907. PlanDefinition.action:checkReportable.action:checkUpdateEicr.participant.type
Definition

The type of participant in the action.

Shortpatient | practitioner | related-person | device
Control1..1
BindingThe codes SHALL be taken from ActionParticipantType
(required to http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1)

The type of participant for the action.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1909. PlanDefinition.action:checkReportable.action:checkUpdateEicr.participant.role
Definition

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

ShortE.g. Nurse, Surgeon, Parent
Control0..1
BindingFor example codes, see ActionParticipantRole
(example to http://hl7.org/fhir/ValueSet/action-participant-role|4.0.1)

Defines roles played by participants for the action.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1911. PlanDefinition.action:checkReportable.action:checkUpdateEicr.type
Definition

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

Shortcreate | update | remove | fire-event
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ActionType
(extensible to http://hl7.org/fhir/ValueSet/action-type|4.0.1)

The type of action to be performed.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1913. PlanDefinition.action:checkReportable.action:checkUpdateEicr.groupingBehavior
Definition

Defines the grouping behavior for the action and its children.

Shortvisual-group | logical-group | sentence-group
Control0..1
BindingThe codes SHALL be taken from ActionGroupingBehavior
(required to http://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.1)

Defines organization behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1915. PlanDefinition.action:checkReportable.action:checkUpdateEicr.selectionBehavior
Definition

Defines the selection behavior for the action and its children.

Shortany | all | all-or-none | exactly-one | at-most-one | one-or-more
Control0..1
BindingThe codes SHALL be taken from ActionSelectionBehavior
(required to http://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.1)

Defines selection behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1917. PlanDefinition.action:checkReportable.action:checkUpdateEicr.requiredBehavior
Definition

Defines the required behavior for the action.

Shortmust | could | must-unless-documented
Control0..1
BindingThe codes SHALL be taken from ActionRequiredBehavior
(required to http://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1)

Defines expectations around whether an action or action group is required.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1919. PlanDefinition.action:checkReportable.action:checkUpdateEicr.precheckBehavior
Definition

Defines whether the action should usually be preselected.

Shortyes | no
Control0..1
BindingThe codes SHALL be taken from ActionPrecheckBehavior
(required to http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1)

Defines selection frequency behavior for an action or group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1921. PlanDefinition.action:checkReportable.action:checkUpdateEicr.cardinalityBehavior
Definition

Defines whether the action can be selected multiple times.

Shortsingle | multiple
Control0..1
BindingThe codes SHALL be taken from ActionCardinalityBehavior
(required to http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1)

Defines behavior for an action or a group for how many times that item may be repeated.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1923. PlanDefinition.action:checkReportable.action:checkUpdateEicr.definition[x]
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.

ShortDescription of the activity to be performed
Comments

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

Control0..1
TypeChoice of: canonical(ActivityDefinition, PlanDefinition, Questionnaire), uri
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1925. PlanDefinition.action:checkReportable.action:checkUpdateEicr.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.

ShortTransform to apply the template
Comments

Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..1
Typecanonical(StructureMap)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1927. PlanDefinition.action:checkReportable.action:checkUpdateEicr.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.

ShortDynamic aspects of the definition
Comments

Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1929. PlanDefinition.action:checkReportable.action:checkUpdateEicr.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1931. PlanDefinition.action:checkReportable.action:checkUpdateEicr.dynamicValue.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1933. PlanDefinition.action:checkReportable.action:checkUpdateEicr.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1935. PlanDefinition.action:checkReportable.action:checkUpdateEicr.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. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details).

ShortThe path to the element to be set dynamically
Comments

To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1937. PlanDefinition.action:checkReportable.action:checkUpdateEicr.dynamicValue.expression
Definition

An expression specifying the value of the customized element.

ShortAn expression that provides the dynamic value for the customization
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1939. PlanDefinition.action:checkReportable.action:checkUpdateEicr.action
Definition

Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.

ShortA sub-action
Control0..*
TypeSeettp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1941. PlanDefinition.action:checkReportable.action:encounterInProgress
Slice NameencounterInProgress
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.

ShortA sub-action
Control1..1
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1943. PlanDefinition.action:checkReportable.action:encounterInProgress.id
Definition

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

ShortUnique id for inter-element referencing
Control1..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "id" : "is-encounter-in-progress"
}
<id value="is-encounter-in-progress"/>
1945. PlanDefinition.action:checkReportable.action:encounterInProgress.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1947. PlanDefinition.action:checkReportable.action:encounterInProgress.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1949. PlanDefinition.action:checkReportable.action:encounterInProgress.prefix
Definition

A user-visible prefix for the action.

ShortUser-visible prefix for the action (e.g. 1. or A.)
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1951. PlanDefinition.action:checkReportable.action:encounterInProgress.title
Definition

The title of the action displayed to a user.

ShortUser-visible title
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1953. PlanDefinition.action:checkReportable.action:encounterInProgress.description
Definition

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

ShortBrief description of the action
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1955. PlanDefinition.action:checkReportable.action:encounterInProgress.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 might not be capable of interpreting it dynamically.

ShortStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1957. PlanDefinition.action:checkReportable.action:encounterInProgress.priority
Definition

Indicates how quickly the action should be addressed with respect to other actions.

Shortroutine | urgent | asap | stat
Control0..1
BindingThe codes SHALL be taken from RequestPriority
(required to http://hl7.org/fhir/ValueSet/request-priority|4.0.1)

Identifies the level of importance to be assigned to actioning the request.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1959. PlanDefinition.action:checkReportable.action:encounterInProgress.code
Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control1..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "evaluate-condition"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="evaluate-condition"/>
  </coding>
</code>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1961. PlanDefinition.action:checkReportable.action:encounterInProgress.reason
Definition

A description of why this action is necessary or appropriate.

ShortWhy the action should be performed
Comments

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

Control0..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1963. PlanDefinition.action:checkReportable.action:encounterInProgress.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.

ShortSupporting documentation for the intended performer of the action
Control0..*
TypeRelatedArtifact
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1965. PlanDefinition.action:checkReportable.action:encounterInProgress.goalId
Definition

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

ShortWhat goals this action supports
Control0..*
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1967. PlanDefinition.action:checkReportable.action:encounterInProgress.subject[x]
Definition

A code or group definition that describes the intended subject of the action and its children, if any.

ShortType of individual the action is focused on
Comments

The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified.

In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType
(extensible to http://hl7.org/fhir/ValueSet/subject-type|4.0.1)

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

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Requirements

Multiple steps in a protocol often have different groups of steps that are focused on testing different things. The subject of an action specifies the focus of the action and any child actions.

Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1969. PlanDefinition.action:checkReportable.action:encounterInProgress.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1971. PlanDefinition.action:checkReportable.action:encounterInProgress.condition
Definition

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

ShortWhether or not the action is applicable
Comments

When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1973. PlanDefinition.action:checkReportable.action:encounterInProgress.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1975. PlanDefinition.action:checkReportable.action:encounterInProgress.condition.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1977. PlanDefinition.action:checkReportable.action:encounterInProgress.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
1979. PlanDefinition.action:checkReportable.action:encounterInProgress.condition.kind
Definition

The kind of condition.

Shortapplicability | start | stop
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 enter/exit criteria for an action.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKind
(required to http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1)

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Value
{
  "kind" : "applicability"
}
<kind value="applicability"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1981. PlanDefinition.action:checkReportable.action:encounterInProgress.condition.expression
Definition

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

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control1..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1983. PlanDefinition.action:checkReportable.action:encounterInProgress.condition.expression.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
1985. PlanDefinition.action:checkReportable.action:encounterInProgress.condition.expression.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.action.condition.expression.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
1987. PlanDefinition.action:checkReportable.action:encounterInProgress.condition.expression.description
Definition

A brief, natural language description of the condition that effectively communicates the intended semantics.

ShortNatural language description of the condition
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1989. PlanDefinition.action:checkReportable.action:encounterInProgress.condition.expression.name
Definition

A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.

ShortShort name assigned to expression for reuse
Control0..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1991. PlanDefinition.action:checkReportable.action:encounterInProgress.condition.expression.language
Definition

The media type of the language for the expression.

Shorttext/cql | text/fhirpath | application/x-fhir-query | etc.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from ExpressionLanguage
(extensible to http://hl7.org/fhir/ValueSet/expression-language|4.0.1)

The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Fixed Value
{
  "language" : "text/fhirpath"
}
<language value="text/fhirpath"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1993. PlanDefinition.action:checkReportable.action:encounterInProgress.condition.expression.expression
Definition

An expression in the specified language that returns a value.

ShortExpression in specified language
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1995. PlanDefinition.action:checkReportable.action:encounterInProgress.condition.expression.reference
Definition

A URI that defines where the expression is found.

ShortWhere the expression is found
Comments

If both a reference and an expression is found, the reference SHALL point to the same expression.

Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1997. PlanDefinition.action:checkReportable.action:encounterInProgress.input
Definition

Defines input data requirements for the action.

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
1999. PlanDefinition.action:checkReportable.action:encounterInProgress.output
Definition

Defines the outputs of the action, if any.

ShortOutput data definition
Control0..*
TypeDataRequirement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2001. PlanDefinition.action:checkReportable.action:encounterInProgress.relatedAction
Definition

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

ShortRelationship to another action
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.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2003. PlanDefinition.action:checkReportable.action:encounterInProgress.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2005. PlanDefinition.action:checkReportable.action:encounterInProgress.relatedAction.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2007. PlanDefinition.action:checkReportable.action:encounterInProgress.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2009. PlanDefinition.action:checkReportable.action:encounterInProgress.relatedAction.actionId
Definition

The element id of the related action.

ShortWhat action is this related to
Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Value
{
  "actionId" : "check-reportable"
}
<actionId value="check-reportable"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2011. PlanDefinition.action:checkReportable.action:encounterInProgress.relatedAction.relationship
Definition

The relationship of this action to the related action.

Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control1..1
BindingThe codes SHALL be taken from ActionRelationshipType
(required to http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1)

Defines the types of relationships between actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Value
{
  "relationship" : "before-start"
}
<relationship value="before-start"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2013. PlanDefinition.action:checkReportable.action:encounterInProgress.relatedAction.offset[x]
Definition

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

ShortTime offset for the relationship
Control0..1
TypeChoice of: Duration, Range
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action.action.relatedAction.offset[x]. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this

Slicing Note: Other type slices that contain no new information are not shown in this view

2015. PlanDefinition.action:checkReportable.action:encounterInProgress.relatedAction.offset[x]:offsetDuration
Slice NameoffsetDuration
Definition

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

ShortTime offset for the relationship
Control0..1
TypeDuration
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
ExampleWait 6 hours before next action.: { "value" : 6, "unit" : "h" }
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2018. PlanDefinition.action:checkReportable.action:encounterInProgress.timing[x]
Definition

An optional value describing when the action should be performed.

ShortWhen the action should take place
Control0..1
TypeChoice of: dateTime, Age, Period, Duration, Range, Timing
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2020. PlanDefinition.action:checkReportable.action:encounterInProgress.participant
Definition

Indicates who should participate in performing the action described.

ShortWho should participate in the action
Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2022. PlanDefinition.action:checkReportable.action:encounterInProgress.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2024. PlanDefinition.action:checkReportable.action:encounterInProgress.participant.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2026. PlanDefinition.action:checkReportable.action:encounterInProgress.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2028. PlanDefinition.action:checkReportable.action:encounterInProgress.participant.type
Definition

The type of participant in the action.

Shortpatient | practitioner | related-person | device
Control1..1
BindingThe codes SHALL be taken from ActionParticipantType
(required to http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1)

The type of participant for the action.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2030. PlanDefinition.action:checkReportable.action:encounterInProgress.participant.role
Definition

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

ShortE.g. Nurse, Surgeon, Parent
Control0..1
BindingFor example codes, see ActionParticipantRole
(example to http://hl7.org/fhir/ValueSet/action-participant-role|4.0.1)

Defines roles played by participants for the action.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2032. PlanDefinition.action:checkReportable.action:encounterInProgress.type
Definition

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

Shortcreate | update | remove | fire-event
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ActionType
(extensible to http://hl7.org/fhir/ValueSet/action-type|4.0.1)

The type of action to be performed.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2034. PlanDefinition.action:checkReportable.action:encounterInProgress.groupingBehavior
Definition

Defines the grouping behavior for the action and its children.

Shortvisual-group | logical-group | sentence-group
Control0..1
BindingThe codes SHALL be taken from ActionGroupingBehavior
(required to http://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.1)

Defines organization behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2036. PlanDefinition.action:checkReportable.action:encounterInProgress.selectionBehavior
Definition

Defines the selection behavior for the action and its children.

Shortany | all | all-or-none | exactly-one | at-most-one | one-or-more
Control0..1
BindingThe codes SHALL be taken from ActionSelectionBehavior
(required to http://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.1)

Defines selection behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2038. PlanDefinition.action:checkReportable.action:encounterInProgress.requiredBehavior
Definition

Defines the required behavior for the action.

Shortmust | could | must-unless-documented
Control0..1
BindingThe codes SHALL be taken from ActionRequiredBehavior
(required to http://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1)

Defines expectations around whether an action or action group is required.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2040. PlanDefinition.action:checkReportable.action:encounterInProgress.precheckBehavior
Definition

Defines whether the action should usually be preselected.

Shortyes | no
Control0..1
BindingThe codes SHALL be taken from ActionPrecheckBehavior
(required to http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1)

Defines selection frequency behavior for an action or group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2042. PlanDefinition.action:checkReportable.action:encounterInProgress.cardinalityBehavior
Definition

Defines whether the action can be selected multiple times.

Shortsingle | multiple
Control0..1
BindingThe codes SHALL be taken from ActionCardinalityBehavior
(required to http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1)

Defines behavior for an action or a group for how many times that item may be repeated.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2044. PlanDefinition.action:checkReportable.action:encounterInProgress.definition[x]
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.

ShortDescription of the activity to be performed
Comments

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

Control0..1
TypeChoice of: canonical(ActivityDefinition, PlanDefinition, Questionnaire), uri
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2046. PlanDefinition.action:checkReportable.action:encounterInProgress.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.

ShortTransform to apply the template
Comments

Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..1
Typecanonical(StructureMap)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2048. PlanDefinition.action:checkReportable.action:encounterInProgress.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.

ShortDynamic aspects of the definition
Comments

Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2050. PlanDefinition.action:checkReportable.action:encounterInProgress.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2052. PlanDefinition.action:checkReportable.action:encounterInProgress.dynamicValue.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2054. PlanDefinition.action:checkReportable.action:encounterInProgress.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2056. PlanDefinition.action:checkReportable.action:encounterInProgress.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. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details).

ShortThe path to the element to be set dynamically
Comments

To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2058. PlanDefinition.action:checkReportable.action:encounterInProgress.dynamicValue.expression
Definition

An expression specifying the value of the customized element.

ShortAn expression that provides the dynamic value for the customization
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2060. PlanDefinition.action:checkReportable.action:encounterInProgress.action
Definition

Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.

ShortA sub-action
Control0..*
TypeSeettp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2062. PlanDefinition.action:checkReportable.action:ambEncounterInProgress
Slice NameambEncounterInProgress
Definition

Continues the reportability check loop for an ambulatory encounter that is still in progress and within the ambulatory reporting duration.

ShortAmbulatory encounter in progress
Control1..1
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2064. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.id
Definition

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

ShortUnique id for inter-element referencing
Control1..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "id" : "is-amb-encounter-in-progress"
}
<id value="is-amb-encounter-in-progress"/>
2066. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2068. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2070. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.prefix
Definition

A user-visible prefix for the action.

ShortUser-visible prefix for the action (e.g. 1. or A.)
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2072. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.title
Definition

The title of the action displayed to a user.

ShortUser-visible title
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2074. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.description
Definition

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

ShortBrief description of the action
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2076. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.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 might not be capable of interpreting it dynamically.

ShortStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2078. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.priority
Definition

Indicates how quickly the action should be addressed with respect to other actions.

Shortroutine | urgent | asap | stat
Control0..1
BindingThe codes SHALL be taken from RequestPriority
(required to http://hl7.org/fhir/ValueSet/request-priority|4.0.1)

Identifies the level of importance to be assigned to actioning the request.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2080. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.code
Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control1..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "evaluate-condition"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="evaluate-condition"/>
  </coding>
</code>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2082. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.reason
Definition

A description of why this action is necessary or appropriate.

ShortWhy the action should be performed
Comments

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

Control0..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2084. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.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.

ShortSupporting documentation for the intended performer of the action
Control0..*
TypeRelatedArtifact
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2086. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.goalId
Definition

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

ShortWhat goals this action supports
Control0..*
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2088. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.subject[x]
Definition

A code or group definition that describes the intended subject of the action and its children, if any.

ShortType of individual the action is focused on
Comments

The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified.

In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType
(extensible to http://hl7.org/fhir/ValueSet/subject-type|4.0.1)

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

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Requirements

Multiple steps in a protocol often have different groups of steps that are focused on testing different things. The subject of an action specifies the focus of the action and any child actions.

Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2090. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2092. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.condition
Definition

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

ShortWhether or not the action is applicable
Comments

When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2094. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2096. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.condition.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2098. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2100. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.condition.kind
Definition

The kind of condition.

Shortapplicability | start | stop
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 enter/exit criteria for an action.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKind
(required to http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1)

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Value
{
  "kind" : "applicability"
}
<kind value="applicability"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2102. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.condition.expression
Definition

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

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control1..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2104. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.condition.expression.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2106. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.condition.expression.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.action.condition.expression.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
2108. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.condition.expression.description
Definition

A brief, natural language description of the condition that effectively communicates the intended semantics.

ShortNatural language description of the condition
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2110. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.condition.expression.name
Definition

A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.

ShortShort name assigned to expression for reuse
Control0..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2112. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.condition.expression.language
Definition

The media type of the language for the expression.

Shorttext/cql | text/fhirpath | application/x-fhir-query | etc.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from ExpressionLanguage
(extensible to http://hl7.org/fhir/ValueSet/expression-language|4.0.1)

The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Fixed Value
{
  "language" : "text/fhirpath"
}
<language value="text/fhirpath"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2114. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.condition.expression.expression
Definition

An expression in the specified language that returns a value.

ShortExpression in specified language
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2116. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.condition.expression.reference
Definition

A URI that defines where the expression is found.

ShortWhere the expression is found
Comments

If both a reference and an expression is found, the reference SHALL point to the same expression.

Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2118. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.input
Definition

Defines input data requirements for the action.

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2120. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.output
Definition

Defines the outputs of the action, if any.

ShortOutput data definition
Control0..*
TypeDataRequirement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2122. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.relatedAction
Definition

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

ShortRelationship to another action
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.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2124. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2126. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.relatedAction.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2128. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2130. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.relatedAction.actionId
Definition

The element id of the related action.

ShortWhat action is this related to
Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Value
{
  "actionId" : "check-reportable"
}
<actionId value="check-reportable"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2132. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.relatedAction.relationship
Definition

The relationship of this action to the related action.

Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control1..1
BindingThe codes SHALL be taken from ActionRelationshipType
(required to http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1)

Defines the types of relationships between actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Value
{
  "relationship" : "before-start"
}
<relationship value="before-start"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2134. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.relatedAction.offset[x]
Definition

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

ShortTime offset for the relationship
Control0..1
TypeChoice of: Duration, Range
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action.action.relatedAction.offset[x]. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this

Slicing Note: Other type slices that contain no new information are not shown in this view

2136. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.relatedAction.offset[x]:offsetDuration
Slice NameoffsetDuration
Definition

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

ShortTime offset for the relationship
Control0..1
TypeDuration
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2139. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.timing[x]
Definition

An optional value describing when the action should be performed.

ShortWhen the action should take place
Control0..1
TypeChoice of: dateTime, Age, Period, Duration, Range, Timing
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2141. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.participant
Definition

Indicates who should participate in performing the action described.

ShortWho should participate in the action
Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2143. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2145. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.participant.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2147. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2149. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.participant.type
Definition

The type of participant in the action.

Shortpatient | practitioner | related-person | device
Control1..1
BindingThe codes SHALL be taken from ActionParticipantType
(required to http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1)

The type of participant for the action.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2151. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.participant.role
Definition

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

ShortE.g. Nurse, Surgeon, Parent
Control0..1
BindingFor example codes, see ActionParticipantRole
(example to http://hl7.org/fhir/ValueSet/action-participant-role|4.0.1)

Defines roles played by participants for the action.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2153. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.type
Definition

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

Shortcreate | update | remove | fire-event
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ActionType
(extensible to http://hl7.org/fhir/ValueSet/action-type|4.0.1)

The type of action to be performed.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2155. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.groupingBehavior
Definition

Defines the grouping behavior for the action and its children.

Shortvisual-group | logical-group | sentence-group
Control0..1
BindingThe codes SHALL be taken from ActionGroupingBehavior
(required to http://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.1)

Defines organization behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2157. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.selectionBehavior
Definition

Defines the selection behavior for the action and its children.

Shortany | all | all-or-none | exactly-one | at-most-one | one-or-more
Control0..1
BindingThe codes SHALL be taken from ActionSelectionBehavior
(required to http://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.1)

Defines selection behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2159. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.requiredBehavior
Definition

Defines the required behavior for the action.

Shortmust | could | must-unless-documented
Control0..1
BindingThe codes SHALL be taken from ActionRequiredBehavior
(required to http://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1)

Defines expectations around whether an action or action group is required.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2161. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.precheckBehavior
Definition

Defines whether the action should usually be preselected.

Shortyes | no
Control0..1
BindingThe codes SHALL be taken from ActionPrecheckBehavior
(required to http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1)

Defines selection frequency behavior for an action or group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2163. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.cardinalityBehavior
Definition

Defines whether the action can be selected multiple times.

Shortsingle | multiple
Control0..1
BindingThe codes SHALL be taken from ActionCardinalityBehavior
(required to http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1)

Defines behavior for an action or a group for how many times that item may be repeated.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2165. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.definition[x]
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.

ShortDescription of the activity to be performed
Comments

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

Control0..1
TypeChoice of: canonical(ActivityDefinition, PlanDefinition, Questionnaire), uri
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2167. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.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.

ShortTransform to apply the template
Comments

Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..1
Typecanonical(StructureMap)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2169. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.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.

ShortDynamic aspects of the definition
Comments

Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2171. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2173. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.dynamicValue.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2175. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2177. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.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. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details).

ShortThe path to the element to be set dynamically
Comments

To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2179. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.dynamicValue.expression
Definition

An expression specifying the value of the customized element.

ShortAn expression that provides the dynamic value for the customization
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2181. PlanDefinition.action:checkReportable.action:ambEncounterInProgress.action
Definition

Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.

ShortA sub-action
Control0..*
TypeSeettp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2183. PlanDefinition.action:checkReportable.action:terminateEncounter
Slice NameterminateEncounter
Definition

Terminates the reporting workflow for an inpatient, emergency or observation encounter that has passed the normal reporting duration or the post-encounter grace period.

ShortTerminate an inpatient encounter
Control1..1
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2185. PlanDefinition.action:checkReportable.action:terminateEncounter.id
Definition

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

ShortUnique id for inter-element referencing
Control1..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "id" : "terminate-encounter"
}
<id value="terminate-encounter"/>
2187. PlanDefinition.action:checkReportable.action:terminateEncounter.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2189. PlanDefinition.action:checkReportable.action:terminateEncounter.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2191. PlanDefinition.action:checkReportable.action:terminateEncounter.prefix
Definition

A user-visible prefix for the action.

ShortUser-visible prefix for the action (e.g. 1. or A.)
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2193. PlanDefinition.action:checkReportable.action:terminateEncounter.title
Definition

The title of the action displayed to a user.

ShortUser-visible title
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2195. PlanDefinition.action:checkReportable.action:terminateEncounter.description
Definition

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

ShortBrief description of the action
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2197. PlanDefinition.action:checkReportable.action:terminateEncounter.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 might not be capable of interpreting it dynamically.

ShortStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2199. PlanDefinition.action:checkReportable.action:terminateEncounter.priority
Definition

Indicates how quickly the action should be addressed with respect to other actions.

Shortroutine | urgent | asap | stat
Control0..1
BindingThe codes SHALL be taken from RequestPriority
(required to http://hl7.org/fhir/ValueSet/request-priority|4.0.1)

Identifies the level of importance to be assigned to actioning the request.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2201. PlanDefinition.action:checkReportable.action:terminateEncounter.code
Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control1..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "terminate-reporting-workflow"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="terminate-reporting-workflow"/>
  </coding>
</code>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2203. PlanDefinition.action:checkReportable.action:terminateEncounter.reason
Definition

A description of why this action is necessary or appropriate.

ShortWhy the action should be performed
Comments

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

Control0..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2205. PlanDefinition.action:checkReportable.action:terminateEncounter.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.

ShortSupporting documentation for the intended performer of the action
Control0..*
TypeRelatedArtifact
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2207. PlanDefinition.action:checkReportable.action:terminateEncounter.goalId
Definition

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

ShortWhat goals this action supports
Control0..*
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2209. PlanDefinition.action:checkReportable.action:terminateEncounter.subject[x]
Definition

A code or group definition that describes the intended subject of the action and its children, if any.

ShortType of individual the action is focused on
Comments

The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified.

In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType
(extensible to http://hl7.org/fhir/ValueSet/subject-type|4.0.1)

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

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Requirements

Multiple steps in a protocol often have different groups of steps that are focused on testing different things. The subject of an action specifies the focus of the action and any child actions.

Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2211. PlanDefinition.action:checkReportable.action:terminateEncounter.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2213. PlanDefinition.action:checkReportable.action:terminateEncounter.condition
Definition

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

ShortWhether or not the action is applicable
Comments

When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2215. PlanDefinition.action:checkReportable.action:terminateEncounter.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2217. PlanDefinition.action:checkReportable.action:terminateEncounter.condition.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2219. PlanDefinition.action:checkReportable.action:terminateEncounter.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2221. PlanDefinition.action:checkReportable.action:terminateEncounter.condition.kind
Definition

The kind of condition.

Shortapplicability | start | stop
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 enter/exit criteria for an action.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKind
(required to http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1)

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Value
{
  "kind" : "applicability"
}
<kind value="applicability"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2223. PlanDefinition.action:checkReportable.action:terminateEncounter.condition.expression
Definition

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

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control1..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2225. PlanDefinition.action:checkReportable.action:terminateEncounter.condition.expression.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2227. PlanDefinition.action:checkReportable.action:terminateEncounter.condition.expression.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.action.condition.expression.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
2229. PlanDefinition.action:checkReportable.action:terminateEncounter.condition.expression.description
Definition

A brief, natural language description of the condition that effectively communicates the intended semantics.

ShortNatural language description of the condition
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2231. PlanDefinition.action:checkReportable.action:terminateEncounter.condition.expression.name
Definition

A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.

ShortShort name assigned to expression for reuse
Control0..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2233. PlanDefinition.action:checkReportable.action:terminateEncounter.condition.expression.language
Definition

The media type of the language for the expression.

Shorttext/cql | text/fhirpath | application/x-fhir-query | etc.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from ExpressionLanguage
(extensible to http://hl7.org/fhir/ValueSet/expression-language|4.0.1)

The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Fixed Value
{
  "language" : "text/fhirpath"
}
<language value="text/fhirpath"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2235. PlanDefinition.action:checkReportable.action:terminateEncounter.condition.expression.expression
Definition

An expression in the specified language that returns a value.

ShortExpression in specified language
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2237. PlanDefinition.action:checkReportable.action:terminateEncounter.condition.expression.reference
Definition

A URI that defines where the expression is found.

ShortWhere the expression is found
Comments

If both a reference and an expression is found, the reference SHALL point to the same expression.

Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2239. PlanDefinition.action:checkReportable.action:terminateEncounter.input
Definition

Defines input data requirements for the action.

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2241. PlanDefinition.action:checkReportable.action:terminateEncounter.output
Definition

Defines the outputs of the action, if any.

ShortOutput data definition
Control0..*
TypeDataRequirement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2243. PlanDefinition.action:checkReportable.action:terminateEncounter.relatedAction
Definition

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

ShortRelationship to another action
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.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2245. PlanDefinition.action:checkReportable.action:terminateEncounter.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2247. PlanDefinition.action:checkReportable.action:terminateEncounter.relatedAction.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2249. PlanDefinition.action:checkReportable.action:terminateEncounter.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2251. PlanDefinition.action:checkReportable.action:terminateEncounter.relatedAction.actionId
Definition

The element id of the related action.

ShortWhat action is this related to
Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2253. PlanDefinition.action:checkReportable.action:terminateEncounter.relatedAction.relationship
Definition

The relationship of this action to the related action.

Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control1..1
BindingThe codes SHALL be taken from ActionRelationshipType
(required to http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1)

Defines the types of relationships between actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2255. PlanDefinition.action:checkReportable.action:terminateEncounter.relatedAction.offset[x]
Definition

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

ShortTime offset for the relationship
Control0..1
TypeChoice of: Duration, Range
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2257. PlanDefinition.action:checkReportable.action:terminateEncounter.timing[x]
Definition

An optional value describing when the action should be performed.

ShortWhen the action should take place
Control0..1
TypeChoice of: dateTime, Age, Period, Duration, Range, Timing
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2259. PlanDefinition.action:checkReportable.action:terminateEncounter.participant
Definition

Indicates who should participate in performing the action described.

ShortWho should participate in the action
Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2261. PlanDefinition.action:checkReportable.action:terminateEncounter.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2263. PlanDefinition.action:checkReportable.action:terminateEncounter.participant.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2265. PlanDefinition.action:checkReportable.action:terminateEncounter.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2267. PlanDefinition.action:checkReportable.action:terminateEncounter.participant.type
Definition

The type of participant in the action.

Shortpatient | practitioner | related-person | device
Control1..1
BindingThe codes SHALL be taken from ActionParticipantType
(required to http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1)

The type of participant for the action.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2269. PlanDefinition.action:checkReportable.action:terminateEncounter.participant.role
Definition

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

ShortE.g. Nurse, Surgeon, Parent
Control0..1
BindingFor example codes, see ActionParticipantRole
(example to http://hl7.org/fhir/ValueSet/action-participant-role|4.0.1)

Defines roles played by participants for the action.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2271. PlanDefinition.action:checkReportable.action:terminateEncounter.type
Definition

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

Shortcreate | update | remove | fire-event
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ActionType
(extensible to http://hl7.org/fhir/ValueSet/action-type|4.0.1)

The type of action to be performed.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2273. PlanDefinition.action:checkReportable.action:terminateEncounter.groupingBehavior
Definition

Defines the grouping behavior for the action and its children.

Shortvisual-group | logical-group | sentence-group
Control0..1
BindingThe codes SHALL be taken from ActionGroupingBehavior
(required to http://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.1)

Defines organization behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2275. PlanDefinition.action:checkReportable.action:terminateEncounter.selectionBehavior
Definition

Defines the selection behavior for the action and its children.

Shortany | all | all-or-none | exactly-one | at-most-one | one-or-more
Control0..1
BindingThe codes SHALL be taken from ActionSelectionBehavior
(required to http://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.1)

Defines selection behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2277. PlanDefinition.action:checkReportable.action:terminateEncounter.requiredBehavior
Definition

Defines the required behavior for the action.

Shortmust | could | must-unless-documented
Control0..1
BindingThe codes SHALL be taken from ActionRequiredBehavior
(required to http://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1)

Defines expectations around whether an action or action group is required.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2279. PlanDefinition.action:checkReportable.action:terminateEncounter.precheckBehavior
Definition

Defines whether the action should usually be preselected.

Shortyes | no
Control0..1
BindingThe codes SHALL be taken from ActionPrecheckBehavior
(required to http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1)

Defines selection frequency behavior for an action or group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2281. PlanDefinition.action:checkReportable.action:terminateEncounter.cardinalityBehavior
Definition

Defines whether the action can be selected multiple times.

Shortsingle | multiple
Control0..1
BindingThe codes SHALL be taken from ActionCardinalityBehavior
(required to http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1)

Defines behavior for an action or a group for how many times that item may be repeated.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2283. PlanDefinition.action:checkReportable.action:terminateEncounter.definition[x]
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.

ShortDescription of the activity to be performed
Comments

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

Control0..1
TypeChoice of: canonical(ActivityDefinition, PlanDefinition, Questionnaire), uri
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2285. PlanDefinition.action:checkReportable.action:terminateEncounter.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.

ShortTransform to apply the template
Comments

Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..1
Typecanonical(StructureMap)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2287. PlanDefinition.action:checkReportable.action:terminateEncounter.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.

ShortDynamic aspects of the definition
Comments

Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2289. PlanDefinition.action:checkReportable.action:terminateEncounter.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2291. PlanDefinition.action:checkReportable.action:terminateEncounter.dynamicValue.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2293. PlanDefinition.action:checkReportable.action:terminateEncounter.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2295. PlanDefinition.action:checkReportable.action:terminateEncounter.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. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details).

ShortThe path to the element to be set dynamically
Comments

To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2297. PlanDefinition.action:checkReportable.action:terminateEncounter.dynamicValue.expression
Definition

An expression specifying the value of the customized element.

ShortAn expression that provides the dynamic value for the customization
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2299. PlanDefinition.action:checkReportable.action:terminateEncounter.action
Definition

Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.

ShortA sub-action
Control0..*
TypeSeettp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2301. PlanDefinition.action:checkReportable.action:terminateAmbEncounter
Slice NameterminateAmbEncounter
Definition

Terminates the reporting workflow for an ambulatory, virtual or home health encounter that has passed the ambulatory reporting duration or the post-encounter grace period.

ShortTerminate an ambulatory encounter
Control1..1
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2303. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.id
Definition

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

ShortUnique id for inter-element referencing
Control1..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "id" : "terminate-amb-encounter"
}
<id value="terminate-amb-encounter"/>
2305. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2307. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2309. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.prefix
Definition

A user-visible prefix for the action.

ShortUser-visible prefix for the action (e.g. 1. or A.)
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2311. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.title
Definition

The title of the action displayed to a user.

ShortUser-visible title
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2313. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.description
Definition

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

ShortBrief description of the action
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2315. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.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 might not be capable of interpreting it dynamically.

ShortStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2317. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.priority
Definition

Indicates how quickly the action should be addressed with respect to other actions.

Shortroutine | urgent | asap | stat
Control0..1
BindingThe codes SHALL be taken from RequestPriority
(required to http://hl7.org/fhir/ValueSet/request-priority|4.0.1)

Identifies the level of importance to be assigned to actioning the request.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2319. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.code
Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control1..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "terminate-reporting-workflow"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="terminate-reporting-workflow"/>
  </coding>
</code>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2321. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.reason
Definition

A description of why this action is necessary or appropriate.

ShortWhy the action should be performed
Comments

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

Control0..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2323. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.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.

ShortSupporting documentation for the intended performer of the action
Control0..*
TypeRelatedArtifact
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2325. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.goalId
Definition

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

ShortWhat goals this action supports
Control0..*
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2327. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.subject[x]
Definition

A code or group definition that describes the intended subject of the action and its children, if any.

ShortType of individual the action is focused on
Comments

The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified.

In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType
(extensible to http://hl7.org/fhir/ValueSet/subject-type|4.0.1)

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

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Requirements

Multiple steps in a protocol often have different groups of steps that are focused on testing different things. The subject of an action specifies the focus of the action and any child actions.

Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2329. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2331. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.condition
Definition

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

ShortWhether or not the action is applicable
Comments

When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2333. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2335. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.condition.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2337. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2339. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.condition.kind
Definition

The kind of condition.

Shortapplicability | start | stop
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 enter/exit criteria for an action.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKind
(required to http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1)

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Value
{
  "kind" : "applicability"
}
<kind value="applicability"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2341. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.condition.expression
Definition

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

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control1..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2343. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.condition.expression.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2345. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.condition.expression.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.action.condition.expression.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
2347. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.condition.expression.description
Definition

A brief, natural language description of the condition that effectively communicates the intended semantics.

ShortNatural language description of the condition
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2349. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.condition.expression.name
Definition

A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.

ShortShort name assigned to expression for reuse
Control0..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2351. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.condition.expression.language
Definition

The media type of the language for the expression.

Shorttext/cql | text/fhirpath | application/x-fhir-query | etc.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from ExpressionLanguage
(extensible to http://hl7.org/fhir/ValueSet/expression-language|4.0.1)

The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Fixed Value
{
  "language" : "text/fhirpath"
}
<language value="text/fhirpath"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2353. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.condition.expression.expression
Definition

An expression in the specified language that returns a value.

ShortExpression in specified language
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2355. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.condition.expression.reference
Definition

A URI that defines where the expression is found.

ShortWhere the expression is found
Comments

If both a reference and an expression is found, the reference SHALL point to the same expression.

Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2357. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.input
Definition

Defines input data requirements for the action.

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2359. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.output
Definition

Defines the outputs of the action, if any.

ShortOutput data definition
Control0..*
TypeDataRequirement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2361. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.relatedAction
Definition

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

ShortRelationship to another action
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.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2363. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2365. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.relatedAction.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2367. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2369. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.relatedAction.actionId
Definition

The element id of the related action.

ShortWhat action is this related to
Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2371. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.relatedAction.relationship
Definition

The relationship of this action to the related action.

Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control1..1
BindingThe codes SHALL be taken from ActionRelationshipType
(required to http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1)

Defines the types of relationships between actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2373. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.relatedAction.offset[x]
Definition

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

ShortTime offset for the relationship
Control0..1
TypeChoice of: Duration, Range
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2375. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.timing[x]
Definition

An optional value describing when the action should be performed.

ShortWhen the action should take place
Control0..1
TypeChoice of: dateTime, Age, Period, Duration, Range, Timing
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2377. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.participant
Definition

Indicates who should participate in performing the action described.

ShortWho should participate in the action
Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2379. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2381. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.participant.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2383. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2385. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.participant.type
Definition

The type of participant in the action.

Shortpatient | practitioner | related-person | device
Control1..1
BindingThe codes SHALL be taken from ActionParticipantType
(required to http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1)

The type of participant for the action.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2387. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.participant.role
Definition

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

ShortE.g. Nurse, Surgeon, Parent
Control0..1
BindingFor example codes, see ActionParticipantRole
(example to http://hl7.org/fhir/ValueSet/action-participant-role|4.0.1)

Defines roles played by participants for the action.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2389. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.type
Definition

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

Shortcreate | update | remove | fire-event
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ActionType
(extensible to http://hl7.org/fhir/ValueSet/action-type|4.0.1)

The type of action to be performed.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2391. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.groupingBehavior
Definition

Defines the grouping behavior for the action and its children.

Shortvisual-group | logical-group | sentence-group
Control0..1
BindingThe codes SHALL be taken from ActionGroupingBehavior
(required to http://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.1)

Defines organization behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2393. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.selectionBehavior
Definition

Defines the selection behavior for the action and its children.

Shortany | all | all-or-none | exactly-one | at-most-one | one-or-more
Control0..1
BindingThe codes SHALL be taken from ActionSelectionBehavior
(required to http://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.1)

Defines selection behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2395. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.requiredBehavior
Definition

Defines the required behavior for the action.

Shortmust | could | must-unless-documented
Control0..1
BindingThe codes SHALL be taken from ActionRequiredBehavior
(required to http://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1)

Defines expectations around whether an action or action group is required.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2397. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.precheckBehavior
Definition

Defines whether the action should usually be preselected.

Shortyes | no
Control0..1
BindingThe codes SHALL be taken from ActionPrecheckBehavior
(required to http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1)

Defines selection frequency behavior for an action or group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2399. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.cardinalityBehavior
Definition

Defines whether the action can be selected multiple times.

Shortsingle | multiple
Control0..1
BindingThe codes SHALL be taken from ActionCardinalityBehavior
(required to http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1)

Defines behavior for an action or a group for how many times that item may be repeated.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2401. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.definition[x]
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.

ShortDescription of the activity to be performed
Comments

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

Control0..1
TypeChoice of: canonical(ActivityDefinition, PlanDefinition, Questionnaire), uri
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2403. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.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.

ShortTransform to apply the template
Comments

Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..1
Typecanonical(StructureMap)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2405. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.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.

ShortDynamic aspects of the definition
Comments

Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2407. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2409. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.dynamicValue.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2411. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2413. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.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. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details).

ShortThe path to the element to be set dynamically
Comments

To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2415. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.dynamicValue.expression
Definition

An expression specifying the value of the customized element.

ShortAn expression that provides the dynamic value for the customization
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2417. PlanDefinition.action:checkReportable.action:terminateAmbEncounter.action
Definition

Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.

ShortA sub-action
Control0..*
TypeSeettp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2419. PlanDefinition.action:checkReportable.action:encounterComplete
Slice NameencounterComplete
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.

ShortA sub-action
Control1..1
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2421. PlanDefinition.action:checkReportable.action:encounterComplete.id
Definition

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

ShortUnique id for inter-element referencing
Control1..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "id" : "is-encounter-completed"
}
<id value="is-encounter-completed"/>
2423. PlanDefinition.action:checkReportable.action:encounterComplete.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2425. PlanDefinition.action:checkReportable.action:encounterComplete.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2427. PlanDefinition.action:checkReportable.action:encounterComplete.prefix
Definition

A user-visible prefix for the action.

ShortUser-visible prefix for the action (e.g. 1. or A.)
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2429. PlanDefinition.action:checkReportable.action:encounterComplete.title
Definition

The title of the action displayed to a user.

ShortUser-visible title
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2431. PlanDefinition.action:checkReportable.action:encounterComplete.description
Definition

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

ShortBrief description of the action
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2433. PlanDefinition.action:checkReportable.action:encounterComplete.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 might not be capable of interpreting it dynamically.

ShortStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2435. PlanDefinition.action:checkReportable.action:encounterComplete.priority
Definition

Indicates how quickly the action should be addressed with respect to other actions.

Shortroutine | urgent | asap | stat
Control0..1
BindingThe codes SHALL be taken from RequestPriority
(required to http://hl7.org/fhir/ValueSet/request-priority|4.0.1)

Identifies the level of importance to be assigned to actioning the request.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2437. PlanDefinition.action:checkReportable.action:encounterComplete.code
Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control1..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "complete-reporting"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="complete-reporting"/>
  </coding>
</code>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2439. PlanDefinition.action:checkReportable.action:encounterComplete.reason
Definition

A description of why this action is necessary or appropriate.

ShortWhy the action should be performed
Comments

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

Control0..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2441. PlanDefinition.action:checkReportable.action:encounterComplete.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.

ShortSupporting documentation for the intended performer of the action
Control0..*
TypeRelatedArtifact
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2443. PlanDefinition.action:checkReportable.action:encounterComplete.goalId
Definition

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

ShortWhat goals this action supports
Control0..*
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2445. PlanDefinition.action:checkReportable.action:encounterComplete.subject[x]
Definition

A code or group definition that describes the intended subject of the action and its children, if any.

ShortType of individual the action is focused on
Comments

The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified.

In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType
(extensible to http://hl7.org/fhir/ValueSet/subject-type|4.0.1)

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

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Requirements

Multiple steps in a protocol often have different groups of steps that are focused on testing different things. The subject of an action specifies the focus of the action and any child actions.

Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2447. PlanDefinition.action:checkReportable.action:encounterComplete.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2449. PlanDefinition.action:checkReportable.action:encounterComplete.condition
Definition

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

ShortWhether or not the action is applicable
Comments

When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2451. PlanDefinition.action:checkReportable.action:encounterComplete.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2453. PlanDefinition.action:checkReportable.action:encounterComplete.condition.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2455. PlanDefinition.action:checkReportable.action:encounterComplete.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2457. PlanDefinition.action:checkReportable.action:encounterComplete.condition.kind
Definition

The kind of condition.

Shortapplicability | start | stop
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 enter/exit criteria for an action.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKind
(required to http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1)

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Value
{
  "kind" : "applicability"
}
<kind value="applicability"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2459. PlanDefinition.action:checkReportable.action:encounterComplete.condition.expression
Definition

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

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control1..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2461. PlanDefinition.action:checkReportable.action:encounterComplete.condition.expression.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2463. PlanDefinition.action:checkReportable.action:encounterComplete.condition.expression.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.action.condition.expression.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
2465. PlanDefinition.action:checkReportable.action:encounterComplete.condition.expression.description
Definition

A brief, natural language description of the condition that effectively communicates the intended semantics.

ShortNatural language description of the condition
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2467. PlanDefinition.action:checkReportable.action:encounterComplete.condition.expression.name
Definition

A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.

ShortShort name assigned to expression for reuse
Control0..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2469. PlanDefinition.action:checkReportable.action:encounterComplete.condition.expression.language
Definition

The media type of the language for the expression.

Shorttext/cql | text/fhirpath | application/x-fhir-query | etc.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from ExpressionLanguage
(extensible to http://hl7.org/fhir/ValueSet/expression-language|4.0.1)

The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Fixed Value
{
  "language" : "text/fhirpath"
}
<language value="text/fhirpath"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2471. PlanDefinition.action:checkReportable.action:encounterComplete.condition.expression.expression
Definition

An expression in the specified language that returns a value.

ShortExpression in specified language
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2473. PlanDefinition.action:checkReportable.action:encounterComplete.condition.expression.reference
Definition

A URI that defines where the expression is found.

ShortWhere the expression is found
Comments

If both a reference and an expression is found, the reference SHALL point to the same expression.

Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2475. PlanDefinition.action:checkReportable.action:encounterComplete.input
Definition

Defines input data requirements for the action.

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2477. PlanDefinition.action:checkReportable.action:encounterComplete.output
Definition

Defines the outputs of the action, if any.

ShortOutput data definition
Control0..*
TypeDataRequirement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2479. PlanDefinition.action:checkReportable.action:encounterComplete.relatedAction
Definition

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

ShortRelationship to another action
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.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2481. PlanDefinition.action:checkReportable.action:encounterComplete.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2483. PlanDefinition.action:checkReportable.action:encounterComplete.relatedAction.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2485. PlanDefinition.action:checkReportable.action:encounterComplete.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2487. PlanDefinition.action:checkReportable.action:encounterComplete.relatedAction.actionId
Definition

The element id of the related action.

ShortWhat action is this related to
Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2489. PlanDefinition.action:checkReportable.action:encounterComplete.relatedAction.relationship
Definition

The relationship of this action to the related action.

Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control1..1
BindingThe codes SHALL be taken from ActionRelationshipType
(required to http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1)

Defines the types of relationships between actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2491. PlanDefinition.action:checkReportable.action:encounterComplete.relatedAction.offset[x]
Definition

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

ShortTime offset for the relationship
Control0..1
TypeChoice of: Duration, Range
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2493. PlanDefinition.action:checkReportable.action:encounterComplete.timing[x]
Definition

An optional value describing when the action should be performed.

ShortWhen the action should take place
Control0..1
TypeChoice of: dateTime, Age, Period, Duration, Range, Timing
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2495. PlanDefinition.action:checkReportable.action:encounterComplete.participant
Definition

Indicates who should participate in performing the action described.

ShortWho should participate in the action
Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2497. PlanDefinition.action:checkReportable.action:encounterComplete.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2499. PlanDefinition.action:checkReportable.action:encounterComplete.participant.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2501. PlanDefinition.action:checkReportable.action:encounterComplete.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2503. PlanDefinition.action:checkReportable.action:encounterComplete.participant.type
Definition

The type of participant in the action.

Shortpatient | practitioner | related-person | device
Control1..1
BindingThe codes SHALL be taken from ActionParticipantType
(required to http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1)

The type of participant for the action.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2505. PlanDefinition.action:checkReportable.action:encounterComplete.participant.role
Definition

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

ShortE.g. Nurse, Surgeon, Parent
Control0..1
BindingFor example codes, see ActionParticipantRole
(example to http://hl7.org/fhir/ValueSet/action-participant-role|4.0.1)

Defines roles played by participants for the action.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2507. PlanDefinition.action:checkReportable.action:encounterComplete.type
Definition

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

Shortcreate | update | remove | fire-event
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ActionType
(extensible to http://hl7.org/fhir/ValueSet/action-type|4.0.1)

The type of action to be performed.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2509. PlanDefinition.action:checkReportable.action:encounterComplete.groupingBehavior
Definition

Defines the grouping behavior for the action and its children.

Shortvisual-group | logical-group | sentence-group
Control0..1
BindingThe codes SHALL be taken from ActionGroupingBehavior
(required to http://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.1)

Defines organization behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2511. PlanDefinition.action:checkReportable.action:encounterComplete.selectionBehavior
Definition

Defines the selection behavior for the action and its children.

Shortany | all | all-or-none | exactly-one | at-most-one | one-or-more
Control0..1
BindingThe codes SHALL be taken from ActionSelectionBehavior
(required to http://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.1)

Defines selection behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2513. PlanDefinition.action:checkReportable.action:encounterComplete.requiredBehavior
Definition

Defines the required behavior for the action.

Shortmust | could | must-unless-documented
Control0..1
BindingThe codes SHALL be taken from ActionRequiredBehavior
(required to http://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1)

Defines expectations around whether an action or action group is required.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2515. PlanDefinition.action:checkReportable.action:encounterComplete.precheckBehavior
Definition

Defines whether the action should usually be preselected.

Shortyes | no
Control0..1
BindingThe codes SHALL be taken from ActionPrecheckBehavior
(required to http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1)

Defines selection frequency behavior for an action or group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2517. PlanDefinition.action:checkReportable.action:encounterComplete.cardinalityBehavior
Definition

Defines whether the action can be selected multiple times.

Shortsingle | multiple
Control0..1
BindingThe codes SHALL be taken from ActionCardinalityBehavior
(required to http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1)

Defines behavior for an action or a group for how many times that item may be repeated.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2519. PlanDefinition.action:checkReportable.action:encounterComplete.definition[x]
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.

ShortDescription of the activity to be performed
Comments

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

Control0..1
TypeChoice of: canonical(ActivityDefinition, PlanDefinition, Questionnaire), uri
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2521. PlanDefinition.action:checkReportable.action:encounterComplete.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.

ShortTransform to apply the template
Comments

Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..1
Typecanonical(StructureMap)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2523. PlanDefinition.action:checkReportable.action:encounterComplete.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.

ShortDynamic aspects of the definition
Comments

Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2525. PlanDefinition.action:checkReportable.action:encounterComplete.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2527. PlanDefinition.action:checkReportable.action:encounterComplete.dynamicValue.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2529. PlanDefinition.action:checkReportable.action:encounterComplete.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2531. PlanDefinition.action:checkReportable.action:encounterComplete.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. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details).

ShortThe path to the element to be set dynamically
Comments

To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2533. PlanDefinition.action:checkReportable.action:encounterComplete.dynamicValue.expression
Definition

An expression specifying the value of the customized element.

ShortAn expression that provides the dynamic value for the customization
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2535. PlanDefinition.action:checkReportable.action:encounterComplete.action
Definition

Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.

ShortA sub-action
Control0..*
TypeSeettp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2537. PlanDefinition.action:createEicr
Slice NamecreateEicr
Definition

Defines the "create-eicr" action

ShortCreate the eICR
Comments

Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.

Control1..1
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2539. PlanDefinition.action:createEicr.id
Definition

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

ShortUnique id for inter-element referencing
Control1..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "id" : "create-eicr"
}
<id value="create-eicr"/>
2541. PlanDefinition.action:createEicr.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2543. PlanDefinition.action:createEicr.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2545. PlanDefinition.action:createEicr.prefix
Definition

A user-visible prefix for the action.

ShortUser-visible prefix for the action (e.g. 1. or A.)
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2547. PlanDefinition.action:createEicr.title
Definition

The title of the action displayed to a user.

ShortUser-visible title
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2549. PlanDefinition.action:createEicr.description
Definition

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

ShortBrief description of the action
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Value
{
  "description" : "This action represents the creation of the eICR. It subsequently calls validate."
}
<description value="This action represents the creation of the eICR. It subsequently calls validate."/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2551. PlanDefinition.action:createEicr.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 might not be capable of interpreting it dynamically.

ShortStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2553. PlanDefinition.action:createEicr.priority
Definition

Indicates how quickly the action should be addressed with respect to other actions.

Shortroutine | urgent | asap | stat
Control0..1
BindingThe codes SHALL be taken from RequestPriority
(required to http://hl7.org/fhir/ValueSet/request-priority|4.0.1)

Identifies the level of importance to be assigned to actioning the request.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2555. PlanDefinition.action:createEicr.code
Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control0..1
BindingUnless not suitable, these codes SHALL be taken from US Public Health ValueSet - PlanDefinition Action
(extensible to http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-plandefinition-action)

The set of actions that can be used to create plan definition

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "create-report"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="create-report"/>
  </coding>
</code>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2557. PlanDefinition.action:createEicr.reason
Definition

A description of why this action is necessary or appropriate.

ShortWhy the action should be performed
Comments

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

Control0..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2559. PlanDefinition.action:createEicr.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.

ShortSupporting documentation for the intended performer of the action
Control0..*
TypeRelatedArtifact
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2561. PlanDefinition.action:createEicr.goalId
Definition

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

ShortWhat goals this action supports
Control0..*
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2563. PlanDefinition.action:createEicr.subject[x]
Definition

A code or group definition that describes the intended subject of the action and its children, if any.

ShortType of individual the action is focused on
Comments

The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified.

In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType
(extensible to http://hl7.org/fhir/ValueSet/subject-type)

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

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Requirements

Multiple steps in a protocol often have different groups of steps that are focused on testing different things. The subject of an action specifies the focus of the action and any child actions.

Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2565. PlanDefinition.action:createEicr.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2567. PlanDefinition.action:createEicr.trigger.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2569. PlanDefinition.action:createEicr.trigger.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control1..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.trigger.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
2571. PlanDefinition.action:createEicr.trigger.extension:namedEventType
Slice NamenamedEventType
Definition

Indicates the types of named events to subscribe to from the EHR.

ShortUS Public Health Named Event Type Extension
Control1..1
TypeExtension(US Public Health Named Event Type Extension) (Extension Type: CodeableConcept)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2573. PlanDefinition.action:createEicr.trigger.type
Definition

The type of triggering event.

Shortnamed-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Control1..1
BindingThe codes SHALL be taken from TriggerType
(required to http://hl7.org/fhir/ValueSet/trigger-type|4.0.1)

The type of trigger.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Value
{
  "type" : "named-event"
}
<type value="named-event"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2575. PlanDefinition.action:createEicr.trigger.name
Definition

A formal name for the event. This may be an absolute URI that identifies the event formally (e.g. from a trigger registry), or a simple relative URI that identifies the event in a local context.

ShortName or URI that identifies the event
Comments

An event name can be provided for all event types, but is required for named events. If a name is provided for a type other than named events, it is considered to be a shorthand for the semantics described by the formal description of the event.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2577. PlanDefinition.action:createEicr.trigger.timing[x]
Definition

The timing of the event (if this is a periodic trigger).

ShortTiming of the event
Control0..1
TypeChoice of: Timing, Reference(Schedule), date, dateTime
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2579. PlanDefinition.action:createEicr.trigger.data
Definition

The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.

ShortTriggering data of the event (multiple = 'and')
Comments

This element shall be present for any data type trigger.

Control0..*
TypeDataRequirement
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2581. PlanDefinition.action:createEicr.trigger.condition
Definition

A boolean-valued expression that is evaluated in the context of the container of the trigger definition and returns whether or not the trigger fires.

ShortWhether the event triggers (boolean expression)
Comments

This element can be only be specified for data type triggers and provides additional semantics for the trigger. The context available within the condition is based on the type of data event. For all events, the current resource will be available as context. In addition, for modification events, the previous resource will also be available. The expression may be inlined, or may be a simple absolute URI, which is a reference to a named expression within a logic library referenced by a library element or extension within the containing resource. If the expression is a FHIR Path expression, it evaluates in the context of a resource of one of the type identified in the data requirement, and may also refer to the variable %previous for delta comparisons on events of type data-changed, data-modified, and data-deleted which will always have the same type.

Control0..1
TypeExpression
Is Modifierfalse
Summarytrue
Requirements

Need to be able to formally describe the triggering criteria.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2583. PlanDefinition.action:createEicr.condition
Definition

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

ShortWhether or not the action is applicable
Comments

When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2585. PlanDefinition.action:createEicr.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2587. PlanDefinition.action:createEicr.condition.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2589. PlanDefinition.action:createEicr.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2591. PlanDefinition.action:createEicr.condition.kind
Definition

The kind of condition.

Shortapplicability | start | stop
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 enter/exit criteria for an action.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKind
(required to http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1)

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2593. PlanDefinition.action:createEicr.condition.expression
Definition

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

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2595. PlanDefinition.action:createEicr.input
Definition

Defines input data requirements for the action.

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2597. PlanDefinition.action:createEicr.input.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2599. PlanDefinition.action:createEicr.input.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
2601. PlanDefinition.action:createEicr.input.extension:fhirquerypattern
Slice Namefhirquerypattern
Definition

A FHIR Query URL pattern that corresponds to the data specified by the data requirement. If multiple FHIR Query URLs are present, they each contribute to the data specified by the data requirement (i.e. the union of the results of the FHIR Queries represents the complete data for the data requirement). This is not a resolveable URL, in that it will contain 1) No base canonical (i.e. it's a relative query), and 2) Parameters using tokens that are delimited using double-braces and the context parameters are dependent solely on the subjectType, according to the following: Patient: context.patientId, Practitioner: context.practitionerId, Organization: context.organizationId, Location: context.locationId, Device: context.deviceId. For example, for a Library with a subjectType of Patient, the context parameter {{context.patientId}} will be used as a token to be replaced with the id of the Patient in context. This extension is used primarily to address the use case for satisfying a data requirement for a single subject. However, the query pattern could also be used to satisfy population level requests by removing the subject-level filter from the query.

ShortWhat FHIR query?
Comments

Supports communicating a FHIR query (or set of queries) for the given data requirement. The query is server-specific, and will need to be created as informed by a CapabilityStatement. The $data-requirements operation should be expected to be able to provide an Endpoint or CapabilityStatement to provide this information.; If no endpoint or capability statement is provided, the capability statement of the server performing the operation is used.

Control0..1
TypeExtension(FHIR Query Pattern) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2603. PlanDefinition.action:createEicr.input.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypes
(required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2605. PlanDefinition.action:createEicr.input.profile
Definition

The profile of the required data, specified as the uri of the profile definition.

ShortThe profile of the required data
Control0..*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2607. PlanDefinition.action:createEicr.input.subject[x]
Definition

The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.

ShortE.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments

The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType
(extensible to http://hl7.org/fhir/ValueSet/subject-type|4.0.1)

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

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summarytrue
Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2609. PlanDefinition.action:createEicr.input.mustSupport
Definition

Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available.

The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).

ShortIndicates specific structure elements that are referenced by the knowledge module
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2611. PlanDefinition.action:createEicr.input.codeFilter
Definition

Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.

ShortWhat codes are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-1: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2613. PlanDefinition.action:createEicr.input.codeFilter.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2615. PlanDefinition.action:createEicr.input.codeFilter.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.codeFilter.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
2617. PlanDefinition.action:createEicr.input.codeFilter.path
Definition

The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.

ShortA code-valued attribute to filter on
Comments

The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2619. PlanDefinition.action:createEicr.input.codeFilter.searchParam
Definition

A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.

ShortA coded (token) parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2621. PlanDefinition.action:createEicr.input.codeFilter.valueSet
Definition

The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.

ShortValueset for the filter
Control0..1
Typecanonical(ValueSet)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2623. PlanDefinition.action:createEicr.input.codeFilter.code
Definition

The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.

ShortWhat code is expected
Control0..*
TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2625. PlanDefinition.action:createEicr.input.dateFilter
Definition

Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.

ShortWhat dates/date ranges are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-2: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2627. PlanDefinition.action:createEicr.input.dateFilter.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2629. PlanDefinition.action:createEicr.input.dateFilter.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.dateFilter.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
2631. PlanDefinition.action:createEicr.input.dateFilter.path
Definition

The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.

ShortA date-valued attribute to filter on
Comments

The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2633. PlanDefinition.action:createEicr.input.dateFilter.searchParam
Definition

A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.

ShortA date valued parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2635. PlanDefinition.action:createEicr.input.dateFilter.value[x]
Definition

The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.

ShortThe value of the filter, as a Period, DateTime, or Duration value
Control0..1
TypeChoice of: dateTime, Period, Duration
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2637. PlanDefinition.action:createEicr.input.limit
Definition

Specifies a maximum number of results that are required (uses the _count search parameter).

ShortNumber of results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".

Control0..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2639. PlanDefinition.action:createEicr.input.sort
Definition

Specifies the order of the results to be returned.

ShortOrder of the results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.

Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2641. PlanDefinition.action:createEicr.input.sort.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2643. PlanDefinition.action:createEicr.input.sort.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.sort.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
2645. PlanDefinition.action:createEicr.input.sort.path
Definition

The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.

ShortThe name of the attribute to perform the sort
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2647. PlanDefinition.action:createEicr.input.sort.direction
Definition

The direction of the sort, ascending or descending.

Shortascending | descending
Control1..1
BindingThe codes SHALL be taken from SortDirection
(required to http://hl7.org/fhir/ValueSet/sort-direction|4.0.1)

The possible sort directions, ascending or descending.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2649. PlanDefinition.action:createEicr.output
Definition

Defines the output of the action, the created eICR. The output is consumed as the input of the next action in the sequence.

ShortThe eICR document bundle produced by this action.
Control1..1
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2651. PlanDefinition.action:createEicr.output.id
Definition

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

ShortUnique id for inter-element referencing
Control1..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2653. PlanDefinition.action:createEicr.output.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
2655. PlanDefinition.action:createEicr.output.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypes
(required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Value
{
  "type" : "Bundle"
}
<type value="Bundle"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2657. PlanDefinition.action:createEicr.output.profile
Definition

The profile of the required data, specified as the uri of the profile definition.

ShortThe profile of the required data
Control1..1
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Value
{
  "profile" : "http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle"
}
<profile value="http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2659. PlanDefinition.action:createEicr.output.subject[x]
Definition

The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.

ShortE.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments

The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType
(extensible to http://hl7.org/fhir/ValueSet/subject-type|4.0.1)

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

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summarytrue
Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2661. PlanDefinition.action:createEicr.output.mustSupport
Definition

Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available.

The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).

ShortIndicates specific structure elements that are referenced by the knowledge module
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2663. PlanDefinition.action:createEicr.output.codeFilter
Definition

Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.

ShortWhat codes are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-1: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2665. PlanDefinition.action:createEicr.output.codeFilter.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2667. PlanDefinition.action:createEicr.output.codeFilter.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.codeFilter.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
2669. PlanDefinition.action:createEicr.output.codeFilter.path
Definition

The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.

ShortA code-valued attribute to filter on
Comments

The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2671. PlanDefinition.action:createEicr.output.codeFilter.searchParam
Definition

A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.

ShortA coded (token) parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2673. PlanDefinition.action:createEicr.output.codeFilter.valueSet
Definition

The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.

ShortValueset for the filter
Control0..1
Typecanonical(ValueSet)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2675. PlanDefinition.action:createEicr.output.codeFilter.code
Definition

The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.

ShortWhat code is expected
Control0..*
TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2677. PlanDefinition.action:createEicr.output.dateFilter
Definition

Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.

ShortWhat dates/date ranges are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-2: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2679. PlanDefinition.action:createEicr.output.dateFilter.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2681. PlanDefinition.action:createEicr.output.dateFilter.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.dateFilter.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
2683. PlanDefinition.action:createEicr.output.dateFilter.path
Definition

The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.

ShortA date-valued attribute to filter on
Comments

The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2685. PlanDefinition.action:createEicr.output.dateFilter.searchParam
Definition

A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.

ShortA date valued parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2687. PlanDefinition.action:createEicr.output.dateFilter.value[x]
Definition

The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.

ShortThe value of the filter, as a Period, DateTime, or Duration value
Control0..1
TypeChoice of: dateTime, Period, Duration
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2689. PlanDefinition.action:createEicr.output.limit
Definition

Specifies a maximum number of results that are required (uses the _count search parameter).

ShortNumber of results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".

Control0..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2691. PlanDefinition.action:createEicr.output.sort
Definition

Specifies the order of the results to be returned.

ShortOrder of the results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.

Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2693. PlanDefinition.action:createEicr.output.sort.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2695. PlanDefinition.action:createEicr.output.sort.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.sort.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
2697. PlanDefinition.action:createEicr.output.sort.path
Definition

The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.

ShortThe name of the attribute to perform the sort
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2699. PlanDefinition.action:createEicr.output.sort.direction
Definition

The direction of the sort, ascending or descending.

Shortascending | descending
Control1..1
BindingThe codes SHALL be taken from SortDirection
(required to http://hl7.org/fhir/ValueSet/sort-direction|4.0.1)

The possible sort directions, ascending or descending.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2701. PlanDefinition.action:createEicr.relatedAction
Definition

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

ShortRelationship to another action
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.

Control1..1
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2703. PlanDefinition.action:createEicr.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2705. PlanDefinition.action:createEicr.relatedAction.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2707. PlanDefinition.action:createEicr.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2709. PlanDefinition.action:createEicr.relatedAction.actionId
Definition

The element id of the related action.

ShortWhat action is this related to
Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Value
{
  "actionId" : "validate-eicr"
}
<actionId value="validate-eicr"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2711. PlanDefinition.action:createEicr.relatedAction.relationship
Definition

The relationship of this action to the related action.

Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control1..1
BindingThe codes SHALL be taken from ActionRelationshipType
(required to http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1)

Defines the types of relationships between actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Value
{
  "relationship" : "before-start"
}
<relationship value="before-start"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2713. PlanDefinition.action:createEicr.relatedAction.offset[x]
Definition

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

ShortTime offset for the relationship
Control0..1
TypeChoice of: Duration, Range
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action.relatedAction.offset[x]. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this
2715. PlanDefinition.action:createEicr.relatedAction.offset[x]:offsetDuration
Slice NameoffsetDuration
Definition

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

ShortTime offset for the relationship
Control0..1
TypeDuration
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2717. PlanDefinition.action:createEicr.timing[x]
Definition

An optional value describing when the action should be performed.

ShortWhen the action should take place
Control0..1
TypeDuration
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2719. PlanDefinition.action:createEicr.participant
Definition

Indicates who should participate in performing the action described.

ShortWho should participate in the action
Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2721. PlanDefinition.action:createEicr.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2723. PlanDefinition.action:createEicr.participant.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2725. PlanDefinition.action:createEicr.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2727. PlanDefinition.action:createEicr.participant.type
Definition

The type of participant in the action.

Shortpatient | practitioner | related-person | device
Control1..1
BindingThe codes SHALL be taken from ActionParticipantType
(required to http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1)

The type of participant for the action.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2729. PlanDefinition.action:createEicr.participant.role
Definition

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

ShortE.g. Nurse, Surgeon, Parent
Control0..1
BindingFor example codes, see ActionParticipantRole
(example to http://hl7.org/fhir/ValueSet/action-participant-role)

Defines roles played by participants for the action.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2731. PlanDefinition.action:createEicr.type
Definition

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

Shortcreate | update | remove | fire-event
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ActionType
(extensible to http://hl7.org/fhir/ValueSet/action-type)

The type of action to be performed.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2733. PlanDefinition.action:createEicr.groupingBehavior
Definition

Defines the grouping behavior for the action and its children.

Shortvisual-group | logical-group | sentence-group
Control0..1
BindingThe codes SHALL be taken from ActionGroupingBehavior
(required to http://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.1)

Defines organization behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2735. PlanDefinition.action:createEicr.selectionBehavior
Definition

Defines the selection behavior for the action and its children.

Shortany | all | all-or-none | exactly-one | at-most-one | one-or-more
Control0..1
BindingThe codes SHALL be taken from ActionSelectionBehavior
(required to http://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.1)

Defines selection behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2737. PlanDefinition.action:createEicr.requiredBehavior
Definition

Defines the required behavior for the action.

Shortmust | could | must-unless-documented
Control0..1
BindingThe codes SHALL be taken from ActionRequiredBehavior
(required to http://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1)

Defines expectations around whether an action or action group is required.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2739. PlanDefinition.action:createEicr.precheckBehavior
Definition

Defines whether the action should usually be preselected.

Shortyes | no
Control0..1
BindingThe codes SHALL be taken from ActionPrecheckBehavior
(required to http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1)

Defines selection frequency behavior for an action or group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2741. PlanDefinition.action:createEicr.cardinalityBehavior
Definition

Defines whether the action can be selected multiple times.

Shortsingle | multiple
Control0..1
BindingThe codes SHALL be taken from ActionCardinalityBehavior
(required to http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1)

Defines behavior for an action or a group for how many times that item may be repeated.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2743. PlanDefinition.action:createEicr.definition[x]
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.

ShortDescription of the activity to be performed
Comments

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

Control0..1
TypeChoice of: canonical(ActivityDefinition, PlanDefinition, Questionnaire), uri
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2745. PlanDefinition.action:createEicr.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.

ShortTransform to apply the template
Comments

Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..1
Typecanonical(StructureMap)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2747. PlanDefinition.action:createEicr.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.

ShortDynamic aspects of the definition
Comments

Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2749. PlanDefinition.action:createEicr.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2751. PlanDefinition.action:createEicr.dynamicValue.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2753. PlanDefinition.action:createEicr.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2755. PlanDefinition.action:createEicr.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. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details).

ShortThe path to the element to be set dynamically
Comments

To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2757. PlanDefinition.action:createEicr.dynamicValue.expression
Definition

An expression specifying the value of the customized element.

ShortAn expression that provides the dynamic value for the customization
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2759. PlanDefinition.action:createEicr.action
Definition

Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.

ShortA sub-action
Control0..*
TypeSeettp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2761. PlanDefinition.action:validateEicr
Slice NamevalidateEicr
Definition

Defines the "validate-eicr" action

ShortValidate the eICR
Comments

Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.

Control1..1
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2763. PlanDefinition.action:validateEicr.id
Definition

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

ShortUnique id for inter-element referencing
Control1..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "id" : "validate-eicr"
}
<id value="validate-eicr"/>
2765. PlanDefinition.action:validateEicr.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2767. PlanDefinition.action:validateEicr.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2769. PlanDefinition.action:validateEicr.prefix
Definition

A user-visible prefix for the action.

ShortUser-visible prefix for the action (e.g. 1. or A.)
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2771. PlanDefinition.action:validateEicr.title
Definition

The title of the action displayed to a user.

ShortUser-visible title
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2773. PlanDefinition.action:validateEicr.description
Definition

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

ShortBrief description of the action
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Value
{
  "description" : "This action represents the validation of the eICR. It subsequently calls route-and-send."
}
<description value="This action represents the validation of the eICR. It subsequently calls route-and-send."/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2775. PlanDefinition.action:validateEicr.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 might not be capable of interpreting it dynamically.

ShortStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2777. PlanDefinition.action:validateEicr.priority
Definition

Indicates how quickly the action should be addressed with respect to other actions.

Shortroutine | urgent | asap | stat
Control0..1
BindingThe codes SHALL be taken from RequestPriority
(required to http://hl7.org/fhir/ValueSet/request-priority|4.0.1)

Identifies the level of importance to be assigned to actioning the request.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2779. PlanDefinition.action:validateEicr.code
Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control0..1
BindingUnless not suitable, these codes SHALL be taken from US Public Health ValueSet - PlanDefinition Action
(extensible to http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-plandefinition-action)

The set of actions that can be used to create plan definition

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "validate-report"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="validate-report"/>
  </coding>
</code>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2781. PlanDefinition.action:validateEicr.reason
Definition

A description of why this action is necessary or appropriate.

ShortWhy the action should be performed
Comments

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

Control0..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2783. PlanDefinition.action:validateEicr.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.

ShortSupporting documentation for the intended performer of the action
Control0..*
TypeRelatedArtifact
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2785. PlanDefinition.action:validateEicr.goalId
Definition

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

ShortWhat goals this action supports
Control0..*
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2787. PlanDefinition.action:validateEicr.subject[x]
Definition

A code or group definition that describes the intended subject of the action and its children, if any.

ShortType of individual the action is focused on
Comments

The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified.

In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType
(extensible to http://hl7.org/fhir/ValueSet/subject-type)

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

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Requirements

Multiple steps in a protocol often have different groups of steps that are focused on testing different things. The subject of an action specifies the focus of the action and any child actions.

Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2789. PlanDefinition.action:validateEicr.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2791. PlanDefinition.action:validateEicr.trigger.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2793. PlanDefinition.action:validateEicr.trigger.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control1..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.trigger.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
2795. PlanDefinition.action:validateEicr.trigger.extension:namedEventType
Slice NamenamedEventType
Definition

Indicates the types of named events to subscribe to from the EHR.

ShortUS Public Health Named Event Type Extension
Control1..1
TypeExtension(US Public Health Named Event Type Extension) (Extension Type: CodeableConcept)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2797. PlanDefinition.action:validateEicr.trigger.type
Definition

The type of triggering event.

Shortnamed-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Control1..1
BindingThe codes SHALL be taken from TriggerType
(required to http://hl7.org/fhir/ValueSet/trigger-type|4.0.1)

The type of trigger.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Value
{
  "type" : "named-event"
}
<type value="named-event"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2799. PlanDefinition.action:validateEicr.trigger.name
Definition

A formal name for the event. This may be an absolute URI that identifies the event formally (e.g. from a trigger registry), or a simple relative URI that identifies the event in a local context.

ShortName or URI that identifies the event
Comments

An event name can be provided for all event types, but is required for named events. If a name is provided for a type other than named events, it is considered to be a shorthand for the semantics described by the formal description of the event.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2801. PlanDefinition.action:validateEicr.trigger.timing[x]
Definition

The timing of the event (if this is a periodic trigger).

ShortTiming of the event
Control0..1
TypeChoice of: Timing, Reference(Schedule), date, dateTime
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2803. PlanDefinition.action:validateEicr.trigger.data
Definition

The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.

ShortTriggering data of the event (multiple = 'and')
Comments

This element shall be present for any data type trigger.

Control0..*
TypeDataRequirement
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2805. PlanDefinition.action:validateEicr.trigger.condition
Definition

A boolean-valued expression that is evaluated in the context of the container of the trigger definition and returns whether or not the trigger fires.

ShortWhether the event triggers (boolean expression)
Comments

This element can be only be specified for data type triggers and provides additional semantics for the trigger. The context available within the condition is based on the type of data event. For all events, the current resource will be available as context. In addition, for modification events, the previous resource will also be available. The expression may be inlined, or may be a simple absolute URI, which is a reference to a named expression within a logic library referenced by a library element or extension within the containing resource. If the expression is a FHIR Path expression, it evaluates in the context of a resource of one of the type identified in the data requirement, and may also refer to the variable %previous for delta comparisons on events of type data-changed, data-modified, and data-deleted which will always have the same type.

Control0..1
TypeExpression
Is Modifierfalse
Summarytrue
Requirements

Need to be able to formally describe the triggering criteria.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2807. PlanDefinition.action:validateEicr.condition
Definition

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

ShortWhether or not the action is applicable
Comments

When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2809. PlanDefinition.action:validateEicr.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2811. PlanDefinition.action:validateEicr.condition.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2813. PlanDefinition.action:validateEicr.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2815. PlanDefinition.action:validateEicr.condition.kind
Definition

The kind of condition.

Shortapplicability | start | stop
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 enter/exit criteria for an action.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKind
(required to http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1)

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2817. PlanDefinition.action:validateEicr.condition.expression
Definition

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

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2819. PlanDefinition.action:validateEicr.input
Definition

Defines input data requirements for the action.

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2821. PlanDefinition.action:validateEicr.input.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2823. PlanDefinition.action:validateEicr.input.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
2825. PlanDefinition.action:validateEicr.input.extension:fhirquerypattern
Slice Namefhirquerypattern
Definition

A FHIR Query URL pattern that corresponds to the data specified by the data requirement. If multiple FHIR Query URLs are present, they each contribute to the data specified by the data requirement (i.e. the union of the results of the FHIR Queries represents the complete data for the data requirement). This is not a resolveable URL, in that it will contain 1) No base canonical (i.e. it's a relative query), and 2) Parameters using tokens that are delimited using double-braces and the context parameters are dependent solely on the subjectType, according to the following: Patient: context.patientId, Practitioner: context.practitionerId, Organization: context.organizationId, Location: context.locationId, Device: context.deviceId. For example, for a Library with a subjectType of Patient, the context parameter {{context.patientId}} will be used as a token to be replaced with the id of the Patient in context. This extension is used primarily to address the use case for satisfying a data requirement for a single subject. However, the query pattern could also be used to satisfy population level requests by removing the subject-level filter from the query.

ShortWhat FHIR query?
Comments

Supports communicating a FHIR query (or set of queries) for the given data requirement. The query is server-specific, and will need to be created as informed by a CapabilityStatement. The $data-requirements operation should be expected to be able to provide an Endpoint or CapabilityStatement to provide this information.; If no endpoint or capability statement is provided, the capability statement of the server performing the operation is used.

Control0..1
TypeExtension(FHIR Query Pattern) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2827. PlanDefinition.action:validateEicr.input.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypes
(required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2829. PlanDefinition.action:validateEicr.input.profile
Definition

The profile of the required data, specified as the uri of the profile definition.

ShortThe profile of the required data
Control0..*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2831. PlanDefinition.action:validateEicr.input.subject[x]
Definition

The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.

ShortE.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments

The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType
(extensible to http://hl7.org/fhir/ValueSet/subject-type|4.0.1)

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

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summarytrue
Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2833. PlanDefinition.action:validateEicr.input.mustSupport
Definition

Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available.

The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).

ShortIndicates specific structure elements that are referenced by the knowledge module
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2835. PlanDefinition.action:validateEicr.input.codeFilter
Definition

Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.

ShortWhat codes are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-1: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2837. PlanDefinition.action:validateEicr.input.codeFilter.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2839. PlanDefinition.action:validateEicr.input.codeFilter.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.codeFilter.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
2841. PlanDefinition.action:validateEicr.input.codeFilter.path
Definition

The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.

ShortA code-valued attribute to filter on
Comments

The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2843. PlanDefinition.action:validateEicr.input.codeFilter.searchParam
Definition

A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.

ShortA coded (token) parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2845. PlanDefinition.action:validateEicr.input.codeFilter.valueSet
Definition

The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.

ShortValueset for the filter
Control0..1
Typecanonical(ValueSet)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2847. PlanDefinition.action:validateEicr.input.codeFilter.code
Definition

The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.

ShortWhat code is expected
Control0..*
TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2849. PlanDefinition.action:validateEicr.input.dateFilter
Definition

Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.

ShortWhat dates/date ranges are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-2: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2851. PlanDefinition.action:validateEicr.input.dateFilter.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2853. PlanDefinition.action:validateEicr.input.dateFilter.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.dateFilter.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
2855. PlanDefinition.action:validateEicr.input.dateFilter.path
Definition

The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.

ShortA date-valued attribute to filter on
Comments

The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2857. PlanDefinition.action:validateEicr.input.dateFilter.searchParam
Definition

A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.

ShortA date valued parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2859. PlanDefinition.action:validateEicr.input.dateFilter.value[x]
Definition

The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.

ShortThe value of the filter, as a Period, DateTime, or Duration value
Control0..1
TypeChoice of: dateTime, Period, Duration
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2861. PlanDefinition.action:validateEicr.input.limit
Definition

Specifies a maximum number of results that are required (uses the _count search parameter).

ShortNumber of results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".

Control0..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2863. PlanDefinition.action:validateEicr.input.sort
Definition

Specifies the order of the results to be returned.

ShortOrder of the results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.

Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2865. PlanDefinition.action:validateEicr.input.sort.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2867. PlanDefinition.action:validateEicr.input.sort.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.sort.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
2869. PlanDefinition.action:validateEicr.input.sort.path
Definition

The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.

ShortThe name of the attribute to perform the sort
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2871. PlanDefinition.action:validateEicr.input.sort.direction
Definition

The direction of the sort, ascending or descending.

Shortascending | descending
Control1..1
BindingThe codes SHALL be taken from SortDirection
(required to http://hl7.org/fhir/ValueSet/sort-direction|4.0.1)

The possible sort directions, ascending or descending.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2873. PlanDefinition.action:validateEicr.output
Definition

Defines the output of the action, the validated eICR. The output is consumed as the input of the next action in the sequence.

ShortThe eICR document bundle produced by this action.
Control1..1
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2875. PlanDefinition.action:validateEicr.output.id
Definition

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

ShortUnique id for inter-element referencing
Control1..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2877. PlanDefinition.action:validateEicr.output.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
2879. PlanDefinition.action:validateEicr.output.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypes
(required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Value
{
  "type" : "Bundle"
}
<type value="Bundle"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2881. PlanDefinition.action:validateEicr.output.profile
Definition

The profile of the required data, specified as the uri of the profile definition.

ShortThe profile of the required data
Control1..1
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Value
{
  "profile" : "http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle"
}
<profile value="http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2883. PlanDefinition.action:validateEicr.output.subject[x]
Definition

The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.

ShortE.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments

The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType
(extensible to http://hl7.org/fhir/ValueSet/subject-type|4.0.1)

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

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summarytrue
Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2885. PlanDefinition.action:validateEicr.output.mustSupport
Definition

Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available.

The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).

ShortIndicates specific structure elements that are referenced by the knowledge module
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2887. PlanDefinition.action:validateEicr.output.codeFilter
Definition

Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.

ShortWhat codes are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-1: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2889. PlanDefinition.action:validateEicr.output.codeFilter.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2891. PlanDefinition.action:validateEicr.output.codeFilter.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.codeFilter.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
2893. PlanDefinition.action:validateEicr.output.codeFilter.path
Definition

The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.

ShortA code-valued attribute to filter on
Comments

The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2895. PlanDefinition.action:validateEicr.output.codeFilter.searchParam
Definition

A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.

ShortA coded (token) parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2897. PlanDefinition.action:validateEicr.output.codeFilter.valueSet
Definition

The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.

ShortValueset for the filter
Control0..1
Typecanonical(ValueSet)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2899. PlanDefinition.action:validateEicr.output.codeFilter.code
Definition

The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.

ShortWhat code is expected
Control0..*
TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2901. PlanDefinition.action:validateEicr.output.dateFilter
Definition

Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.

ShortWhat dates/date ranges are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-2: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2903. PlanDefinition.action:validateEicr.output.dateFilter.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2905. PlanDefinition.action:validateEicr.output.dateFilter.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.dateFilter.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
2907. PlanDefinition.action:validateEicr.output.dateFilter.path
Definition

The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.

ShortA date-valued attribute to filter on
Comments

The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2909. PlanDefinition.action:validateEicr.output.dateFilter.searchParam
Definition

A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.

ShortA date valued parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2911. PlanDefinition.action:validateEicr.output.dateFilter.value[x]
Definition

The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.

ShortThe value of the filter, as a Period, DateTime, or Duration value
Control0..1
TypeChoice of: dateTime, Period, Duration
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2913. PlanDefinition.action:validateEicr.output.limit
Definition

Specifies a maximum number of results that are required (uses the _count search parameter).

ShortNumber of results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".

Control0..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2915. PlanDefinition.action:validateEicr.output.sort
Definition

Specifies the order of the results to be returned.

ShortOrder of the results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.

Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2917. PlanDefinition.action:validateEicr.output.sort.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2919. PlanDefinition.action:validateEicr.output.sort.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.sort.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
2921. PlanDefinition.action:validateEicr.output.sort.path
Definition

The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.

ShortThe name of the attribute to perform the sort
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2923. PlanDefinition.action:validateEicr.output.sort.direction
Definition

The direction of the sort, ascending or descending.

Shortascending | descending
Control1..1
BindingThe codes SHALL be taken from SortDirection
(required to http://hl7.org/fhir/ValueSet/sort-direction|4.0.1)

The possible sort directions, ascending or descending.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2925. PlanDefinition.action:validateEicr.relatedAction
Definition

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

ShortRelationship to another action
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.

Control1..1
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2927. PlanDefinition.action:validateEicr.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2929. PlanDefinition.action:validateEicr.relatedAction.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2931. PlanDefinition.action:validateEicr.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2933. PlanDefinition.action:validateEicr.relatedAction.actionId
Definition

The element id of the related action.

ShortWhat action is this related to
Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Value
{
  "actionId" : "route-and-send-eicr"
}
<actionId value="route-and-send-eicr"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2935. PlanDefinition.action:validateEicr.relatedAction.relationship
Definition

The relationship of this action to the related action.

Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control1..1
BindingThe codes SHALL be taken from ActionRelationshipType
(required to http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1)

Defines the types of relationships between actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Value
{
  "relationship" : "before-start"
}
<relationship value="before-start"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2937. PlanDefinition.action:validateEicr.relatedAction.offset[x]
Definition

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

ShortTime offset for the relationship
Control0..1
TypeChoice of: Duration, Range
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action.relatedAction.offset[x]. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this
2939. PlanDefinition.action:validateEicr.relatedAction.offset[x]:offsetDuration
Slice NameoffsetDuration
Definition

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

ShortTime offset for the relationship
Control0..1
TypeDuration
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2941. PlanDefinition.action:validateEicr.timing[x]
Definition

An optional value describing when the action should be performed.

ShortWhen the action should take place
Control0..1
TypeDuration
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2943. PlanDefinition.action:validateEicr.participant
Definition

Indicates who should participate in performing the action described.

ShortWho should participate in the action
Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2945. PlanDefinition.action:validateEicr.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2947. PlanDefinition.action:validateEicr.participant.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2949. PlanDefinition.action:validateEicr.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2951. PlanDefinition.action:validateEicr.participant.type
Definition

The type of participant in the action.

Shortpatient | practitioner | related-person | device
Control1..1
BindingThe codes SHALL be taken from ActionParticipantType
(required to http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1)

The type of participant for the action.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2953. PlanDefinition.action:validateEicr.participant.role
Definition

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

ShortE.g. Nurse, Surgeon, Parent
Control0..1
BindingFor example codes, see ActionParticipantRole
(example to http://hl7.org/fhir/ValueSet/action-participant-role)

Defines roles played by participants for the action.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2955. PlanDefinition.action:validateEicr.type
Definition

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

Shortcreate | update | remove | fire-event
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ActionType
(extensible to http://hl7.org/fhir/ValueSet/action-type)

The type of action to be performed.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2957. PlanDefinition.action:validateEicr.groupingBehavior
Definition

Defines the grouping behavior for the action and its children.

Shortvisual-group | logical-group | sentence-group
Control0..1
BindingThe codes SHALL be taken from ActionGroupingBehavior
(required to http://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.1)

Defines organization behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2959. PlanDefinition.action:validateEicr.selectionBehavior
Definition

Defines the selection behavior for the action and its children.

Shortany | all | all-or-none | exactly-one | at-most-one | one-or-more
Control0..1
BindingThe codes SHALL be taken from ActionSelectionBehavior
(required to http://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.1)

Defines selection behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2961. PlanDefinition.action:validateEicr.requiredBehavior
Definition

Defines the required behavior for the action.

Shortmust | could | must-unless-documented
Control0..1
BindingThe codes SHALL be taken from ActionRequiredBehavior
(required to http://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1)

Defines expectations around whether an action or action group is required.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2963. PlanDefinition.action:validateEicr.precheckBehavior
Definition

Defines whether the action should usually be preselected.

Shortyes | no
Control0..1
BindingThe codes SHALL be taken from ActionPrecheckBehavior
(required to http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1)

Defines selection frequency behavior for an action or group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2965. PlanDefinition.action:validateEicr.cardinalityBehavior
Definition

Defines whether the action can be selected multiple times.

Shortsingle | multiple
Control0..1
BindingThe codes SHALL be taken from ActionCardinalityBehavior
(required to http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1)

Defines behavior for an action or a group for how many times that item may be repeated.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2967. PlanDefinition.action:validateEicr.definition[x]
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.

ShortDescription of the activity to be performed
Comments

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

Control0..1
TypeChoice of: canonical(ActivityDefinition, PlanDefinition, Questionnaire), uri
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2969. PlanDefinition.action:validateEicr.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.

ShortTransform to apply the template
Comments

Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..1
Typecanonical(StructureMap)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2971. PlanDefinition.action:validateEicr.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.

ShortDynamic aspects of the definition
Comments

Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2973. PlanDefinition.action:validateEicr.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
2975. PlanDefinition.action:validateEicr.dynamicValue.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2977. PlanDefinition.action:validateEicr.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2979. PlanDefinition.action:validateEicr.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. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details).

ShortThe path to the element to be set dynamically
Comments

To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2981. PlanDefinition.action:validateEicr.dynamicValue.expression
Definition

An expression specifying the value of the customized element.

ShortAn expression that provides the dynamic value for the customization
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2983. PlanDefinition.action:validateEicr.action
Definition

Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.

ShortA sub-action
Control0..*
TypeSeettp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2985. PlanDefinition.action:routeAndSendEicr
Slice NamerouteAndSendEicr
Definition

Defines the routing and sending of the eICR.

ShortRoute and send eICR
Comments

Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.

Control1..1
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2987. PlanDefinition.action:routeAndSendEicr.id
Definition

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

ShortUnique id for inter-element referencing
Control1..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "id" : "route-and-send-eicr"
}
<id value="route-and-send-eicr"/>
2989. PlanDefinition.action:routeAndSendEicr.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2991. PlanDefinition.action:routeAndSendEicr.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2993. PlanDefinition.action:routeAndSendEicr.prefix
Definition

A user-visible prefix for the action.

ShortUser-visible prefix for the action (e.g. 1. or A.)
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2995. PlanDefinition.action:routeAndSendEicr.title
Definition

The title of the action displayed to a user.

ShortUser-visible title
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2997. PlanDefinition.action:routeAndSendEicr.description
Definition

Description of the route and send action.

ShortDescription of the route and send action.
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Value
{
  "description" : "This action represents the routing and sending of the eICR."
}
<description value="This action represents the routing and sending of the eICR."/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2999. PlanDefinition.action:routeAndSendEicr.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 might not be capable of interpreting it dynamically.

ShortStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Value
{
  "textEquivalent" : "Route and send eICR"
}
<textEquivalent value="Route and send eICR"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3001. PlanDefinition.action:routeAndSendEicr.priority
Definition

Indicates how quickly the action should be addressed with respect to other actions.

Shortroutine | urgent | asap | stat
Control0..1
BindingThe codes SHALL be taken from RequestPriority
(required to http://hl7.org/fhir/ValueSet/request-priority|4.0.1)

Identifies the level of importance to be assigned to actioning the request.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3003. PlanDefinition.action:routeAndSendEicr.code
Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control0..1
BindingUnless not suitable, these codes SHALL be taken from US Public Health ValueSet - PlanDefinition Action
(extensible to http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-plandefinition-action)

The set of actions that can be used to create plan definition

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "submit-report"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="submit-report"/>
  </coding>
</code>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3005. PlanDefinition.action:routeAndSendEicr.reason
Definition

A description of why this action is necessary or appropriate.

ShortWhy the action should be performed
Comments

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

Control0..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3007. PlanDefinition.action:routeAndSendEicr.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.

ShortSupporting documentation for the intended performer of the action
Control0..*
TypeRelatedArtifact
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3009. PlanDefinition.action:routeAndSendEicr.goalId
Definition

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

ShortWhat goals this action supports
Control0..*
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3011. PlanDefinition.action:routeAndSendEicr.subject[x]
Definition

A code or group definition that describes the intended subject of the action and its children, if any.

ShortType of individual the action is focused on
Comments

The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified.

In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType
(extensible to http://hl7.org/fhir/ValueSet/subject-type)

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

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Requirements

Multiple steps in a protocol often have different groups of steps that are focused on testing different things. The subject of an action specifies the focus of the action and any child actions.

Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3013. PlanDefinition.action:routeAndSendEicr.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3015. PlanDefinition.action:routeAndSendEicr.trigger.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
3017. PlanDefinition.action:routeAndSendEicr.trigger.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control1..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.trigger.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
3019. PlanDefinition.action:routeAndSendEicr.trigger.extension:namedEventType
Slice NamenamedEventType
Definition

Indicates the types of named events to subscribe to from the EHR.

ShortUS Public Health Named Event Type Extension
Control1..1
TypeExtension(US Public Health Named Event Type Extension) (Extension Type: CodeableConcept)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
3021. PlanDefinition.action:routeAndSendEicr.trigger.type
Definition

The type of triggering event.

Shortnamed-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Control1..1
BindingThe codes SHALL be taken from TriggerType
(required to http://hl7.org/fhir/ValueSet/trigger-type|4.0.1)

The type of trigger.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Value
{
  "type" : "named-event"
}
<type value="named-event"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3023. PlanDefinition.action:routeAndSendEicr.trigger.name
Definition

A formal name for the event. This may be an absolute URI that identifies the event formally (e.g. from a trigger registry), or a simple relative URI that identifies the event in a local context.

ShortName or URI that identifies the event
Comments

An event name can be provided for all event types, but is required for named events. If a name is provided for a type other than named events, it is considered to be a shorthand for the semantics described by the formal description of the event.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3025. PlanDefinition.action:routeAndSendEicr.trigger.timing[x]
Definition

The timing of the event (if this is a periodic trigger).

ShortTiming of the event
Control0..1
TypeChoice of: Timing, Reference(Schedule), date, dateTime
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3027. PlanDefinition.action:routeAndSendEicr.trigger.data
Definition

The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.

ShortTriggering data of the event (multiple = 'and')
Comments

This element shall be present for any data type trigger.

Control0..*
TypeDataRequirement
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3029. PlanDefinition.action:routeAndSendEicr.trigger.condition
Definition

A boolean-valued expression that is evaluated in the context of the container of the trigger definition and returns whether or not the trigger fires.

ShortWhether the event triggers (boolean expression)
Comments

This element can be only be specified for data type triggers and provides additional semantics for the trigger. The context available within the condition is based on the type of data event. For all events, the current resource will be available as context. In addition, for modification events, the previous resource will also be available. The expression may be inlined, or may be a simple absolute URI, which is a reference to a named expression within a logic library referenced by a library element or extension within the containing resource. If the expression is a FHIR Path expression, it evaluates in the context of a resource of one of the type identified in the data requirement, and may also refer to the variable %previous for delta comparisons on events of type data-changed, data-modified, and data-deleted which will always have the same type.

Control0..1
TypeExpression
Is Modifierfalse
Summarytrue
Requirements

Need to be able to formally describe the triggering criteria.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3031. PlanDefinition.action:routeAndSendEicr.condition
Definition

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

ShortWhether or not the action is applicable
Comments

When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3033. PlanDefinition.action:routeAndSendEicr.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
3035. PlanDefinition.action:routeAndSendEicr.condition.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
3037. PlanDefinition.action:routeAndSendEicr.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
3039. PlanDefinition.action:routeAndSendEicr.condition.kind
Definition

The kind of condition.

Shortapplicability | start | stop
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 enter/exit criteria for an action.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKind
(required to http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1)

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3041. PlanDefinition.action:routeAndSendEicr.condition.expression
Definition

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

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3043. PlanDefinition.action:routeAndSendEicr.input
Definition

Defines input data requirements for the action.

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3045. PlanDefinition.action:routeAndSendEicr.input.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
3047. PlanDefinition.action:routeAndSendEicr.input.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
3049. PlanDefinition.action:routeAndSendEicr.input.extension:fhirquerypattern
Slice Namefhirquerypattern
Definition

A FHIR Query URL pattern that corresponds to the data specified by the data requirement. If multiple FHIR Query URLs are present, they each contribute to the data specified by the data requirement (i.e. the union of the results of the FHIR Queries represents the complete data for the data requirement). This is not a resolveable URL, in that it will contain 1) No base canonical (i.e. it's a relative query), and 2) Parameters using tokens that are delimited using double-braces and the context parameters are dependent solely on the subjectType, according to the following: Patient: context.patientId, Practitioner: context.practitionerId, Organization: context.organizationId, Location: context.locationId, Device: context.deviceId. For example, for a Library with a subjectType of Patient, the context parameter {{context.patientId}} will be used as a token to be replaced with the id of the Patient in context. This extension is used primarily to address the use case for satisfying a data requirement for a single subject. However, the query pattern could also be used to satisfy population level requests by removing the subject-level filter from the query.

ShortWhat FHIR query?
Comments

Supports communicating a FHIR query (or set of queries) for the given data requirement. The query is server-specific, and will need to be created as informed by a CapabilityStatement. The $data-requirements operation should be expected to be able to provide an Endpoint or CapabilityStatement to provide this information.; If no endpoint or capability statement is provided, the capability statement of the server performing the operation is used.

Control0..1
TypeExtension(FHIR Query Pattern) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
3051. PlanDefinition.action:routeAndSendEicr.input.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypes
(required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3053. PlanDefinition.action:routeAndSendEicr.input.profile
Definition

The profile of the required data, specified as the uri of the profile definition.

ShortThe profile of the required data
Control0..*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3055. PlanDefinition.action:routeAndSendEicr.input.subject[x]
Definition

The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.

ShortE.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments

The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType
(extensible to http://hl7.org/fhir/ValueSet/subject-type|4.0.1)

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

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summarytrue
Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3057. PlanDefinition.action:routeAndSendEicr.input.mustSupport
Definition

Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available.

The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).

ShortIndicates specific structure elements that are referenced by the knowledge module
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3059. PlanDefinition.action:routeAndSendEicr.input.codeFilter
Definition

Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.

ShortWhat codes are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-1: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3061. PlanDefinition.action:routeAndSendEicr.input.codeFilter.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
3063. PlanDefinition.action:routeAndSendEicr.input.codeFilter.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.codeFilter.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
3065. PlanDefinition.action:routeAndSendEicr.input.codeFilter.path
Definition

The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.

ShortA code-valued attribute to filter on
Comments

The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3067. PlanDefinition.action:routeAndSendEicr.input.codeFilter.searchParam
Definition

A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.

ShortA coded (token) parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3069. PlanDefinition.action:routeAndSendEicr.input.codeFilter.valueSet
Definition

The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.

ShortValueset for the filter
Control0..1
Typecanonical(ValueSet)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3071. PlanDefinition.action:routeAndSendEicr.input.codeFilter.code
Definition

The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.

ShortWhat code is expected
Control0..*
TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3073. PlanDefinition.action:routeAndSendEicr.input.dateFilter
Definition

Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.

ShortWhat dates/date ranges are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-2: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3075. PlanDefinition.action:routeAndSendEicr.input.dateFilter.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
3077. PlanDefinition.action:routeAndSendEicr.input.dateFilter.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.dateFilter.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
3079. PlanDefinition.action:routeAndSendEicr.input.dateFilter.path
Definition

The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.

ShortA date-valued attribute to filter on
Comments

The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3081. PlanDefinition.action:routeAndSendEicr.input.dateFilter.searchParam
Definition

A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.

ShortA date valued parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3083. PlanDefinition.action:routeAndSendEicr.input.dateFilter.value[x]
Definition

The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.

ShortThe value of the filter, as a Period, DateTime, or Duration value
Control0..1
TypeChoice of: dateTime, Period, Duration
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3085. PlanDefinition.action:routeAndSendEicr.input.limit
Definition

Specifies a maximum number of results that are required (uses the _count search parameter).

ShortNumber of results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".

Control0..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3087. PlanDefinition.action:routeAndSendEicr.input.sort
Definition

Specifies the order of the results to be returned.

ShortOrder of the results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.

Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3089. PlanDefinition.action:routeAndSendEicr.input.sort.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
3091. PlanDefinition.action:routeAndSendEicr.input.sort.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.sort.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
3093. PlanDefinition.action:routeAndSendEicr.input.sort.path
Definition

The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.

ShortThe name of the attribute to perform the sort
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3095. PlanDefinition.action:routeAndSendEicr.input.sort.direction
Definition

The direction of the sort, ascending or descending.

Shortascending | descending
Control1..1
BindingThe codes SHALL be taken from SortDirection
(required to http://hl7.org/fhir/ValueSet/sort-direction|4.0.1)

The possible sort directions, ascending or descending.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3097. PlanDefinition.action:routeAndSendEicr.output
Definition

Defines the output of the action, the submitted eICR. The output is consumed as the input of the next action in the sequence.

ShortThe eICR document bundle produced by this action.
Control1..1
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3099. PlanDefinition.action:routeAndSendEicr.output.id
Definition

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

ShortUnique id for inter-element referencing
Control1..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
3101. PlanDefinition.action:routeAndSendEicr.output.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
3103. PlanDefinition.action:routeAndSendEicr.output.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypes
(required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Value
{
  "type" : "Bundle"
}
<type value="Bundle"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3105. PlanDefinition.action:routeAndSendEicr.output.profile
Definition

The profile of the required data, specified as the uri of the profile definition.

ShortThe profile of the required data
Control1..1
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Value
{
  "profile" : "http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle"
}
<profile value="http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3107. PlanDefinition.action:routeAndSendEicr.output.subject[x]
Definition

The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.

ShortE.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments

The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType
(extensible to http://hl7.org/fhir/ValueSet/subject-type|4.0.1)

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

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summarytrue
Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3109. PlanDefinition.action:routeAndSendEicr.output.mustSupport
Definition

Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available.

The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).

ShortIndicates specific structure elements that are referenced by the knowledge module
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3111. PlanDefinition.action:routeAndSendEicr.output.codeFilter
Definition

Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.

ShortWhat codes are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-1: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3113. PlanDefinition.action:routeAndSendEicr.output.codeFilter.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
3115. PlanDefinition.action:routeAndSendEicr.output.codeFilter.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.codeFilter.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
3117. PlanDefinition.action:routeAndSendEicr.output.codeFilter.path
Definition

The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.

ShortA code-valued attribute to filter on
Comments

The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3119. PlanDefinition.action:routeAndSendEicr.output.codeFilter.searchParam
Definition

A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.

ShortA coded (token) parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3121. PlanDefinition.action:routeAndSendEicr.output.codeFilter.valueSet
Definition

The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.

ShortValueset for the filter
Control0..1
Typecanonical(ValueSet)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3123. PlanDefinition.action:routeAndSendEicr.output.codeFilter.code
Definition

The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.

ShortWhat code is expected
Control0..*
TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3125. PlanDefinition.action:routeAndSendEicr.output.dateFilter
Definition

Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.

ShortWhat dates/date ranges are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-2: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3127. PlanDefinition.action:routeAndSendEicr.output.dateFilter.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
3129. PlanDefinition.action:routeAndSendEicr.output.dateFilter.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.dateFilter.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
3131. PlanDefinition.action:routeAndSendEicr.output.dateFilter.path
Definition

The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.

ShortA date-valued attribute to filter on
Comments

The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3133. PlanDefinition.action:routeAndSendEicr.output.dateFilter.searchParam
Definition

A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.

ShortA date valued parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3135. PlanDefinition.action:routeAndSendEicr.output.dateFilter.value[x]
Definition

The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.

ShortThe value of the filter, as a Period, DateTime, or Duration value
Control0..1
TypeChoice of: dateTime, Period, Duration
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3137. PlanDefinition.action:routeAndSendEicr.output.limit
Definition

Specifies a maximum number of results that are required (uses the _count search parameter).

ShortNumber of results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".

Control0..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3139. PlanDefinition.action:routeAndSendEicr.output.sort
Definition

Specifies the order of the results to be returned.

ShortOrder of the results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.

Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3141. PlanDefinition.action:routeAndSendEicr.output.sort.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
3143. PlanDefinition.action:routeAndSendEicr.output.sort.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.sort.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
3145. PlanDefinition.action:routeAndSendEicr.output.sort.path
Definition

The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.

ShortThe name of the attribute to perform the sort
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3147. PlanDefinition.action:routeAndSendEicr.output.sort.direction
Definition

The direction of the sort, ascending or descending.

Shortascending | descending
Control1..1
BindingThe codes SHALL be taken from SortDirection
(required to http://hl7.org/fhir/ValueSet/sort-direction|4.0.1)

The possible sort directions, ascending or descending.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3149. PlanDefinition.action:routeAndSendEicr.relatedAction
Definition

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

ShortRelationship to another action
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.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3151. PlanDefinition.action:routeAndSendEicr.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
3153. PlanDefinition.action:routeAndSendEicr.relatedAction.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
3155. PlanDefinition.action:routeAndSendEicr.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
3157. PlanDefinition.action:routeAndSendEicr.relatedAction.actionId
Definition

The element id of the related action.

ShortWhat action is this related to
Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3159. PlanDefinition.action:routeAndSendEicr.relatedAction.relationship
Definition

The relationship of this action to the related action.

Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control1..1
BindingThe codes SHALL be taken from ActionRelationshipType
(required to http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1)

Defines the types of relationships between actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3161. PlanDefinition.action:routeAndSendEicr.relatedAction.offset[x]
Definition

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

ShortTime offset for the relationship
Control0..1
TypeChoice of: Duration, Range
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action.relatedAction.offset[x]. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this
3163. PlanDefinition.action:routeAndSendEicr.relatedAction.offset[x]:offsetDuration
Slice NameoffsetDuration
Definition

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

ShortTime offset for the relationship
Control0..1
TypeDuration
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3165. PlanDefinition.action:routeAndSendEicr.timing[x]
Definition

An optional value describing when the action should be performed.

ShortWhen the action should take place
Control0..1
TypeDuration
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3167. PlanDefinition.action:routeAndSendEicr.participant
Definition

Indicates who should participate in performing the action described.

ShortWho should participate in the action
Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3169. PlanDefinition.action:routeAndSendEicr.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
3171. PlanDefinition.action:routeAndSendEicr.participant.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
3173. PlanDefinition.action:routeAndSendEicr.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
3175. PlanDefinition.action:routeAndSendEicr.participant.type
Definition

The type of participant in the action.

Shortpatient | practitioner | related-person | device
Control1..1
BindingThe codes SHALL be taken from ActionParticipantType
(required to http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1)

The type of participant for the action.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3177. PlanDefinition.action:routeAndSendEicr.participant.role
Definition

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

ShortE.g. Nurse, Surgeon, Parent
Control0..1
BindingFor example codes, see ActionParticipantRole
(example to http://hl7.org/fhir/ValueSet/action-participant-role)

Defines roles played by participants for the action.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3179. PlanDefinition.action:routeAndSendEicr.type
Definition

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

Shortcreate | update | remove | fire-event
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ActionType
(extensible to http://hl7.org/fhir/ValueSet/action-type)

The type of action to be performed.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3181. PlanDefinition.action:routeAndSendEicr.groupingBehavior
Definition

Defines the grouping behavior for the action and its children.

Shortvisual-group | logical-group | sentence-group
Control0..1
BindingThe codes SHALL be taken from ActionGroupingBehavior
(required to http://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.1)

Defines organization behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3183. PlanDefinition.action:routeAndSendEicr.selectionBehavior
Definition

Defines the selection behavior for the action and its children.

Shortany | all | all-or-none | exactly-one | at-most-one | one-or-more
Control0..1
BindingThe codes SHALL be taken from ActionSelectionBehavior
(required to http://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.1)

Defines selection behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3185. PlanDefinition.action:routeAndSendEicr.requiredBehavior
Definition

Defines the required behavior for the action.

Shortmust | could | must-unless-documented
Control0..1
BindingThe codes SHALL be taken from ActionRequiredBehavior
(required to http://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1)

Defines expectations around whether an action or action group is required.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3187. PlanDefinition.action:routeAndSendEicr.precheckBehavior
Definition

Defines whether the action should usually be preselected.

Shortyes | no
Control0..1
BindingThe codes SHALL be taken from ActionPrecheckBehavior
(required to http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1)

Defines selection frequency behavior for an action or group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3189. PlanDefinition.action:routeAndSendEicr.cardinalityBehavior
Definition

Defines whether the action can be selected multiple times.

Shortsingle | multiple
Control0..1
BindingThe codes SHALL be taken from ActionCardinalityBehavior
(required to http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1)

Defines behavior for an action or a group for how many times that item may be repeated.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3191. PlanDefinition.action:routeAndSendEicr.definition[x]
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.

ShortDescription of the activity to be performed
Comments

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

Control0..1
TypeChoice of: canonical(ActivityDefinition, PlanDefinition, Questionnaire), uri
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3193. PlanDefinition.action:routeAndSendEicr.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.

ShortTransform to apply the template
Comments

Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..1
Typecanonical(StructureMap)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3195. PlanDefinition.action:routeAndSendEicr.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.

ShortDynamic aspects of the definition
Comments

Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3197. PlanDefinition.action:routeAndSendEicr.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
3199. PlanDefinition.action:routeAndSendEicr.dynamicValue.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
3201. PlanDefinition.action:routeAndSendEicr.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
3203. PlanDefinition.action:routeAndSendEicr.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. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details).

ShortThe path to the element to be set dynamically
Comments

To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3205. PlanDefinition.action:routeAndSendEicr.dynamicValue.expression
Definition

An expression specifying the value of the customized element.

ShortAn expression that provides the dynamic value for the customization
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3207. PlanDefinition.action:routeAndSendEicr.action
Definition

Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.

ShortA sub-action
Control0..*
TypeSeettp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3209. PlanDefinition.action:encounterModified
Slice NameencounterModified
Definition

Defines the "encounter-modified" action

ShortEncounter modified code
Comments

Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.

Control1..1
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3211. PlanDefinition.action:encounterModified.id
Definition

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

ShortUnique id for inter-element referencing
Control1..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "id" : "encounter-modified"
}
<id value="encounter-modified"/>
3213. PlanDefinition.action:encounterModified.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
3215. PlanDefinition.action:encounterModified.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
3217. PlanDefinition.action:encounterModified.prefix
Definition

A user-visible prefix for the action.

ShortUser-visible prefix for the action (e.g. 1. or A.)
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3219. PlanDefinition.action:encounterModified.title
Definition

The title of the action displayed to a user.

ShortUser-visible title
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3221. PlanDefinition.action:encounterModified.description
Definition

Description of the "encounter-modified" action.

ShortDescription of the "encounter-modified" action.
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Value
{
  "description" : "This action represents the start of the reporting workflow in response to the encounter-modified event"
}
<description value="This action represents the start of the reporting workflow in response to the encounter-modified event"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3223. PlanDefinition.action:encounterModified.textEquivalent
Definition

Text equivalent of the "encounter-modified" action.

ShortText equivalent of the "encounter-modified" action.
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Value
{
  "textEquivalent" : "Start the reporting workflow in response to an encounter-modified event"
}
<textEquivalent value="Start the reporting workflow in response to an encounter-modified event"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3225. PlanDefinition.action:encounterModified.priority
Definition

Indicates how quickly the action should be addressed with respect to other actions.

Shortroutine | urgent | asap | stat
Control0..1
BindingThe codes SHALL be taken from RequestPriority
(required to http://hl7.org/fhir/ValueSet/request-priority|4.0.1)

Identifies the level of importance to be assigned to actioning the request.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3227. PlanDefinition.action:encounterModified.code
Definition

The US-PH-PlanDefinition-Action code for the "encounter-modified" action.

ShortCode for the "encounter-modified" action.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from US Public Health ValueSet - PlanDefinition Action
(extensible to http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-plandefinition-action)

The set of actions that can be used to create plan definition

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "initiate-reporting-workflow"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="initiate-reporting-workflow"/>
  </coding>
</code>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3229. PlanDefinition.action:encounterModified.reason
Definition

A description of why this action is necessary or appropriate.

ShortWhy the action should be performed
Comments

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

Control0..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3231. PlanDefinition.action:encounterModified.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.

ShortSupporting documentation for the intended performer of the action
Control0..*
TypeRelatedArtifact
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3233. PlanDefinition.action:encounterModified.goalId
Definition

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

ShortWhat goals this action supports
Control0..*
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3235. PlanDefinition.action:encounterModified.subject[x]
Definition

A code or group definition that describes the intended subject of the action and its children, if any.

ShortType of individual the action is focused on
Comments

The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified.

In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType
(extensible to http://hl7.org/fhir/ValueSet/subject-type)

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

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Requirements

Multiple steps in a protocol often have different groups of steps that are focused on testing different things. The subject of an action specifies the focus of the action and any child actions.

Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3237. PlanDefinition.action:encounterModified.trigger
Definition

When the "encounter-modified" action should be triggered.

ShortWhen the "encounter-modified" action should be triggered.
Control1..*
TypeTriggerDefinition
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
epd-1: The code value of the namedEventType SHALL be the same as the name element (name.supersetOf(extension('http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-named-eventtype-extension').value.coding.code))
3239. PlanDefinition.action:encounterModified.trigger.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
3241. PlanDefinition.action:encounterModified.trigger.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control1..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.trigger.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
3243. PlanDefinition.action:encounterModified.trigger.extension:namedEventType
Slice NamenamedEventType
Definition

Indicates the types of named events to subscribe to from the EHR.

ShortIndicates the types of named events to subscribe to from the EHR.
Control1..1
TypeExtension(US Public Health Named Event Type Extension) (Extension Type: CodeableConcept)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
3245. PlanDefinition.action:encounterModified.trigger.type
Definition

The type of triggering event.

Shortnamed-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Control1..1
BindingThe codes SHALL be taken from TriggerType
(required to http://hl7.org/fhir/ValueSet/trigger-type|4.0.1)

The type of trigger.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Value
{
  "type" : "named-event"
}
<type value="named-event"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3247. PlanDefinition.action:encounterModified.trigger.name
Definition

The name of the event, encounter-start in this case. For any action invoked as a result of this trigger, the triggering encounter is accessible via the context variable %encounter

ShortName or URI that identifies the event
Comments

An event name can be provided for all event types, but is required for named events. If a name is provided for a type other than named events, it is considered to be a shorthand for the semantics described by the formal description of the event.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Fixed Value
{
  "name" : "encounter-modified"
}
<name value="encounter-modified"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3249. PlanDefinition.action:encounterModified.trigger.timing[x]
Definition

The timing of the event (if this is a periodic trigger).

ShortTiming of the event
Control0..1
TypeChoice of: Timing, Reference(Schedule), date, dateTime
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3251. PlanDefinition.action:encounterModified.trigger.data
Definition

The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.

ShortTriggering data of the event (multiple = 'and')
Comments

This element shall be present for any data type trigger.

Control0..*
TypeDataRequirement
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3253. PlanDefinition.action:encounterModified.trigger.condition
Definition

A boolean-valued expression that is evaluated in the context of the container of the trigger definition and returns whether or not the trigger fires.

ShortWhether the event triggers (boolean expression)
Comments

This element can be only be specified for data type triggers and provides additional semantics for the trigger. The context available within the condition is based on the type of data event. For all events, the current resource will be available as context. In addition, for modification events, the previous resource will also be available. The expression may be inlined, or may be a simple absolute URI, which is a reference to a named expression within a logic library referenced by a library element or extension within the containing resource. If the expression is a FHIR Path expression, it evaluates in the context of a resource of one of the type identified in the data requirement, and may also refer to the variable %previous for delta comparisons on events of type data-changed, data-modified, and data-deleted which will always have the same type.

Control0..1
TypeExpression
Is Modifierfalse
Summarytrue
Requirements

Need to be able to formally describe the triggering criteria.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3255. PlanDefinition.action:encounterModified.condition
Definition

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

ShortWhether or not the action is applicable
Comments

When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3257. PlanDefinition.action:encounterModified.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
3259. PlanDefinition.action:encounterModified.condition.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
3261. PlanDefinition.action:encounterModified.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
3263. PlanDefinition.action:encounterModified.condition.kind
Definition

The kind of condition.

Shortapplicability | start | stop
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 enter/exit criteria for an action.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKind
(required to http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1)

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3265. PlanDefinition.action:encounterModified.condition.expression
Definition

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

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3267. PlanDefinition.action:encounterModified.input
Definition

Defines input data requirements for the action.

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3269. PlanDefinition.action:encounterModified.input.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
3271. PlanDefinition.action:encounterModified.input.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
3273. PlanDefinition.action:encounterModified.input.extension:fhirquerypattern
Slice Namefhirquerypattern
Definition

A FHIR Query URL pattern that corresponds to the data specified by the data requirement. If multiple FHIR Query URLs are present, they each contribute to the data specified by the data requirement (i.e. the union of the results of the FHIR Queries represents the complete data for the data requirement). This is not a resolveable URL, in that it will contain 1) No base canonical (i.e. it's a relative query), and 2) Parameters using tokens that are delimited using double-braces and the context parameters are dependent solely on the subjectType, according to the following: Patient: context.patientId, Practitioner: context.practitionerId, Organization: context.organizationId, Location: context.locationId, Device: context.deviceId. For example, for a Library with a subjectType of Patient, the context parameter {{context.patientId}} will be used as a token to be replaced with the id of the Patient in context. This extension is used primarily to address the use case for satisfying a data requirement for a single subject. However, the query pattern could also be used to satisfy population level requests by removing the subject-level filter from the query.

ShortWhat FHIR query?
Comments

Supports communicating a FHIR query (or set of queries) for the given data requirement. The query is server-specific, and will need to be created as informed by a CapabilityStatement. The $data-requirements operation should be expected to be able to provide an Endpoint or CapabilityStatement to provide this information.; If no endpoint or capability statement is provided, the capability statement of the server performing the operation is used.

Control0..1
TypeExtension(FHIR Query Pattern) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
3275. PlanDefinition.action:encounterModified.input.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypes
(required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3277. PlanDefinition.action:encounterModified.input.profile
Definition

The profile of the required data, specified as the uri of the profile definition.

ShortThe profile of the required data
Control0..*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3279. PlanDefinition.action:encounterModified.input.subject[x]
Definition

The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.

ShortE.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments

The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType
(extensible to http://hl7.org/fhir/ValueSet/subject-type|4.0.1)

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

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summarytrue
Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3281. PlanDefinition.action:encounterModified.input.mustSupport
Definition

Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available.

The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).

ShortIndicates specific structure elements that are referenced by the knowledge module
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3283. PlanDefinition.action:encounterModified.input.codeFilter
Definition

Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.

ShortWhat codes are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-1: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3285. PlanDefinition.action:encounterModified.input.codeFilter.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
3287. PlanDefinition.action:encounterModified.input.codeFilter.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.codeFilter.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
3289. PlanDefinition.action:encounterModified.input.codeFilter.path
Definition

The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.

ShortA code-valued attribute to filter on
Comments

The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3291. PlanDefinition.action:encounterModified.input.codeFilter.searchParam
Definition

A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.

ShortA coded (token) parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3293. PlanDefinition.action:encounterModified.input.codeFilter.valueSet
Definition

The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.

ShortValueset for the filter
Control0..1
Typecanonical(ValueSet)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3295. PlanDefinition.action:encounterModified.input.codeFilter.code
Definition

The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.

ShortWhat code is expected
Control0..*
TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3297. PlanDefinition.action:encounterModified.input.dateFilter
Definition

Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.

ShortWhat dates/date ranges are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-2: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3299. PlanDefinition.action:encounterModified.input.dateFilter.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
3301. PlanDefinition.action:encounterModified.input.dateFilter.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.dateFilter.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
3303. PlanDefinition.action:encounterModified.input.dateFilter.path
Definition

The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.

ShortA date-valued attribute to filter on
Comments

The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3305. PlanDefinition.action:encounterModified.input.dateFilter.searchParam
Definition

A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.

ShortA date valued parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3307. PlanDefinition.action:encounterModified.input.dateFilter.value[x]
Definition

The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.

ShortThe value of the filter, as a Period, DateTime, or Duration value
Control0..1
TypeChoice of: dateTime, Period, Duration
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3309. PlanDefinition.action:encounterModified.input.limit
Definition

Specifies a maximum number of results that are required (uses the _count search parameter).

ShortNumber of results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".

Control0..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3311. PlanDefinition.action:encounterModified.input.sort
Definition

Specifies the order of the results to be returned.

ShortOrder of the results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.

Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3313. PlanDefinition.action:encounterModified.input.sort.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
3315. PlanDefinition.action:encounterModified.input.sort.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.sort.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
3317. PlanDefinition.action:encounterModified.input.sort.path
Definition

The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.

ShortThe name of the attribute to perform the sort
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3319. PlanDefinition.action:encounterModified.input.sort.direction
Definition

The direction of the sort, ascending or descending.

Shortascending | descending
Control1..1
BindingThe codes SHALL be taken from SortDirection
(required to http://hl7.org/fhir/ValueSet/sort-direction|4.0.1)

The possible sort directions, ascending or descending.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3321. PlanDefinition.action:encounterModified.output
Definition

Defines the outputs of the action, if any.

ShortOutput data definition
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3323. PlanDefinition.action:encounterModified.output.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
3325. PlanDefinition.action:encounterModified.output.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
3327. PlanDefinition.action:encounterModified.output.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypes
(required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3329. PlanDefinition.action:encounterModified.output.profile
Definition

The profile of the required data, specified as the uri of the profile definition.

ShortThe profile of the required data
Control0..*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3331. PlanDefinition.action:encounterModified.output.subject[x]
Definition

The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.

ShortE.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments

The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType
(extensible to http://hl7.org/fhir/ValueSet/subject-type|4.0.1)

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

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summarytrue
Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3333. PlanDefinition.action:encounterModified.output.mustSupport
Definition

Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available.

The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).

ShortIndicates specific structure elements that are referenced by the knowledge module
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3335. PlanDefinition.action:encounterModified.output.codeFilter
Definition

Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.

ShortWhat codes are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-1: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3337. PlanDefinition.action:encounterModified.output.codeFilter.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
3339. PlanDefinition.action:encounterModified.output.codeFilter.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.codeFilter.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
3341. PlanDefinition.action:encounterModified.output.codeFilter.path
Definition

The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.

ShortA code-valued attribute to filter on
Comments

The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3343. PlanDefinition.action:encounterModified.output.codeFilter.searchParam
Definition

A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.

ShortA coded (token) parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3345. PlanDefinition.action:encounterModified.output.codeFilter.valueSet
Definition

The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.

ShortValueset for the filter
Control0..1
Typecanonical(ValueSet)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3347. PlanDefinition.action:encounterModified.output.codeFilter.code
Definition

The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.

ShortWhat code is expected
Control0..*
TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3349. PlanDefinition.action:encounterModified.output.dateFilter
Definition

Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.

ShortWhat dates/date ranges are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-2: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3351. PlanDefinition.action:encounterModified.output.dateFilter.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
3353. PlanDefinition.action:encounterModified.output.dateFilter.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.dateFilter.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
3355. PlanDefinition.action:encounterModified.output.dateFilter.path
Definition

The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.

ShortA date-valued attribute to filter on
Comments

The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3357. PlanDefinition.action:encounterModified.output.dateFilter.searchParam
Definition

A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.

ShortA date valued parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3359. PlanDefinition.action:encounterModified.output.dateFilter.value[x]
Definition

The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.

ShortThe value of the filter, as a Period, DateTime, or Duration value
Control0..1
TypeChoice of: dateTime, Period, Duration
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3361. PlanDefinition.action:encounterModified.output.limit
Definition

Specifies a maximum number of results that are required (uses the _count search parameter).

ShortNumber of results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".

Control0..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3363. PlanDefinition.action:encounterModified.output.sort
Definition

Specifies the order of the results to be returned.

ShortOrder of the results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.

Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3365. PlanDefinition.action:encounterModified.output.sort.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
3367. PlanDefinition.action:encounterModified.output.sort.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.sort.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
3369. PlanDefinition.action:encounterModified.output.sort.path
Definition

The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.

ShortThe name of the attribute to perform the sort
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3371. PlanDefinition.action:encounterModified.output.sort.direction
Definition

The direction of the sort, ascending or descending.

Shortascending | descending
Control1..1
BindingThe codes SHALL be taken from SortDirection
(required to http://hl7.org/fhir/ValueSet/sort-direction|4.0.1)

The possible sort directions, ascending or descending.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3373. PlanDefinition.action:encounterModified.relatedAction
Definition

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

ShortRelationship to another action
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.

Control1..1
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3375. PlanDefinition.action:encounterModified.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
3377. PlanDefinition.action:encounterModified.relatedAction.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
3379. PlanDefinition.action:encounterModified.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
3381. PlanDefinition.action:encounterModified.relatedAction.actionId
Definition

The element id of the related action.

ShortWhat action is this related to
Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Value
{
  "actionId" : "is-modified-encounter-reportable"
}
<actionId value="is-modified-encounter-reportable"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3383. PlanDefinition.action:encounterModified.relatedAction.relationship
Definition

The relationship of this action to the related action.

Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control1..1
BindingThe codes SHALL be taken from ActionRelationshipType
(required to http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1)

Defines the types of relationships between actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Value
{
  "relationship" : "before-start"
}
<relationship value="before-start"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3385. PlanDefinition.action:encounterModified.relatedAction.offset[x]
Definition

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

ShortTime offset for the relationship
Control0..1
TypeChoice of: Duration, Range
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action.relatedAction.offset[x]. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this
3387. PlanDefinition.action:encounterModified.relatedAction.offset[x]:offsetDuration
Slice NameoffsetDuration
Definition

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

ShortTime offset for the relationship
Control0..1
TypeDuration
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3389. PlanDefinition.action:encounterModified.timing[x]
Definition

An optional value describing when the action should be performed.

ShortWhen the action should take place
Control0..1
TypeDuration
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3391. PlanDefinition.action:encounterModified.participant
Definition

Indicates who should participate in performing the action described.

ShortWho should participate in the action
Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3393. PlanDefinition.action:encounterModified.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
3395. PlanDefinition.action:encounterModified.participant.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
3397. PlanDefinition.action:encounterModified.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
3399. PlanDefinition.action:encounterModified.participant.type
Definition

The type of participant in the action.

Shortpatient | practitioner | related-person | device
Control1..1
BindingThe codes SHALL be taken from ActionParticipantType
(required to http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1)

The type of participant for the action.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3401. PlanDefinition.action:encounterModified.participant.role
Definition

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

ShortE.g. Nurse, Surgeon, Parent
Control0..1
BindingFor example codes, see ActionParticipantRole
(example to http://hl7.org/fhir/ValueSet/action-participant-role)

Defines roles played by participants for the action.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3403. PlanDefinition.action:encounterModified.type
Definition

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

Shortcreate | update | remove | fire-event
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ActionType
(extensible to http://hl7.org/fhir/ValueSet/action-type)

The type of action to be performed.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3405. PlanDefinition.action:encounterModified.groupingBehavior
Definition

Defines the grouping behavior for the action and its children.

Shortvisual-group | logical-group | sentence-group
Control0..1
BindingThe codes SHALL be taken from ActionGroupingBehavior
(required to http://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.1)

Defines organization behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3407. PlanDefinition.action:encounterModified.selectionBehavior
Definition

Defines the selection behavior for the action and its children.

Shortany | all | all-or-none | exactly-one | at-most-one | one-or-more
Control0..1
BindingThe codes SHALL be taken from ActionSelectionBehavior
(required to http://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.1)

Defines selection behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3409. PlanDefinition.action:encounterModified.requiredBehavior
Definition

Defines the required behavior for the action.

Shortmust | could | must-unless-documented
Control0..1
BindingThe codes SHALL be taken from ActionRequiredBehavior
(required to http://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1)

Defines expectations around whether an action or action group is required.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3411. PlanDefinition.action:encounterModified.precheckBehavior
Definition

Defines whether the action should usually be preselected.

Shortyes | no
Control0..1
BindingThe codes SHALL be taken from ActionPrecheckBehavior
(required to http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1)

Defines selection frequency behavior for an action or group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3413. PlanDefinition.action:encounterModified.cardinalityBehavior
Definition

Defines whether the action can be selected multiple times.

Shortsingle | multiple
Control0..1
BindingThe codes SHALL be taken from ActionCardinalityBehavior
(required to http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1)

Defines behavior for an action or a group for how many times that item may be repeated.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3415. PlanDefinition.action:encounterModified.definition[x]
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.

ShortDescription of the activity to be performed
Comments

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

Control0..1
TypeChoice of: canonical(ActivityDefinition, PlanDefinition, Questionnaire), uri
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3417. PlanDefinition.action:encounterModified.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.

ShortTransform to apply the template
Comments

Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..1
Typecanonical(StructureMap)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3419. PlanDefinition.action:encounterModified.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.

ShortDynamic aspects of the definition
Comments

Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3421. PlanDefinition.action:encounterModified.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
3423. PlanDefinition.action:encounterModified.dynamicValue.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
3425. PlanDefinition.action:encounterModified.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
3427. PlanDefinition.action:encounterModified.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. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details).

ShortThe path to the element to be set dynamically
Comments

To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3429. PlanDefinition.action:encounterModified.dynamicValue.expression
Definition

An expression specifying the value of the customized element.

ShortAn expression that provides the dynamic value for the customization
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3431. PlanDefinition.action:encounterModified.action
Definition

Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.

ShortA sub-action
Control0..*
TypeSeettp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3433. PlanDefinition.action:isModifiedEncounterReportable
Slice NameisModifiedEncounterReportable
Definition

Checks a modified encounter against the trigger code value sets. Invoked by the "encounter-modified" action and, when reportable, invokes "create-eicr".

ShortCheck a modified encounter for reportability
Comments

Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.

Control1..1
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3435. PlanDefinition.action:isModifiedEncounterReportable.id
Definition

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

ShortUnique id for inter-element referencing
Control1..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "id" : "is-modified-encounter-reportable"
}
<id value="is-modified-encounter-reportable"/>
3437. PlanDefinition.action:isModifiedEncounterReportable.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
3439. PlanDefinition.action:isModifiedEncounterReportable.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
3441. PlanDefinition.action:isModifiedEncounterReportable.prefix
Definition

A user-visible prefix for the action.

ShortUser-visible prefix for the action (e.g. 1. or A.)
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3443. PlanDefinition.action:isModifiedEncounterReportable.title
Definition

The title of the action displayed to a user.

ShortUser-visible title
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3445. PlanDefinition.action:isModifiedEncounterReportable.description
Definition

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

ShortBrief description of the action
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3447. PlanDefinition.action:isModifiedEncounterReportable.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 might not be capable of interpreting it dynamically.

ShortStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3449. PlanDefinition.action:isModifiedEncounterReportable.priority
Definition

Indicates how quickly the action should be addressed with respect to other actions.

Shortroutine | urgent | asap | stat
Control0..1
BindingThe codes SHALL be taken from RequestPriority
(required to http://hl7.org/fhir/ValueSet/request-priority|4.0.1)

Identifies the level of importance to be assigned to actioning the request.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3451. PlanDefinition.action:isModifiedEncounterReportable.code
Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.

ShortCode representing the meaning of the action or sub-actions
Control1..1
BindingUnless not suitable, these codes SHALL be taken from US Public Health ValueSet - PlanDefinition Action
(extensible to http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-plandefinition-action)

The set of actions that can be used to create plan definition

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions",
      "code" : "check-trigger-codes"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions"/>
    <code value="check-trigger-codes"/>
  </coding>
</code>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3453. PlanDefinition.action:isModifiedEncounterReportable.reason
Definition

A description of why this action is necessary or appropriate.

ShortWhy the action should be performed
Comments

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

Control0..*
TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3455. PlanDefinition.action:isModifiedEncounterReportable.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.

ShortSupporting documentation for the intended performer of the action
Control0..*
TypeRelatedArtifact
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3457. PlanDefinition.action:isModifiedEncounterReportable.goalId
Definition

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

ShortWhat goals this action supports
Control0..*
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3459. PlanDefinition.action:isModifiedEncounterReportable.subject[x]
Definition

A code or group definition that describes the intended subject of the action and its children, if any.

ShortType of individual the action is focused on
Comments

The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified.

In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType
(extensible to http://hl7.org/fhir/ValueSet/subject-type)

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

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Requirements

Multiple steps in a protocol often have different groups of steps that are focused on testing different things. The subject of an action specifies the focus of the action and any child actions.

Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3461. PlanDefinition.action:isModifiedEncounterReportable.trigger
Definition

A description of when the action should be triggered.

ShortWhen the action should be triggered
Control0..*
TypeTriggerDefinition
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3463. PlanDefinition.action:isModifiedEncounterReportable.trigger.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
3465. PlanDefinition.action:isModifiedEncounterReportable.trigger.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control1..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.trigger.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
3467. PlanDefinition.action:isModifiedEncounterReportable.trigger.extension:namedEventType
Slice NamenamedEventType
Definition

Indicates the types of named events to subscribe to from the EHR.

ShortUS Public Health Named Event Type Extension
Control1..1
TypeExtension(US Public Health Named Event Type Extension) (Extension Type: CodeableConcept)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
3469. PlanDefinition.action:isModifiedEncounterReportable.trigger.type
Definition

The type of triggering event.

Shortnamed-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Control1..1
BindingThe codes SHALL be taken from TriggerType
(required to http://hl7.org/fhir/ValueSet/trigger-type|4.0.1)

The type of trigger.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Value
{
  "type" : "named-event"
}
<type value="named-event"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3471. PlanDefinition.action:isModifiedEncounterReportable.trigger.name
Definition

A formal name for the event. This may be an absolute URI that identifies the event formally (e.g. from a trigger registry), or a simple relative URI that identifies the event in a local context.

ShortName or URI that identifies the event
Comments

An event name can be provided for all event types, but is required for named events. If a name is provided for a type other than named events, it is considered to be a shorthand for the semantics described by the formal description of the event.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3473. PlanDefinition.action:isModifiedEncounterReportable.trigger.timing[x]
Definition

The timing of the event (if this is a periodic trigger).

ShortTiming of the event
Control0..1
TypeChoice of: Timing, Reference(Schedule), date, dateTime
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3475. PlanDefinition.action:isModifiedEncounterReportable.trigger.data
Definition

The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.

ShortTriggering data of the event (multiple = 'and')
Comments

This element shall be present for any data type trigger.

Control0..*
TypeDataRequirement
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3477. PlanDefinition.action:isModifiedEncounterReportable.trigger.condition
Definition

A boolean-valued expression that is evaluated in the context of the container of the trigger definition and returns whether or not the trigger fires.

ShortWhether the event triggers (boolean expression)
Comments

This element can be only be specified for data type triggers and provides additional semantics for the trigger. The context available within the condition is based on the type of data event. For all events, the current resource will be available as context. In addition, for modification events, the previous resource will also be available. The expression may be inlined, or may be a simple absolute URI, which is a reference to a named expression within a logic library referenced by a library element or extension within the containing resource. If the expression is a FHIR Path expression, it evaluates in the context of a resource of one of the type identified in the data requirement, and may also refer to the variable %previous for delta comparisons on events of type data-changed, data-modified, and data-deleted which will always have the same type.

Control0..1
TypeExpression
Is Modifierfalse
Summarytrue
Requirements

Need to be able to formally describe the triggering criteria.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3479. PlanDefinition.action:isModifiedEncounterReportable.condition
Definition

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

ShortApplicability condition for the modified-encounter reportability check.
Comments

When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.

Control1..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3481. PlanDefinition.action:isModifiedEncounterReportable.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
3483. PlanDefinition.action:isModifiedEncounterReportable.condition.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
3485. PlanDefinition.action:isModifiedEncounterReportable.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
3487. PlanDefinition.action:isModifiedEncounterReportable.condition.kind
Definition

The kind of condition.

Shortapplicability | start | stop
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 enter/exit criteria for an action.

Control1..1
BindingThe codes SHALL be taken from ActionConditionKind
(required to http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1)

Defines the kinds of conditions that can appear on actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Value
{
  "kind" : "applicability"
}
<kind value="applicability"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3489. PlanDefinition.action:isModifiedEncounterReportable.condition.expression
Definition

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

ShortBoolean-valued expression
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control1..1
TypeExpression
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3491. PlanDefinition.action:isModifiedEncounterReportable.condition.expression.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
3493. PlanDefinition.action:isModifiedEncounterReportable.condition.expression.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.condition.expression.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
3495. PlanDefinition.action:isModifiedEncounterReportable.condition.expression.description
Definition

A brief, natural language description of the condition that effectively communicates the intended semantics.

ShortNatural language description of the condition
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3497. PlanDefinition.action:isModifiedEncounterReportable.condition.expression.name
Definition

A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.

ShortShort name assigned to expression for reuse
Control0..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3499. PlanDefinition.action:isModifiedEncounterReportable.condition.expression.language
Definition

The media type of the language for the expression.

Shorttext/cql | text/fhirpath | application/x-fhir-query | etc.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from ExpressionLanguage
(extensible to http://hl7.org/fhir/ValueSet/expression-language|4.0.1)

The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Fixed Value
{
  "language" : "text/fhirpath"
}
<language value="text/fhirpath"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3501. PlanDefinition.action:isModifiedEncounterReportable.condition.expression.expression
Definition

An expression in the specified language that returns a value.

ShortExpression in specified language
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3503. PlanDefinition.action:isModifiedEncounterReportable.condition.expression.reference
Definition

A URI that defines where the expression is found.

ShortWhere the expression is found
Comments

If both a reference and an expression is found, the reference SHALL point to the same expression.

Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3505. PlanDefinition.action:isModifiedEncounterReportable.input
Definition

Defines input data requirements for the action.

ShortInput data requirements
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3507. PlanDefinition.action:isModifiedEncounterReportable.input.id
Definition

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

ShortUnique id for inter-element referencing
Control1..1
Typestring
Is Modifierfalse
Must Supporttrue
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
3509. PlanDefinition.action:isModifiedEncounterReportable.input.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
3511. PlanDefinition.action:isModifiedEncounterReportable.input.extension:fhirquerypattern
Slice Namefhirquerypattern
Definition

A FHIR Query URL pattern that corresponds to the data specified by the data requirement. If multiple FHIR Query URLs are present, they each contribute to the data specified by the data requirement (i.e. the union of the results of the FHIR Queries represents the complete data for the data requirement). This is not a resolveable URL, in that it will contain 1) No base canonical (i.e. it's a relative query), and 2) Parameters using tokens that are delimited using double-braces and the context parameters are dependent solely on the subjectType, according to the following: Patient: context.patientId, Practitioner: context.practitionerId, Organization: context.organizationId, Location: context.locationId, Device: context.deviceId. For example, for a Library with a subjectType of Patient, the context parameter {{context.patientId}} will be used as a token to be replaced with the id of the Patient in context. This extension is used primarily to address the use case for satisfying a data requirement for a single subject. However, the query pattern could also be used to satisfy population level requests by removing the subject-level filter from the query.

ShortWhat FHIR query?
Comments

Supports communicating a FHIR query (or set of queries) for the given data requirement. The query is server-specific, and will need to be created as informed by a CapabilityStatement. The $data-requirements operation should be expected to be able to provide an Endpoint or CapabilityStatement to provide this information.; If no endpoint or capability statement is provided, the capability statement of the server performing the operation is used.

Control0..1
TypeExtension(FHIR Query Pattern) (Extension Type: string)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
3513. PlanDefinition.action:isModifiedEncounterReportable.input.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypes
(required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3515. PlanDefinition.action:isModifiedEncounterReportable.input.profile
Definition

The profile of the required data, specified as the uri of the profile definition.

ShortThe profile of the required data
Control0..*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3517. PlanDefinition.action:isModifiedEncounterReportable.input.subject[x]
Definition

The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.

ShortE.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments

The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType
(extensible to http://hl7.org/fhir/ValueSet/subject-type|4.0.1)

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

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summarytrue
Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3519. PlanDefinition.action:isModifiedEncounterReportable.input.mustSupport
Definition

Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available.

The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).

ShortIndicates specific structure elements that are referenced by the knowledge module
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3521. PlanDefinition.action:isModifiedEncounterReportable.input.codeFilter
Definition

Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.

ShortWhat codes are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-1: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3523. PlanDefinition.action:isModifiedEncounterReportable.input.codeFilter.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
3525. PlanDefinition.action:isModifiedEncounterReportable.input.codeFilter.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.codeFilter.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
3527. PlanDefinition.action:isModifiedEncounterReportable.input.codeFilter.path
Definition

The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.

ShortA code-valued attribute to filter on
Comments

The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3529. PlanDefinition.action:isModifiedEncounterReportable.input.codeFilter.searchParam
Definition

A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.

ShortA coded (token) parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3531. PlanDefinition.action:isModifiedEncounterReportable.input.codeFilter.valueSet
Definition

The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.

ShortValueset for the filter
Control0..1
Typecanonical(ValueSet)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3533. PlanDefinition.action:isModifiedEncounterReportable.input.codeFilter.code
Definition

The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.

ShortWhat code is expected
Control0..*
TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3535. PlanDefinition.action:isModifiedEncounterReportable.input.dateFilter
Definition

Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.

ShortWhat dates/date ranges are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-2: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3537. PlanDefinition.action:isModifiedEncounterReportable.input.dateFilter.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
3539. PlanDefinition.action:isModifiedEncounterReportable.input.dateFilter.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.dateFilter.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
3541. PlanDefinition.action:isModifiedEncounterReportable.input.dateFilter.path
Definition

The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.

ShortA date-valued attribute to filter on
Comments

The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3543. PlanDefinition.action:isModifiedEncounterReportable.input.dateFilter.searchParam
Definition

A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.

ShortA date valued parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3545. PlanDefinition.action:isModifiedEncounterReportable.input.dateFilter.value[x]
Definition

The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.

ShortThe value of the filter, as a Period, DateTime, or Duration value
Control0..1
TypeChoice of: dateTime, Period, Duration
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3547. PlanDefinition.action:isModifiedEncounterReportable.input.limit
Definition

Specifies a maximum number of results that are required (uses the _count search parameter).

ShortNumber of results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".

Control0..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3549. PlanDefinition.action:isModifiedEncounterReportable.input.sort
Definition

Specifies the order of the results to be returned.

ShortOrder of the results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.

Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3551. PlanDefinition.action:isModifiedEncounterReportable.input.sort.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
3553. PlanDefinition.action:isModifiedEncounterReportable.input.sort.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.input.sort.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
3555. PlanDefinition.action:isModifiedEncounterReportable.input.sort.path
Definition

The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.

ShortThe name of the attribute to perform the sort
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3557. PlanDefinition.action:isModifiedEncounterReportable.input.sort.direction
Definition

The direction of the sort, ascending or descending.

Shortascending | descending
Control1..1
BindingThe codes SHALL be taken from SortDirection
(required to http://hl7.org/fhir/ValueSet/sort-direction|4.0.1)

The possible sort directions, ascending or descending.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3559. PlanDefinition.action:isModifiedEncounterReportable.output
Definition

Defines the outputs of the action, if any.

ShortOutput data definition
Control0..*
TypeDataRequirement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3561. PlanDefinition.action:isModifiedEncounterReportable.output.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
3563. PlanDefinition.action:isModifiedEncounterReportable.output.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
3565. PlanDefinition.action:isModifiedEncounterReportable.output.type
Definition

The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.

ShortThe type of the required data
Control1..1
BindingThe codes SHALL be taken from FHIRAllTypes
(required to http://hl7.org/fhir/ValueSet/all-types|4.0.1)

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3567. PlanDefinition.action:isModifiedEncounterReportable.output.profile
Definition

The profile of the required data, specified as the uri of the profile definition.

ShortThe profile of the required data
Control0..*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3569. PlanDefinition.action:isModifiedEncounterReportable.output.subject[x]
Definition

The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.

ShortE.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments

The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectType
(extensible to http://hl7.org/fhir/ValueSet/subject-type|4.0.1)

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

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summarytrue
Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3571. PlanDefinition.action:isModifiedEncounterReportable.output.mustSupport
Definition

Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available.

The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).

ShortIndicates specific structure elements that are referenced by the knowledge module
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3573. PlanDefinition.action:isModifiedEncounterReportable.output.codeFilter
Definition

Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.

ShortWhat codes are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-1: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3575. PlanDefinition.action:isModifiedEncounterReportable.output.codeFilter.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
3577. PlanDefinition.action:isModifiedEncounterReportable.output.codeFilter.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.codeFilter.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
3579. PlanDefinition.action:isModifiedEncounterReportable.output.codeFilter.path
Definition

The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.

ShortA code-valued attribute to filter on
Comments

The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3581. PlanDefinition.action:isModifiedEncounterReportable.output.codeFilter.searchParam
Definition

A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.

ShortA coded (token) parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3583. PlanDefinition.action:isModifiedEncounterReportable.output.codeFilter.valueSet
Definition

The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.

ShortValueset for the filter
Control0..1
Typecanonical(ValueSet)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3585. PlanDefinition.action:isModifiedEncounterReportable.output.codeFilter.code
Definition

The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.

ShortWhat code is expected
Control0..*
TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3587. PlanDefinition.action:isModifiedEncounterReportable.output.dateFilter
Definition

Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.

ShortWhat dates/date ranges are expected
Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Invariantsdrq-2: Either a path or a searchParam must be provided, but not both (path.exists() xor searchParam.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3589. PlanDefinition.action:isModifiedEncounterReportable.output.dateFilter.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
3591. PlanDefinition.action:isModifiedEncounterReportable.output.dateFilter.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.dateFilter.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
3593. PlanDefinition.action:isModifiedEncounterReportable.output.dateFilter.path
Definition

The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.

ShortA date-valued attribute to filter on
Comments

The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3595. PlanDefinition.action:isModifiedEncounterReportable.output.dateFilter.searchParam
Definition

A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.

ShortA date valued parameter to search on
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3597. PlanDefinition.action:isModifiedEncounterReportable.output.dateFilter.value[x]
Definition

The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.

ShortThe value of the filter, as a Period, DateTime, or Duration value
Control0..1
TypeChoice of: dateTime, Period, Duration
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3599. PlanDefinition.action:isModifiedEncounterReportable.output.limit
Definition

Specifies a maximum number of results that are required (uses the _count search parameter).

ShortNumber of results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".

Control0..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3601. PlanDefinition.action:isModifiedEncounterReportable.output.sort
Definition

Specifies the order of the results to be returned.

ShortOrder of the results
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.

Control0..*
TypeElement
Is Modifierfalse
Summarytrue
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3603. PlanDefinition.action:isModifiedEncounterReportable.output.sort.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
3605. PlanDefinition.action:isModifiedEncounterReportable.output.sort.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanDefinition.action.output.sort.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
3607. PlanDefinition.action:isModifiedEncounterReportable.output.sort.path
Definition

The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.

ShortThe name of the attribute to perform the sort
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3609. PlanDefinition.action:isModifiedEncounterReportable.output.sort.direction
Definition

The direction of the sort, ascending or descending.

Shortascending | descending
Control1..1
BindingThe codes SHALL be taken from SortDirection
(required to http://hl7.org/fhir/ValueSet/sort-direction|4.0.1)

The possible sort directions, ascending or descending.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3611. PlanDefinition.action:isModifiedEncounterReportable.relatedAction
Definition

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

ShortRelationship to another action
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.

Control1..1
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3613. PlanDefinition.action:isModifiedEncounterReportable.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
3615. PlanDefinition.action:isModifiedEncounterReportable.relatedAction.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
3617. PlanDefinition.action:isModifiedEncounterReportable.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
3619. PlanDefinition.action:isModifiedEncounterReportable.relatedAction.actionId
Definition

The element id of the related action.

ShortWhat action is this related to
Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Value
{
  "actionId" : "create-eicr"
}
<actionId value="create-eicr"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3621. PlanDefinition.action:isModifiedEncounterReportable.relatedAction.relationship
Definition

The relationship of this action to the related action.

Shortbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control1..1
BindingThe codes SHALL be taken from ActionRelationshipType
(required to http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1)

Defines the types of relationships between actions.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Fixed Value
{
  "relationship" : "before-start"
}
<relationship value="before-start"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3623. PlanDefinition.action:isModifiedEncounterReportable.relatedAction.offset[x]
Definition

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

ShortTime offset for the relationship
Control0..1
TypeChoice of: Duration, Range
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on PlanDefinition.action.relatedAction.offset[x]. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this
3625. PlanDefinition.action:isModifiedEncounterReportable.relatedAction.offset[x]:offsetDuration
Slice NameoffsetDuration
Definition

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

ShortTime offset for the relationship
Control0..1
TypeDuration
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3627. PlanDefinition.action:isModifiedEncounterReportable.timing[x]
Definition

An optional value describing when the action should be performed.

ShortWhen the action should take place
Control0..1
TypeDuration
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3629. PlanDefinition.action:isModifiedEncounterReportable.participant
Definition

Indicates who should participate in performing the action described.

ShortWho should participate in the action
Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3631. PlanDefinition.action:isModifiedEncounterReportable.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
3633. PlanDefinition.action:isModifiedEncounterReportable.participant.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
3635. PlanDefinition.action:isModifiedEncounterReportable.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
3637. PlanDefinition.action:isModifiedEncounterReportable.participant.type
Definition

The type of participant in the action.

Shortpatient | practitioner | related-person | device
Control1..1
BindingThe codes SHALL be taken from ActionParticipantType
(required to http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1)

The type of participant for the action.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3639. PlanDefinition.action:isModifiedEncounterReportable.participant.role
Definition

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

ShortE.g. Nurse, Surgeon, Parent
Control0..1
BindingFor example codes, see ActionParticipantRole
(example to http://hl7.org/fhir/ValueSet/action-participant-role)

Defines roles played by participants for the action.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3641. PlanDefinition.action:isModifiedEncounterReportable.type
Definition

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

Shortcreate | update | remove | fire-event
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ActionType
(extensible to http://hl7.org/fhir/ValueSet/action-type)

The type of action to be performed.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3643. PlanDefinition.action:isModifiedEncounterReportable.groupingBehavior
Definition

Defines the grouping behavior for the action and its children.

Shortvisual-group | logical-group | sentence-group
Control0..1
BindingThe codes SHALL be taken from ActionGroupingBehavior
(required to http://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.1)

Defines organization behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3645. PlanDefinition.action:isModifiedEncounterReportable.selectionBehavior
Definition

Defines the selection behavior for the action and its children.

Shortany | all | all-or-none | exactly-one | at-most-one | one-or-more
Control0..1
BindingThe codes SHALL be taken from ActionSelectionBehavior
(required to http://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.1)

Defines selection behavior of a group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3647. PlanDefinition.action:isModifiedEncounterReportable.requiredBehavior
Definition

Defines the required behavior for the action.

Shortmust | could | must-unless-documented
Control0..1
BindingThe codes SHALL be taken from ActionRequiredBehavior
(required to http://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1)

Defines expectations around whether an action or action group is required.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3649. PlanDefinition.action:isModifiedEncounterReportable.precheckBehavior
Definition

Defines whether the action should usually be preselected.

Shortyes | no
Control0..1
BindingThe codes SHALL be taken from ActionPrecheckBehavior
(required to http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1)

Defines selection frequency behavior for an action or group.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3651. PlanDefinition.action:isModifiedEncounterReportable.cardinalityBehavior
Definition

Defines whether the action can be selected multiple times.

Shortsingle | multiple
Control0..1
BindingThe codes SHALL be taken from ActionCardinalityBehavior
(required to http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1)

Defines behavior for an action or a group for how many times that item may be repeated.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3653. PlanDefinition.action:isModifiedEncounterReportable.definition[x]
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.

ShortDescription of the activity to be performed
Comments

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

Control0..1
TypeChoice of: canonical(ActivityDefinition, PlanDefinition, Questionnaire), uri
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3655. PlanDefinition.action:isModifiedEncounterReportable.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.

ShortTransform to apply the template
Comments

Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..1
Typecanonical(StructureMap)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3657. PlanDefinition.action:isModifiedEncounterReportable.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.

ShortDynamic aspects of the definition
Comments

Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3659. PlanDefinition.action:isModifiedEncounterReportable.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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
3661. PlanDefinition.action:isModifiedEncounterReportable.dynamicValue.extension
Definition

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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
3663. PlanDefinition.action:isModifiedEncounterReportable.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 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
3665. PlanDefinition.action:isModifiedEncounterReportable.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. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details).

ShortThe path to the element to be set dynamically
Comments

To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3667. PlanDefinition.action:isModifiedEncounterReportable.dynamicValue.expression
Definition

An expression specifying the value of the customized element.

ShortAn expression that provides the dynamic value for the customization
Comments

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Control0..1
TypeExpression
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
3669. PlanDefinition.action:isModifiedEncounterReportable.action
Definition

Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.

ShortA sub-action
Control0..*
TypeSeettp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))