Summary
Request & Response
Diagnostics
Care Provision
Medications
Workflow
Entities
Management
Individuals
General
Billing
Support
Payment
Security
Other
Conformance
Terminology
Documents
Definitional Artifacts
Medication Definition
Evidence-Based Medicine
Quality Reporting & Testing
Public Health & Research
Complex
Primitive
ActivityDefinition
CanonicalResource
CapabilityStatement
ChargeItemDefinition
Claim
CodeSystem
Composition
ConceptMap
CoverageEligibilityRequest
DocumentReference
Encounter
EpisodeOfCare
Group
Library
List
Measure
MedicinalProductDefinition
MessageHeader
NamingSystem
Observation
Patient
PlanDefinition
Resource
SpecimenDefinition
StructureDefinition
StructureMap
Subscription
ValueSet
default
This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical and non-clinical artifacts such as clinical decision support rules, order sets, protocols, and drug quality specifications.
PlanDefinition
Path
PlanDefinition
Id
PlanDefinition
Cardinality
0 - *
Definition
This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical and non-clinical artifacts such as clinical decision support rules, order sets, protocols, and drug quality specifications.
Comment
Constraint
cnl-0 [warning]
Name should be usable as an identifier for the module by machine processing applications such as code generation
pld-3 [warning]
goalid should reference the id of a goal definition
pld-4 [warning]
targetId should reference the id of an action
Path
PlanDefinition.url
Id
PlanDefinition.url
Type
Cardinality
0 - 1
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 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.
Comment
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](resource.html#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](resource.html#meta) element to indicate where the current master source of the resource can be found.
Requirements
Allows the plan definition to be referenced by a single globally unique identifier.
Constraint
cnl-1 [warning]
URL should not contain | or # - these characters make processing canonical references problematic
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.identifier
Id
PlanDefinition.identifier
Type
Cardinality
0 - *
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.
Comment
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.
Requirements
Allows externally provided and/or usable business identifiers to be easily associated with the module.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Binding
Strength
required
Description
Identifies the purpose for this identifier, if known .
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.identifier.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Binding
Strength
extensible
Description
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.identifier.Identifier.type.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.identifier.Identifier.type.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.identifier.Identifier.type.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.identifier.Identifier.type.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
PlanDefinition.identifier.Identifier.type.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
PlanDefinition.identifier.Identifier.type.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Comment
Identifier.system is always case sensitive.
Requirements
There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.identifier.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ident-1
Path
PlanDefinition.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.identifier.Identifier.period.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
PlanDefinition.identifier.Identifier.period.Period.end
Id
Period.end
Type
Cardinality
0 - 1
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.
Comment
The end 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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
PlanDefinition.identifier.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.identifier.Identifier.assigner.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
Definition
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Comment
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
PlanDefinition.identifier.Identifier.assigner.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.identifier.Identifier.assigner.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Comment
When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.
When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference
Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
PlanDefinition.identifier.Identifier.assigner.Reference.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Binding
Strength
required
Description
Identifies the purpose for this identifier, if known .
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.identifier.Identifier.assigner.Reference.identifier.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Binding
Strength
extensible
Description
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.identifier.Identifier.assigner.Reference.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Comment
Identifier.system is always case sensitive.
Requirements
There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.identifier.Identifier.assigner.Reference.identifier.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ident-1
Path
PlanDefinition.identifier.Identifier.assigner.Reference.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.identifier.Identifier.assigner.Reference.identifier.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.identifier.Identifier.assigner.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
PlanDefinition.version
Id
PlanDefinition.version
Type
Cardinality
0 - 1
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.
Comment
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]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.versionAlgorithm[x]
Id
PlanDefinition.versionAlgorithm[x]
Type
Cardinality
0 - 1
Definition
Indicates the mechanism used to compare versions to determine which is more current.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.name
Id
PlanDefinition.name
Type
Cardinality
0 - 1
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.
Comment
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.
Requirements
Support human navigation and code generation.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cnl-0
Path
PlanDefinition.title
Id
PlanDefinition.title
Type
Cardinality
0 - 1
Definition
A short, descriptive, user-friendly title for the plan definition.
Comment
This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.subtitle
Id
PlanDefinition.subtitle
Type
Cardinality
0 - 1
Definition
An explanatory or alternate title for the plan definition giving additional information about its content.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.type
Id
PlanDefinition.type
Type
Cardinality
0 - 1
Definition
A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition.
Comment
Binding
Strength
extensible
Description
The type of PlanDefinition.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.type.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.type.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.type.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.type.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
PlanDefinition.type.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
PlanDefinition.type.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.status
Id
PlanDefinition.status
Type
Cardinality
1 - 1
Definition
The status of this plan definition. Enables tracking the life-cycle of the content.
Comment
Allows filtering of plan definitions that are appropriate for use versus not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).
Binding
Strength
required
Description
The lifecycle status of an artifact.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.experimental
Id
PlanDefinition.experimental
Type
Cardinality
0 - 1
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.
Comment
Allows filtering of plan definitions that are appropriate for use versus not.
Requirements
Enables experimental content to be developed following the same lifecycle that would be used for a production-level plan definition.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.subject[x]
Id
PlanDefinition.subject[x]
Type
Cardinality
0 - 1
Definition
A code, group definition, or canonical reference that describes or identifies the intended subject of the plan definition. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.
Comment
Note that the choice of canonical for the subject element was introduced in R4B to support pharmaceutical quality use cases. To ensure as much backwards-compatibility as possible, it is recommended to only use the new canonical type with these use cases.
Binding
Strength
extensible
Description
The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.subject[x].CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.subject[x].CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.subject[x].CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.subject[x].CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
PlanDefinition.subject[x].CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
PlanDefinition.subject[x].CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.date
Id
PlanDefinition.date
Type
Cardinality
0 - 1
Definition
The date (and optionally time) when the plan definition was last significantly changed. 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.
Comment
The date is often not tracked until the resource is published, but may be present on draft content. 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.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.publisher
Id
PlanDefinition.publisher
Type
Cardinality
0 - 1
Definition
The name of the organization or individual responsible for the release and ongoing maintenance of the plan definition.
Comment
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.
Requirements
Helps establish the "authority/credibility" of the plan definition. May also allow for contact.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.contact
Id
PlanDefinition.contact
Type
Cardinality
0 - *
Definition
Contact details to assist a user in finding and communicating with the publisher.
Comment
May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.contact.ContactDetail.name
Id
ContactDetail.name
Type
Cardinality
0 - 1
Definition
The name of an individual to contact.
Comment
If there is no named individual, the telecom information is for the organization as a whole.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.contact.ContactDetail.telecom
Id
ContactDetail.telecom
Type
Cardinality
0 - *
Definition
The contact details for the individual (if a name was provided) or the organization.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.contact.ContactDetail.telecom.ContactPoint.system
Id
ContactPoint.system
Type
Cardinality
0 - 1
Definition
Telecommunications form for contact point - what communications system is required to make use of the contact.
Comment
Binding
Strength
required
Description
Telecommunications form for contact point.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cpt-2
Path
PlanDefinition.contact.ContactDetail.telecom.ContactPoint.value
Id
ContactPoint.value
Type
Cardinality
0 - 1
Definition
The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
Comment
Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
Requirements
Need to support legacy numbers that are not in a tightly controlled format.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cpt-2
Path
PlanDefinition.contact.ContactDetail.telecom.ContactPoint.use
Id
ContactPoint.use
Type
Cardinality
0 - 1
Definition
Identifies the purpose for the contact point.
Comment
Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
Requirements
Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
Binding
Strength
required
Description
Use of contact point.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.contact.ContactDetail.telecom.ContactPoint.rank
Id
ContactPoint.rank
Type
Cardinality
0 - 1
Definition
Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
Comment
Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
Ranks need not be unique. E.g. it's possible to have multiple contacts with rank=1. If the ranks have different systems or uses, this would be interpreted to mean "X is my most preferred phone number, Y is my most preferred email address" or "X is my preferred home email and Y is my preferred work email". If the system and use for equally-ranked contacts are the same, then the level of preference is equivalent for both repetitions.
Ranks need not be sequential and not all repetitions must have a rank. For example, it's possible to have 4 contacts with ranks of 2, 5 and two with no rank specified. That would be interpreted to mean the first is preferred over the second and no preference stated for the remaining contacts.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.contact.ContactDetail.telecom.ContactPoint.period
Id
ContactPoint.period
Type
Cardinality
0 - 1
Definition
Time period when the contact point was/is in use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.contact.ContactDetail.telecom.ContactPoint.period.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
PlanDefinition.contact.ContactDetail.telecom.ContactPoint.period.Period.end
Id
Period.end
Type
Cardinality
0 - 1
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.
Comment
The end 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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
PlanDefinition.description
Id
PlanDefinition.description
Type
Cardinality
0 - 1
Definition
A free text natural language description of the plan definition from a consumer's perspective.
Comment
This description can be used to capture details such as 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).
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.useContext
Id
PlanDefinition.useContext
Type
Cardinality
0 - *
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.
Comment
When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
Requirements
Assist in searching for appropriate content.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.useContext.UsageContext.code
Id
UsageContext.code
Type
Cardinality
1 - 1
Definition
A code that identifies the type of context being specified by this usage context.
Comment
Binding
Strength
extensible
Description
A code that specifies a type of context being specified by a usage context.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.useContext.UsageContext.code.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.useContext.UsageContext.code.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.useContext.UsageContext.code.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
PlanDefinition.useContext.UsageContext.code.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
PlanDefinition.useContext.UsageContext.code.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.useContext.UsageContext.value[x]
Id
UsageContext.value[x]
Type
Cardinality
1 - 1
Definition
A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.
Comment
Binding
Strength
example
Description
A code that defines the specific value for the context being specified.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.useContext.UsageContext.value[x].CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.useContext.UsageContext.value[x].CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.useContext.UsageContext.value[x].CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.useContext.UsageContext.value[x].CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
PlanDefinition.useContext.UsageContext.value[x].CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
PlanDefinition.useContext.UsageContext.value[x].CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.jurisdiction
Id
PlanDefinition.jurisdiction
Type
Cardinality
0 - *
Definition
A legal or geographic region in which the plan definition is intended to be used.
Comment
It may be possible for the plan definition to be used in jurisdictions other than those for which it was originally designed or intended.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)
Binding
Strength
extensible
Description
Countries and regions within which this artifact is targeted for use.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.jurisdiction.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.jurisdiction.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.jurisdiction.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.jurisdiction.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
PlanDefinition.jurisdiction.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
PlanDefinition.jurisdiction.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.purpose
Id
PlanDefinition.purpose
Type
Cardinality
0 - 1
Definition
Explanation of why this plan definition is needed and why it has been designed as it has.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.usage
Id
PlanDefinition.usage
Type
Cardinality
0 - 1
Definition
A detailed description of how the plan definition is used from a clinical perspective.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.copyright
Id
PlanDefinition.copyright
Type
Cardinality
0 - 1
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.
Comment
The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.
Requirements
Consumers must be able to determine any legal restrictions on the use of the plan definition and/or its content.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.copyrightLabel
Id
PlanDefinition.copyrightLabel
Type
Cardinality
0 - 1
Definition
A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
Comment
The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.
Requirements
Defines the content expected to be rendered in all representations of the artifact.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.approvalDate
Id
PlanDefinition.approvalDate
Type
Cardinality
0 - 1
Definition
The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
Comment
The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.lastReviewDate
Id
PlanDefinition.lastReviewDate
Type
Cardinality
0 - 1
Definition
The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
Comment
If specified, this date follows the original approval date.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.effectivePeriod
Id
PlanDefinition.effectivePeriod
Type
Cardinality
0 - 1
Definition
The period during which the plan definition content was or is planned to be in active use.
Comment
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 plan definition intended to be used for the year 2016 might be published in 2015.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.effectivePeriod.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
PlanDefinition.effectivePeriod.Period.end
Id
Period.end
Type
Cardinality
0 - 1
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.
Comment
The end 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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
PlanDefinition.topic
Id
PlanDefinition.topic
Type
Cardinality
0 - *
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.
Comment
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic)
Requirements
Repositories must be able to determine how to categorize the plan definition so that it can be found by topical searches.
Binding
Strength
example
Description
High-level categorization of the definition, used for searching, sorting, and filtering.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.topic.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.topic.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.topic.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.topic.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
PlanDefinition.topic.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
PlanDefinition.topic.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.author
Id
PlanDefinition.author
Type
Cardinality
0 - *
Definition
An individiual or organization primarily involved in the creation and maintenance of the content.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.author.ContactDetail.name
Id
ContactDetail.name
Type
Cardinality
0 - 1
Definition
The name of an individual to contact.
Comment
If there is no named individual, the telecom information is for the organization as a whole.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.author.ContactDetail.telecom
Id
ContactDetail.telecom
Type
Cardinality
0 - *
Definition
The contact details for the individual (if a name was provided) or the organization.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.author.ContactDetail.telecom.ContactPoint.system
Id
ContactPoint.system
Type
Cardinality
0 - 1
Definition
Telecommunications form for contact point - what communications system is required to make use of the contact.
Comment
Binding
Strength
required
Description
Telecommunications form for contact point.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cpt-2
Path
PlanDefinition.author.ContactDetail.telecom.ContactPoint.value
Id
ContactPoint.value
Type
Cardinality
0 - 1
Definition
The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
Comment
Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
Requirements
Need to support legacy numbers that are not in a tightly controlled format.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cpt-2
Path
PlanDefinition.author.ContactDetail.telecom.ContactPoint.use
Id
ContactPoint.use
Type
Cardinality
0 - 1
Definition
Identifies the purpose for the contact point.
Comment
Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
Requirements
Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
Binding
Strength
required
Description
Use of contact point.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.author.ContactDetail.telecom.ContactPoint.rank
Id
ContactPoint.rank
Type
Cardinality
0 - 1
Definition
Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
Comment
Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
Ranks need not be unique. E.g. it's possible to have multiple contacts with rank=1. If the ranks have different systems or uses, this would be interpreted to mean "X is my most preferred phone number, Y is my most preferred email address" or "X is my preferred home email and Y is my preferred work email". If the system and use for equally-ranked contacts are the same, then the level of preference is equivalent for both repetitions.
Ranks need not be sequential and not all repetitions must have a rank. For example, it's possible to have 4 contacts with ranks of 2, 5 and two with no rank specified. That would be interpreted to mean the first is preferred over the second and no preference stated for the remaining contacts.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.author.ContactDetail.telecom.ContactPoint.period
Id
ContactPoint.period
Type
Cardinality
0 - 1
Definition
Time period when the contact point was/is in use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.author.ContactDetail.telecom.ContactPoint.period.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
PlanDefinition.author.ContactDetail.telecom.ContactPoint.period.Period.end
Id
Period.end
Type
Cardinality
0 - 1
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.
Comment
The end 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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
PlanDefinition.editor
Id
PlanDefinition.editor
Type
Cardinality
0 - *
Definition
An individual or organization primarily responsible for internal coherence of the content.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.editor.ContactDetail.name
Id
ContactDetail.name
Type
Cardinality
0 - 1
Definition
The name of an individual to contact.
Comment
If there is no named individual, the telecom information is for the organization as a whole.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.editor.ContactDetail.telecom
Id
ContactDetail.telecom
Type
Cardinality
0 - *
Definition
The contact details for the individual (if a name was provided) or the organization.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.editor.ContactDetail.telecom.ContactPoint.system
Id
ContactPoint.system
Type
Cardinality
0 - 1
Definition
Telecommunications form for contact point - what communications system is required to make use of the contact.
Comment
Binding
Strength
required
Description
Telecommunications form for contact point.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cpt-2
Path
PlanDefinition.editor.ContactDetail.telecom.ContactPoint.value
Id
ContactPoint.value
Type
Cardinality
0 - 1
Definition
The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
Comment
Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
Requirements
Need to support legacy numbers that are not in a tightly controlled format.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cpt-2
Path
PlanDefinition.editor.ContactDetail.telecom.ContactPoint.use
Id
ContactPoint.use
Type
Cardinality
0 - 1
Definition
Identifies the purpose for the contact point.
Comment
Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
Requirements
Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
Binding
Strength
required
Description
Use of contact point.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.editor.ContactDetail.telecom.ContactPoint.rank
Id
ContactPoint.rank
Type
Cardinality
0 - 1
Definition
Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
Comment
Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
Ranks need not be unique. E.g. it's possible to have multiple contacts with rank=1. If the ranks have different systems or uses, this would be interpreted to mean "X is my most preferred phone number, Y is my most preferred email address" or "X is my preferred home email and Y is my preferred work email". If the system and use for equally-ranked contacts are the same, then the level of preference is equivalent for both repetitions.
Ranks need not be sequential and not all repetitions must have a rank. For example, it's possible to have 4 contacts with ranks of 2, 5 and two with no rank specified. That would be interpreted to mean the first is preferred over the second and no preference stated for the remaining contacts.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.editor.ContactDetail.telecom.ContactPoint.period
Id
ContactPoint.period
Type
Cardinality
0 - 1
Definition
Time period when the contact point was/is in use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.editor.ContactDetail.telecom.ContactPoint.period.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
PlanDefinition.editor.ContactDetail.telecom.ContactPoint.period.Period.end
Id
Period.end
Type
Cardinality
0 - 1
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.
Comment
The end 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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
PlanDefinition.reviewer
Id
PlanDefinition.reviewer
Type
Cardinality
0 - *
Definition
An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content.
Comment
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.reviewer.ContactDetail.name
Id
ContactDetail.name
Type
Cardinality
0 - 1
Definition
The name of an individual to contact.
Comment
If there is no named individual, the telecom information is for the organization as a whole.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.reviewer.ContactDetail.telecom
Id
ContactDetail.telecom
Type
Cardinality
0 - *
Definition
The contact details for the individual (if a name was provided) or the organization.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.reviewer.ContactDetail.telecom.ContactPoint.system
Id
ContactPoint.system
Type
Cardinality
0 - 1
Definition
Telecommunications form for contact point - what communications system is required to make use of the contact.
Comment
Binding
Strength
required
Description
Telecommunications form for contact point.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cpt-2
Path
PlanDefinition.reviewer.ContactDetail.telecom.ContactPoint.value
Id
ContactPoint.value
Type
Cardinality
0 - 1
Definition
The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
Comment
Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
Requirements
Need to support legacy numbers that are not in a tightly controlled format.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cpt-2
Path
PlanDefinition.reviewer.ContactDetail.telecom.ContactPoint.use
Id
ContactPoint.use
Type
Cardinality
0 - 1
Definition
Identifies the purpose for the contact point.
Comment
Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
Requirements
Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
Binding
Strength
required
Description
Use of contact point.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.reviewer.ContactDetail.telecom.ContactPoint.rank
Id
ContactPoint.rank
Type
Cardinality
0 - 1
Definition
Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
Comment
Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
Ranks need not be unique. E.g. it's possible to have multiple contacts with rank=1. If the ranks have different systems or uses, this would be interpreted to mean "X is my most preferred phone number, Y is my most preferred email address" or "X is my preferred home email and Y is my preferred work email". If the system and use for equally-ranked contacts are the same, then the level of preference is equivalent for both repetitions.
Ranks need not be sequential and not all repetitions must have a rank. For example, it's possible to have 4 contacts with ranks of 2, 5 and two with no rank specified. That would be interpreted to mean the first is preferred over the second and no preference stated for the remaining contacts.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.reviewer.ContactDetail.telecom.ContactPoint.period
Id
ContactPoint.period
Type
Cardinality
0 - 1
Definition
Time period when the contact point was/is in use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.reviewer.ContactDetail.telecom.ContactPoint.period.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
PlanDefinition.reviewer.ContactDetail.telecom.ContactPoint.period.Period.end
Id
Period.end
Type
Cardinality
0 - 1
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.
Comment
The end 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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
PlanDefinition.endorser
Id
PlanDefinition.endorser
Type
Cardinality
0 - *
Definition
An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting.
Comment
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.endorser.ContactDetail.name
Id
ContactDetail.name
Type
Cardinality
0 - 1
Definition
The name of an individual to contact.
Comment
If there is no named individual, the telecom information is for the organization as a whole.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.endorser.ContactDetail.telecom
Id
ContactDetail.telecom
Type
Cardinality
0 - *
Definition
The contact details for the individual (if a name was provided) or the organization.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.endorser.ContactDetail.telecom.ContactPoint.system
Id
ContactPoint.system
Type
Cardinality
0 - 1
Definition
Telecommunications form for contact point - what communications system is required to make use of the contact.
Comment
Binding
Strength
required
Description
Telecommunications form for contact point.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cpt-2
Path
PlanDefinition.endorser.ContactDetail.telecom.ContactPoint.value
Id
ContactPoint.value
Type
Cardinality
0 - 1
Definition
The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
Comment
Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
Requirements
Need to support legacy numbers that are not in a tightly controlled format.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cpt-2
Path
PlanDefinition.endorser.ContactDetail.telecom.ContactPoint.use
Id
ContactPoint.use
Type
Cardinality
0 - 1
Definition
Identifies the purpose for the contact point.
Comment
Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
Requirements
Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
Binding
Strength
required
Description
Use of contact point.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.endorser.ContactDetail.telecom.ContactPoint.rank
Id
ContactPoint.rank
Type
Cardinality
0 - 1
Definition
Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
Comment
Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
Ranks need not be unique. E.g. it's possible to have multiple contacts with rank=1. If the ranks have different systems or uses, this would be interpreted to mean "X is my most preferred phone number, Y is my most preferred email address" or "X is my preferred home email and Y is my preferred work email". If the system and use for equally-ranked contacts are the same, then the level of preference is equivalent for both repetitions.
Ranks need not be sequential and not all repetitions must have a rank. For example, it's possible to have 4 contacts with ranks of 2, 5 and two with no rank specified. That would be interpreted to mean the first is preferred over the second and no preference stated for the remaining contacts.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.endorser.ContactDetail.telecom.ContactPoint.period
Id
ContactPoint.period
Type
Cardinality
0 - 1
Definition
Time period when the contact point was/is in use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.endorser.ContactDetail.telecom.ContactPoint.period.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
PlanDefinition.endorser.ContactDetail.telecom.ContactPoint.period.Period.end
Id
Period.end
Type
Cardinality
0 - 1
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.
Comment
The end 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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
PlanDefinition.relatedArtifact
Id
PlanDefinition.relatedArtifact
Type
Cardinality
0 - *
Definition
Related artifacts such as additional documentation, justification, or bibliographic references.
Comment
Each related artifact is either an attachment, or a reference to another resource, but not both.
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
type
documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
Path
PlanDefinition.relatedArtifact.RelatedArtifact.type
Id
RelatedArtifact.type
Type
Cardinality
1 - 1
Definition
The type of relationship to the related artifact.
Comment
The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of "new points to old" and "many points to one", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet.
Binding
Strength
required
Description
The type of relationship to the related artifact.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.relatedArtifact.RelatedArtifact.classifier
Id
RelatedArtifact.classifier
Type
Cardinality
0 - *
Definition
Provides additional classifiers of the related artifact.
Comment
Binding
Strength
example
Description
Additional classifiers for the related artifact.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.relatedArtifact.RelatedArtifact.classifier.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.relatedArtifact.RelatedArtifact.classifier.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.relatedArtifact.RelatedArtifact.classifier.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.relatedArtifact.RelatedArtifact.classifier.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
PlanDefinition.relatedArtifact.RelatedArtifact.classifier.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
PlanDefinition.relatedArtifact.RelatedArtifact.classifier.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.relatedArtifact.RelatedArtifact.label
Id
RelatedArtifact.label
Type
Cardinality
0 - 1
Definition
A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.relatedArtifact.RelatedArtifact.display
Id
RelatedArtifact.display
Type
Cardinality
0 - 1
Definition
A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.relatedArtifact.RelatedArtifact.citation
Id
RelatedArtifact.citation
Type
Cardinality
0 - 1
Definition
A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.
Comment
Additional structured information about citations should be captured as extensions.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.relatedArtifact.RelatedArtifact.document
Id
RelatedArtifact.document
Type
Cardinality
0 - 1
Definition
The document being referenced, represented as an attachment. This is exclusive with the resource element.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.relatedArtifact.RelatedArtifact.document.Attachment.contentType
Id
Attachment.contentType
Type
Cardinality
0 - 1
Definition
Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.
Comment
Requirements
Processors of the data need to be able to know how to interpret the data.
Binding
Strength
required
Description
BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
att-1
Path
PlanDefinition.relatedArtifact.RelatedArtifact.document.Attachment.data
Id
Attachment.data
Type
Cardinality
0 - 1
Definition
The actual data of the attachment - a sequence of bytes, base64 encoded.
Comment
The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.
Requirements
The data needs to able to be transmitted inline.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
att-1
Path
PlanDefinition.relatedArtifact.RelatedArtifact.document.Attachment.url
Id
Attachment.url
Type
Cardinality
0 - 1
Definition
A location where the data can be accessed.
Comment
If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.
Requirements
The data needs to be transmitted by reference.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.relatedArtifact.RelatedArtifact.document.Attachment.size
Id
Attachment.size
Type
Cardinality
0 - 1
Definition
The number of bytes of data that make up this attachment (before base64 encoding, if that is done).
Comment
The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.
Requirements
Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.relatedArtifact.RelatedArtifact.document.Attachment.hash
Id
Attachment.hash
Type
Cardinality
0 - 1
Definition
The calculated hash of the data using SHA-1. Represented using base64.
Comment
The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see [Provenance.signature](provenance-definitions.html#Provenance.signature) for mechanism to protect a resource with a digital signature.
Requirements
Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version).
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.relatedArtifact.RelatedArtifact.document.Attachment.title
Id
Attachment.title
Type
Cardinality
0 - 1
Definition
A label or set of text to display in place of the data.
Comment
May sometimes be derived from the source filename.
Requirements
Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.relatedArtifact.RelatedArtifact.document.Attachment.creation
Id
Attachment.creation
Type
Cardinality
0 - 1
Definition
The date that the attachment was first created.
Comment
Requirements
This is often tracked as an integrity issue for use of the attachment.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.relatedArtifact.RelatedArtifact.document.Attachment.height
Id
Attachment.height
Type
Cardinality
0 - 1
Definition
Height of the image in pixels (photo/video).
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.relatedArtifact.RelatedArtifact.document.Attachment.width
Id
Attachment.width
Type
Cardinality
0 - 1
Definition
Width of the image in pixels (photo/video).
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.relatedArtifact.RelatedArtifact.document.Attachment.frames
Id
Attachment.frames
Type
Cardinality
0 - 1
Definition
The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.
Comment
if the number of frames is not supplied, the value may be unknown. Applications should not assume that there is only one frame unless it is explicitly stated.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.relatedArtifact.RelatedArtifact.document.Attachment.duration
Id
Attachment.duration
Type
Cardinality
0 - 1
Definition
The duration of the recording in seconds - for audio and video.
Comment
The duration might differ from occurrencePeriod if recording was paused.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.relatedArtifact.RelatedArtifact.document.Attachment.pages
Id
Attachment.pages
Type
Cardinality
0 - 1
Definition
The number of pages when printed.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.relatedArtifact.RelatedArtifact.resource
Id
RelatedArtifact.resource
Type
Cardinality
0 - 1
Definition
The related artifact, such as a library, value set, profile, or other knowledge resource.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.relatedArtifact.RelatedArtifact.resourceReference
Id
RelatedArtifact.resourceReference
Type
Cardinality
0 - 1
Definition
The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource.
Comment
If both resource and resourceReference are present, they SHOULD be consistent and reference the same resource. Although relatedArtifact is intended to support references to definitional resources, there are cases where non-definitional resources can be definitional (such as Location where the kind is mode). Related artifacts SHOULD be used to reference definitional resources, and profiles SHOULD be used to make that explicit for particular use cases.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.relatedArtifact.RelatedArtifact.resourceReference.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
Definition
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Comment
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
PlanDefinition.relatedArtifact.RelatedArtifact.resourceReference.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.relatedArtifact.RelatedArtifact.resourceReference.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Comment
When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.
When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference
Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
PlanDefinition.relatedArtifact.RelatedArtifact.resourceReference.Reference.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Binding
Strength
required
Description
Identifies the purpose for this identifier, if known .
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.relatedArtifact.RelatedArtifact.resourceReference.Reference.identifier.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Binding
Strength
extensible
Description
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.relatedArtifact.RelatedArtifact.resourceReference.Reference.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Comment
Identifier.system is always case sensitive.
Requirements
There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.relatedArtifact.RelatedArtifact.resourceReference.Reference.identifier.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ident-1
Path
PlanDefinition.relatedArtifact.RelatedArtifact.resourceReference.Reference.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.relatedArtifact.RelatedArtifact.resourceReference.Reference.identifier.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.relatedArtifact.RelatedArtifact.resourceReference.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
PlanDefinition.relatedArtifact.RelatedArtifact.publicationStatus
Id
RelatedArtifact.publicationStatus
Type
Cardinality
0 - 1
Definition
The publication status of the artifact being referred to.
Comment
Binding
Strength
required
Description
Publication status of an artifact being referred to.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.relatedArtifact.RelatedArtifact.publicationDate
Id
RelatedArtifact.publicationDate
Type
Cardinality
0 - 1
Definition
The date of publication of the artifact being referred to.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.library
Id
PlanDefinition.library
Type
Cardinality
0 - *
Definition
A reference to a Library resource containing any formal logic used by the plan definition.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal
Id
PlanDefinition.goal
Type
Cardinality
0 - *
Definition
A goal describes an expected outcome that activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, meeting the acceptance criteria for a test as specified by a quality specification, etc.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
pld-3
Path
PlanDefinition.goal.category
Id
PlanDefinition.goal.category
Type
Cardinality
0 - 1
Definition
Indicates a category the goal falls within.
Comment
Binding
Strength
example
Description
Example codes for grouping goals for filtering or presentation.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.category.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.category.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.category.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.category.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
PlanDefinition.goal.category.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
PlanDefinition.goal.category.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.description
Id
PlanDefinition.goal.description
Type
Cardinality
1 - 1
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".
Comment
If no code is available, use CodeableConcept.text.
Binding
Strength
example
Description
Describes goals that can be achieved.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.description.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.description.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.description.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.description.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
PlanDefinition.goal.description.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
PlanDefinition.goal.description.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.priority
Id
PlanDefinition.goal.priority
Type
Cardinality
0 - 1
Definition
Identifies the expected level of importance associated with reaching/sustaining the defined goal.
Comment
Binding
Strength
preferred
Description
Indicates the level of importance associated with reaching or sustaining a goal.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.priority.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.priority.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.priority.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.priority.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
PlanDefinition.goal.priority.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
PlanDefinition.goal.priority.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.start
Id
PlanDefinition.goal.start
Type
Cardinality
0 - 1
Definition
The event after which the goal should begin being pursued.
Comment
Binding
Strength
example
Description
Identifies the types of events that might trigger the start of a goal.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.start.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.start.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.start.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.start.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
PlanDefinition.goal.start.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
PlanDefinition.goal.start.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.addresses
Id
PlanDefinition.goal.addresses
Type
Cardinality
0 - *
Definition
Identifies problems, conditions, issues, or concerns the goal is intended to address.
Comment
Binding
Strength
example
Description
Identifies problems, conditions, issues, or concerns that goals may address.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.addresses.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.addresses.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.addresses.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.addresses.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
PlanDefinition.goal.addresses.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
PlanDefinition.goal.addresses.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.documentation
Id
PlanDefinition.goal.documentation
Type
Cardinality
0 - *
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.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
type
documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
Path
PlanDefinition.goal.documentation.RelatedArtifact.type
Id
RelatedArtifact.type
Type
Cardinality
1 - 1
Definition
The type of relationship to the related artifact.
Comment
The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of "new points to old" and "many points to one", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet.
Binding
Strength
required
Description
The type of relationship to the related artifact.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.documentation.RelatedArtifact.classifier
Id
RelatedArtifact.classifier
Type
Cardinality
0 - *
Definition
Provides additional classifiers of the related artifact.
Comment
Binding
Strength
example
Description
Additional classifiers for the related artifact.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.documentation.RelatedArtifact.classifier.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.documentation.RelatedArtifact.label
Id
RelatedArtifact.label
Type
Cardinality
0 - 1
Definition
A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.documentation.RelatedArtifact.display
Id
RelatedArtifact.display
Type
Cardinality
0 - 1
Definition
A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.documentation.RelatedArtifact.citation
Id
RelatedArtifact.citation
Type
Cardinality
0 - 1
Definition
A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.
Comment
Additional structured information about citations should be captured as extensions.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.documentation.RelatedArtifact.document
Id
RelatedArtifact.document
Type
Cardinality
0 - 1
Definition
The document being referenced, represented as an attachment. This is exclusive with the resource element.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.documentation.RelatedArtifact.document.Attachment.contentType
Id
Attachment.contentType
Type
Cardinality
0 - 1
Definition
Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.
Comment
Requirements
Processors of the data need to be able to know how to interpret the data.
Binding
Strength
required
Description
BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
att-1
Path
PlanDefinition.goal.documentation.RelatedArtifact.document.Attachment.data
Id
Attachment.data
Type
Cardinality
0 - 1
Definition
The actual data of the attachment - a sequence of bytes, base64 encoded.
Comment
The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.
Requirements
The data needs to able to be transmitted inline.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
att-1
Path
PlanDefinition.goal.documentation.RelatedArtifact.document.Attachment.url
Id
Attachment.url
Type
Cardinality
0 - 1
Definition
A location where the data can be accessed.
Comment
If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.
Requirements
The data needs to be transmitted by reference.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.documentation.RelatedArtifact.document.Attachment.size
Id
Attachment.size
Type
Cardinality
0 - 1
Definition
The number of bytes of data that make up this attachment (before base64 encoding, if that is done).
Comment
The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.
Requirements
Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.documentation.RelatedArtifact.document.Attachment.hash
Id
Attachment.hash
Type
Cardinality
0 - 1
Definition
The calculated hash of the data using SHA-1. Represented using base64.
Comment
The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see [Provenance.signature](provenance-definitions.html#Provenance.signature) for mechanism to protect a resource with a digital signature.
Requirements
Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version).
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.documentation.RelatedArtifact.document.Attachment.title
Id
Attachment.title
Type
Cardinality
0 - 1
Definition
A label or set of text to display in place of the data.
Comment
May sometimes be derived from the source filename.
Requirements
Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.documentation.RelatedArtifact.document.Attachment.creation
Id
Attachment.creation
Type
Cardinality
0 - 1
Definition
The date that the attachment was first created.
Comment
Requirements
This is often tracked as an integrity issue for use of the attachment.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.documentation.RelatedArtifact.document.Attachment.height
Id
Attachment.height
Type
Cardinality
0 - 1
Definition
Height of the image in pixels (photo/video).
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.documentation.RelatedArtifact.document.Attachment.width
Id
Attachment.width
Type
Cardinality
0 - 1
Definition
Width of the image in pixels (photo/video).
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.documentation.RelatedArtifact.document.Attachment.frames
Id
Attachment.frames
Type
Cardinality
0 - 1
Definition
The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.
Comment
if the number of frames is not supplied, the value may be unknown. Applications should not assume that there is only one frame unless it is explicitly stated.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.documentation.RelatedArtifact.document.Attachment.duration
Id
Attachment.duration
Type
Cardinality
0 - 1
Definition
The duration of the recording in seconds - for audio and video.
Comment
The duration might differ from occurrencePeriod if recording was paused.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.documentation.RelatedArtifact.document.Attachment.pages
Id
Attachment.pages
Type
Cardinality
0 - 1
Definition
The number of pages when printed.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.documentation.RelatedArtifact.resource
Id
RelatedArtifact.resource
Type
Cardinality
0 - 1
Definition
The related artifact, such as a library, value set, profile, or other knowledge resource.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.documentation.RelatedArtifact.resourceReference
Id
RelatedArtifact.resourceReference
Type
Cardinality
0 - 1
Definition
The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource.
Comment
If both resource and resourceReference are present, they SHOULD be consistent and reference the same resource. Although relatedArtifact is intended to support references to definitional resources, there are cases where non-definitional resources can be definitional (such as Location where the kind is mode). Related artifacts SHOULD be used to reference definitional resources, and profiles SHOULD be used to make that explicit for particular use cases.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.documentation.RelatedArtifact.resourceReference.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
Definition
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Comment
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
PlanDefinition.goal.documentation.RelatedArtifact.resourceReference.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.documentation.RelatedArtifact.resourceReference.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Comment
When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.
When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference
Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
PlanDefinition.goal.documentation.RelatedArtifact.resourceReference.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
PlanDefinition.goal.documentation.RelatedArtifact.publicationStatus
Id
RelatedArtifact.publicationStatus
Type
Cardinality
0 - 1
Definition
The publication status of the artifact being referred to.
Comment
Binding
Strength
required
Description
Publication status of an artifact being referred to.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.documentation.RelatedArtifact.publicationDate
Id
RelatedArtifact.publicationDate
Type
Cardinality
0 - 1
Definition
The date of publication of the artifact being referred to.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.target
Id
PlanDefinition.goal.target
Type
Cardinality
0 - *
Definition
Indicates what should be done and within what timeframe.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.target.measure
Id
PlanDefinition.goal.target.measure
Type
Cardinality
0 - 1
Definition
The parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.
Comment
Binding
Strength
example
Description
Identifies types of parameters that can be tracked to determine goal achievement.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.target.measure.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.target.detail[x]
Id
PlanDefinition.goal.target.detail[x]
Type
Cardinality
0 - 1
Definition
The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. 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.
Comment
A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the goal.target.measure defines a coded value.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.target.detail[x].Quantity.value
Id
Quantity.value
Type
Cardinality
0 - 1
Definition
The value of the measured amount. The value includes an implicit precision in the presentation of the value.
Comment
The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).
Requirements
Precision is handled implicitly in almost all cases of measurement.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.target.detail[x].Quantity.comparator
Id
Quantity.comparator
Type
Cardinality
0 - 1
Definition
How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.
Comment
Requirements
Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.
Binding
Strength
required
Description
How the Quantity should be understood and represented.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.target.detail[x].Quantity.unit
Id
Quantity.unit
Type
Cardinality
0 - 1
Definition
A human-readable form of the unit.
Comment
Requirements
There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.target.detail[x].Quantity.system
Id
Quantity.system
Type
Cardinality
0 - 1
Definition
The identification of the system that provides the coded form of the unit.
Comment
Requirements
Need to know the system that defines the coded form of the unit.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
qty-3
Path
PlanDefinition.goal.target.detail[x].Quantity.code
Id
Quantity.code
Type
Cardinality
0 - 1
Definition
A computer processable form of the unit in some unit representation system.
Comment
The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.
Requirements
Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
qty-3
Path
PlanDefinition.goal.target.due
Id
PlanDefinition.goal.target.due
Type
Cardinality
0 - 1
Definition
Indicates the timeframe after the start of the goal in which the goal should be met.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.target.due.Duration.value
Id
Duration.value
Type
Cardinality
0 - 1
Definition
The value of the measured amount. The value includes an implicit precision in the presentation of the value.
Comment
The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).
Requirements
Precision is handled implicitly in almost all cases of measurement.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.target.due.Duration.comparator
Id
Duration.comparator
Type
Cardinality
0 - 1
Definition
How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.
Comment
Requirements
Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.
Binding
Strength
required
Description
How the Quantity should be understood and represented.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.target.due.Duration.unit
Id
Duration.unit
Type
Cardinality
0 - 1
Definition
A human-readable form of the unit.
Comment
Requirements
There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.goal.target.due.Duration.system
Id
Duration.system
Type
Cardinality
0 - 1
Definition
The identification of the system that provides the coded form of the unit.
Comment
Requirements
Need to know the system that defines the coded form of the unit.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
qty-3
Path
PlanDefinition.goal.target.due.Duration.code
Id
Duration.code
Type
Cardinality
0 - 1
Definition
A computer processable form of the unit in some unit representation system.
Comment
The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.
Requirements
Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
qty-3
Path
PlanDefinition.actor
Id
PlanDefinition.actor
Type
Cardinality
0 - *
Definition
Actors represent the individuals or groups involved in the execution of the defined set of activities.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.actor.title
Id
PlanDefinition.actor.title
Type
Cardinality
0 - 1
Definition
A descriptive label for the actor.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.actor.description
Id
PlanDefinition.actor.description
Type
Cardinality
0 - 1
Definition
A description of how the actor fits into the overall actions of the plan definition.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.actor.option
Id
PlanDefinition.actor.option
Type
Cardinality
1 - *
Definition
The characteristics of the candidates that could serve as the actor.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
type
careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Path
PlanDefinition.actor.option.type
Id
PlanDefinition.actor.option.type
Type
Cardinality
0 - 1
Definition
The type of participant in the action.
Comment
Binding
Strength
required
Description
The type of participant in the activity.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.actor.option.typeCanonical
Id
PlanDefinition.actor.option.typeCanonical
Type
Cardinality
0 - 1
Definition
The type of participant in the action.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.actor.option.typeReference
Id
PlanDefinition.actor.option.typeReference
Type
Cardinality
0 - 1
Definition
The type of participant in the action.
Comment
When this element is a reference, it SHOULD be a reference to a definitional resource (for example, a location type, rather than a specific location).
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.actor.option.typeReference.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
Definition
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Comment
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
PlanDefinition.actor.option.typeReference.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.actor.option.typeReference.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Comment
When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.
When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference
Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
PlanDefinition.actor.option.typeReference.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
PlanDefinition.actor.option.role
Id
PlanDefinition.actor.option.role
Type
Cardinality
0 - 1
Definition
The role the participant should play in performing the described action.
Comment
Binding
Strength
example
Description
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.actor.option.role.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action
Id
PlanDefinition.action
Type
Cardinality
0 - *
Definition
An action or group of actions to be taken as part of the plan. For example, in clinical care, an action would be to prescribe a particular indicated medication, or perform a particular test as appropriate. In pharmaceutical quality, an action would be the test that needs to be performed on a drug product as defined in the quality specification.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
pld-3
pld-4
Path
PlanDefinition.action.linkId
Id
PlanDefinition.action.linkId
Type
Cardinality
0 - 1
Definition
An identifier that is unique within the PlanDefinition to allow linkage within the realized CarePlan and/or RequestOrchestration.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.prefix
Id
PlanDefinition.action.prefix
Type
Cardinality
0 - 1
Definition
A user-visible prefix for the action. For example a section or item numbering such as 1. or A.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.title
Id
PlanDefinition.action.title
Type
Cardinality
0 - 1
Definition
The textual description of the action displayed to a user. For example, when the action is a test to be performed, the title would be the title of the test such as Assay by HPLC.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.description
Id
PlanDefinition.action.description
Type
Cardinality
0 - 1
Definition
A brief description of the action used to provide a summary to display to the user.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
textEquivalent
Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
Path
PlanDefinition.action.textEquivalent
Id
PlanDefinition.action.textEquivalent
Type
Cardinality
0 - 1
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.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.priority
Id
PlanDefinition.action.priority
Type
Cardinality
0 - 1
Definition
Indicates how quickly the action should be addressed with respect to other actions.
Comment
Binding
Strength
required
Description
Identifies the level of importance to be assigned to actioning the request.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.code
Id
PlanDefinition.action.code
Type
Cardinality
0 - 1
Definition
A code that provides a meaning, grouping, or classification for the action or action group. For example, a section may have a LOINC code for the section of a documentation template. In pharmaceutical quality, an action (Test) such as pH could be classified as a physical property.
Comment
Binding
Strength
example
Description
Provides examples of actions to be performed.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.code.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.code.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.code.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.code.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
PlanDefinition.action.code.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
PlanDefinition.action.code.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.reason
Id
PlanDefinition.action.reason
Type
Cardinality
0 - *
Definition
A description of why this action is necessary or appropriate.
Comment
This is different than the clinical evidence documentation, it's an actual business description of the reason for performing the action.
Binding
Strength
example
Description
Provides examples of reasons for actions to be performed.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.reason.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.reason.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.reason.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.reason.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
PlanDefinition.action.reason.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
PlanDefinition.action.reason.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.documentation
Id
PlanDefinition.action.documentation
Type
Cardinality
0 - *
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.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
type
documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
Path
PlanDefinition.action.documentation.RelatedArtifact.type
Id
RelatedArtifact.type
Type
Cardinality
1 - 1
Definition
The type of relationship to the related artifact.
Comment
The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of "new points to old" and "many points to one", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet.
Binding
Strength
required
Description
The type of relationship to the related artifact.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.documentation.RelatedArtifact.classifier
Id
RelatedArtifact.classifier
Type
Cardinality
0 - *
Definition
Provides additional classifiers of the related artifact.
Comment
Binding
Strength
example
Description
Additional classifiers for the related artifact.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.documentation.RelatedArtifact.classifier.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.documentation.RelatedArtifact.label
Id
RelatedArtifact.label
Type
Cardinality
0 - 1
Definition
A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.documentation.RelatedArtifact.display
Id
RelatedArtifact.display
Type
Cardinality
0 - 1
Definition
A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.documentation.RelatedArtifact.citation
Id
RelatedArtifact.citation
Type
Cardinality
0 - 1
Definition
A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.
Comment
Additional structured information about citations should be captured as extensions.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.documentation.RelatedArtifact.document
Id
RelatedArtifact.document
Type
Cardinality
0 - 1
Definition
The document being referenced, represented as an attachment. This is exclusive with the resource element.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.documentation.RelatedArtifact.document.Attachment.contentType
Id
Attachment.contentType
Type
Cardinality
0 - 1
Definition
Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.
Comment
Requirements
Processors of the data need to be able to know how to interpret the data.
Binding
Strength
required
Description
BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
att-1
Path
PlanDefinition.action.documentation.RelatedArtifact.document.Attachment.data
Id
Attachment.data
Type
Cardinality
0 - 1
Definition
The actual data of the attachment - a sequence of bytes, base64 encoded.
Comment
The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.
Requirements
The data needs to able to be transmitted inline.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
att-1
Path
PlanDefinition.action.documentation.RelatedArtifact.document.Attachment.url
Id
Attachment.url
Type
Cardinality
0 - 1
Definition
A location where the data can be accessed.
Comment
If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.
Requirements
The data needs to be transmitted by reference.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.documentation.RelatedArtifact.document.Attachment.size
Id
Attachment.size
Type
Cardinality
0 - 1
Definition
The number of bytes of data that make up this attachment (before base64 encoding, if that is done).
Comment
The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.
Requirements
Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.documentation.RelatedArtifact.document.Attachment.hash
Id
Attachment.hash
Type
Cardinality
0 - 1
Definition
The calculated hash of the data using SHA-1. Represented using base64.
Comment
The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see [Provenance.signature](provenance-definitions.html#Provenance.signature) for mechanism to protect a resource with a digital signature.
Requirements
Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version).
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.documentation.RelatedArtifact.document.Attachment.title
Id
Attachment.title
Type
Cardinality
0 - 1
Definition
A label or set of text to display in place of the data.
Comment
May sometimes be derived from the source filename.
Requirements
Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.documentation.RelatedArtifact.document.Attachment.creation
Id
Attachment.creation
Type
Cardinality
0 - 1
Definition
The date that the attachment was first created.
Comment
Requirements
This is often tracked as an integrity issue for use of the attachment.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.documentation.RelatedArtifact.document.Attachment.height
Id
Attachment.height
Type
Cardinality
0 - 1
Definition
Height of the image in pixels (photo/video).
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.documentation.RelatedArtifact.document.Attachment.width
Id
Attachment.width
Type
Cardinality
0 - 1
Definition
Width of the image in pixels (photo/video).
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.documentation.RelatedArtifact.document.Attachment.frames
Id
Attachment.frames
Type
Cardinality
0 - 1
Definition
The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.
Comment
if the number of frames is not supplied, the value may be unknown. Applications should not assume that there is only one frame unless it is explicitly stated.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.documentation.RelatedArtifact.document.Attachment.duration
Id
Attachment.duration
Type
Cardinality
0 - 1
Definition
The duration of the recording in seconds - for audio and video.
Comment
The duration might differ from occurrencePeriod if recording was paused.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.documentation.RelatedArtifact.document.Attachment.pages
Id
Attachment.pages
Type
Cardinality
0 - 1
Definition
The number of pages when printed.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.documentation.RelatedArtifact.resource
Id
RelatedArtifact.resource
Type
Cardinality
0 - 1
Definition
The related artifact, such as a library, value set, profile, or other knowledge resource.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.documentation.RelatedArtifact.resourceReference
Id
RelatedArtifact.resourceReference
Type
Cardinality
0 - 1
Definition
The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource.
Comment
If both resource and resourceReference are present, they SHOULD be consistent and reference the same resource. Although relatedArtifact is intended to support references to definitional resources, there are cases where non-definitional resources can be definitional (such as Location where the kind is mode). Related artifacts SHOULD be used to reference definitional resources, and profiles SHOULD be used to make that explicit for particular use cases.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.documentation.RelatedArtifact.resourceReference.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
Definition
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Comment
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
PlanDefinition.action.documentation.RelatedArtifact.resourceReference.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.documentation.RelatedArtifact.resourceReference.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Comment
When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.
When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference
Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
PlanDefinition.action.documentation.RelatedArtifact.resourceReference.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
PlanDefinition.action.documentation.RelatedArtifact.publicationStatus
Id
RelatedArtifact.publicationStatus
Type
Cardinality
0 - 1
Definition
The publication status of the artifact being referred to.
Comment
Binding
Strength
required
Description
Publication status of an artifact being referred to.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.documentation.RelatedArtifact.publicationDate
Id
RelatedArtifact.publicationDate
Type
Cardinality
0 - 1
Definition
The date of publication of the artifact being referred to.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.goalId
Id
PlanDefinition.action.goalId
Type
Cardinality
0 - *
Definition
Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition. In pharmaceutical quality, a goal represents acceptance criteria (Goal) for a given action (Test), so the goalId would be the unique id of a defined goal element establishing the acceptance criteria for the action.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
pld-3
Path
PlanDefinition.action.subject[x]
Id
PlanDefinition.action.subject[x]
Type
Cardinality
0 - 1
Definition
A code, group definition, or canonical reference that describes the intended subject of the action and its children, if any. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.
Comment
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).
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.
Binding
Strength
extensible
Description
The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.subject[x].CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.subject[x].CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.subject[x].CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.subject[x].CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
PlanDefinition.action.subject[x].CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
PlanDefinition.action.subject[x].CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.trigger
Id
PlanDefinition.action.trigger
Type
Cardinality
0 - *
Definition
A description of when the action should be triggered. When multiple triggers are specified on an action, any triggering event invokes the action.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
type
named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Path
PlanDefinition.action.trigger.TriggerDefinition.type
Id
TriggerDefinition.type
Type
Cardinality
1 - 1
Definition
The type of triggering event.
Comment
Binding
Strength
required
Description
The type of trigger.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
trd-3
Path
PlanDefinition.action.trigger.TriggerDefinition.name
Id
TriggerDefinition.name
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
trd-3
Path
PlanDefinition.action.trigger.TriggerDefinition.code
Id
TriggerDefinition.code
Type
Cardinality
0 - 1
Definition
A code that identifies the event.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.trigger.TriggerDefinition.code.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.trigger.TriggerDefinition.subscriptionTopic
Id
TriggerDefinition.subscriptionTopic
Type
Cardinality
0 - 1
Definition
A reference to a SubscriptionTopic resource that defines the event. If this element is provided, no other information about the trigger definition may be supplied.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.trigger.TriggerDefinition.timing[x]
Id
TriggerDefinition.timing[x]
Type
Cardinality
0 - 1
Definition
The timing of the event (if this is a periodic trigger).
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
trd-3
trd-1
Path
PlanDefinition.action.trigger.TriggerDefinition.timing[x].Timing.event
Id
Timing.event
Type
Cardinality
0 - *
Definition
Identifies specific times when the event occurs.
Comment
Requirements
In a Medication Administration Record, for instance, you need to take a general specification, and turn it into a precise specification.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.trigger.TriggerDefinition.timing[x].Timing.repeat
Id
Timing.repeat
Type
Cardinality
0 - 1
Definition
A set of rules that describe when the event is scheduled.
Comment
Requirements
Many timing schedules are determined by regular repetitions.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
tim-1 [error]
if there's a duration, there needs to be duration units
tim-2 [error]
if there's a period, there needs to be period units
tim-4 [error]
duration SHALL be a non-negative value
tim-5 [error]
period SHALL be a non-negative value
tim-6 [error]
If there's a periodMax, there must be a period
tim-7 [error]
If there's a durationMax, there must be a duration
tim-8 [error]
If there's a countMax, there must be a count
tim-9 [error]
If there's an offset, there must be a when (and not C, CM, CD, CV)
tim-10 [error]
If there's a timeOfDay, there cannot be a when, or vice versa
Path
PlanDefinition.action.trigger.TriggerDefinition.timing[x].Timing.repeat.bounds[x]
Id
Timing.repeat.bounds[x]
Type
Cardinality
0 - 1
Definition
Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.trigger.TriggerDefinition.timing[x].Timing.repeat.count
Id
Timing.repeat.count
Type
Cardinality
0 - 1
Definition
A total count of the desired number of repetitions across the duration of the entire timing specification. If countMax is present, this element indicates the lower bound of the allowed range of count values.
Comment
If you have both bounds and count, then this should be understood as within the bounds period, until count times happens.
Requirements
Repetitions may be limited by end time or total occurrences.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
tim-8
Path
PlanDefinition.action.trigger.TriggerDefinition.timing[x].Timing.repeat.countMax
Id
Timing.repeat.countMax
Type
Cardinality
0 - 1
Definition
If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
tim-8
Path
PlanDefinition.action.trigger.TriggerDefinition.timing[x].Timing.repeat.duration
Id
Timing.repeat.duration
Type
Cardinality
0 - 1
Definition
How long this thing happens for when it happens. If durationMax is present, this element indicates the lower bound of the allowed range of the duration.
Comment
For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).
Requirements
Some activities are not instantaneous and need to be maintained for a period of time.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
tim-7
tim-1
tim-4
Path
PlanDefinition.action.trigger.TriggerDefinition.timing[x].Timing.repeat.durationMax
Id
Timing.repeat.durationMax
Type
Cardinality
0 - 1
Definition
If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length.
Comment
For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).
Requirements
Some activities are not instantaneous and need to be maintained for a period of time.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
tim-7
Path
PlanDefinition.action.trigger.TriggerDefinition.timing[x].Timing.repeat.durationUnit
Id
Timing.repeat.durationUnit
Type
Cardinality
0 - 1
Definition
The units of time for the duration, in UCUM units
Normal practice is to use the 'mo' code as a calendar month when calculating the next occurrence.
Comment
Binding
Strength
required
Description
A unit of time (units from UCUM).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
tim-1
frequency
Indicates the number of repetitions that should occur within a period. I.e. Event occurs frequency times per period
Path
PlanDefinition.action.trigger.TriggerDefinition.timing[x].Timing.repeat.frequency
Id
Timing.repeat.frequency
Type
Cardinality
0 - 1
Definition
The number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequency.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.trigger.TriggerDefinition.timing[x].Timing.repeat.frequencyMax
Id
Timing.repeat.frequencyMax
Type
Cardinality
0 - 1
Definition
If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
period
The duration to which the frequency applies. I.e. Event occurs frequency times per period
Path
PlanDefinition.action.trigger.TriggerDefinition.timing[x].Timing.repeat.period
Id
Timing.repeat.period
Type
Cardinality
0 - 1
Definition
Indicates the duration of time over which repetitions are to occur; e.g. to express "3 times per day", 3 would be the frequency and "1 day" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period length.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
tim-6
tim-5
tim-2
Path
PlanDefinition.action.trigger.TriggerDefinition.timing[x].Timing.repeat.periodMax
Id
Timing.repeat.periodMax
Type
Cardinality
0 - 1
Definition
If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
tim-6
Path
PlanDefinition.action.trigger.TriggerDefinition.timing[x].Timing.repeat.periodUnit
Id
Timing.repeat.periodUnit
Type
Cardinality
0 - 1
Definition
The units of time for the period in UCUM units
Normal practice is to use the 'mo' code as a calendar month when calculating the next occurrence.
Comment
Binding
Strength
required
Description
A unit of time (units from UCUM).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
tim-2
Path
PlanDefinition.action.trigger.TriggerDefinition.timing[x].Timing.repeat.dayOfWeek
Id
Timing.repeat.dayOfWeek
Type
Cardinality
0 - *
Definition
If one or more days of week is provided, then the action happens only on the specified day(s).
Comment
If no days are specified, the action is assumed to happen every day as otherwise specified.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.trigger.TriggerDefinition.timing[x].Timing.repeat.timeOfDay
Id
Timing.repeat.timeOfDay
Type
Cardinality
0 - *
Definition
Specified time of day for action to take place.
Comment
When time of day is specified, it is inferred that the action happens every day (as filtered by dayofWeek) on the specified times. If there's a timeOfDay, there cannot be a when, or vice versa.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
tim-10
Path
PlanDefinition.action.trigger.TriggerDefinition.timing[x].Timing.repeat.when
Id
Timing.repeat.when
Type
Cardinality
0 - *
Definition
An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur.
Comment
When more than one event is listed, the event is tied to the union of the specified events.
Requirements
Timings are frequently determined by occurrences such as waking, eating and sleep.
Binding
Strength
required
Description
Real-world event relating to the schedule.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
tim-9
tim-10
Path
PlanDefinition.action.trigger.TriggerDefinition.timing[x].Timing.repeat.offset
Id
Timing.repeat.offset
Type
Cardinality
0 - 1
Definition
The number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
tim-9
Path
PlanDefinition.action.trigger.TriggerDefinition.timing[x].Timing.code
Id
Timing.code
Type
Cardinality
0 - 1
Definition
A code for the timing schedule (or just text in code.text). Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code).
Comment
BID etc. are defined as 'at institutionally specified times'. For example, an institution may choose that BID is "always at 7am and 6pm". If it is inappropriate for this choice to be made, the code BID should not be used. Instead, a distinct organization-specific code should be used in place of the HL7-defined BID code and/or a structured representation should be used (in this case, specifying the two event times).
Binding
Strength
preferred
Description
Code for a known / defined timing pattern.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.trigger.TriggerDefinition.data
Id
TriggerDefinition.data
Type
Cardinality
0 - *
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.
Comment
This element shall be present for any data type trigger.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
trd-3
trd-2
trd-1
Path
PlanDefinition.action.trigger.TriggerDefinition.data.DataRequirement.type
Id
DataRequirement.type
Type
Cardinality
1 - 1
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.
Comment
Binding
Strength
required
Description
List of FHIR types (resources, data types).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.trigger.TriggerDefinition.data.DataRequirement.profile
Id
DataRequirement.profile
Type
Cardinality
0 - *
Definition
The profile of the required data, specified as the uri of the profile definition.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
subject[x]
E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Path
PlanDefinition.action.trigger.TriggerDefinition.data.DataRequirement.subject[x]
Id
DataRequirement.subject[x]
Type
Cardinality
0 - 1
Definition
The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.
Comment
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.
Binding
Strength
extensible
Description
The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
mustSupport
Indicates specific structure elements that are referenced by the knowledge module
Path
PlanDefinition.action.trigger.TriggerDefinition.data.DataRequirement.mustSupport
Id
DataRequirement.mustSupport
Type
Cardinality
0 - *
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 resolvable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.trigger.TriggerDefinition.data.DataRequirement.codeFilter
Id
DataRequirement.codeFilter
Type
Cardinality
0 - *
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.
Comment
Constraint
drq-1 [error]
Either a path or a searchParam must be provided, but not both
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.trigger.TriggerDefinition.data.DataRequirement.codeFilter.path
Id
DataRequirement.codeFilter.path
Type
Cardinality
0 - 1
Definition
The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolvable 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](fhirpath.html#simple) 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.
Comment
The path attribute contains a [Simple FHIRPath Subset](fhirpath.html#simple) that allows path traversal, but not calculation.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
drq-1
Path
PlanDefinition.action.trigger.TriggerDefinition.data.DataRequirement.codeFilter.searchParam
Id
DataRequirement.codeFilter.searchParam
Type
Cardinality
0 - 1
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.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
drq-1
Path
PlanDefinition.action.trigger.TriggerDefinition.data.DataRequirement.codeFilter.valueSet
Id
DataRequirement.codeFilter.valueSet
Type
Cardinality
0 - 1
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.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.trigger.TriggerDefinition.data.DataRequirement.codeFilter.code
Id
DataRequirement.codeFilter.code
Type
Cardinality
0 - *
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.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.trigger.TriggerDefinition.data.DataRequirement.dateFilter
Id
DataRequirement.dateFilter
Type
Cardinality
0 - *
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.
Comment
Constraint
drq-2 [error]
Either a path or a searchParam must be provided, but not both
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.trigger.TriggerDefinition.data.DataRequirement.dateFilter.path
Id
DataRequirement.dateFilter.path
Type
Cardinality
0 - 1
Definition
The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolvable 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](fhirpath.html#simple) 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.
Comment
The path attribute contains a [Simple FHIR Subset](fhirpath.html#simple) that allows path traversal, but not calculation.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
drq-2
Path
PlanDefinition.action.trigger.TriggerDefinition.data.DataRequirement.dateFilter.searchParam
Id
DataRequirement.dateFilter.searchParam
Type
Cardinality
0 - 1
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.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
drq-2
Path
PlanDefinition.action.trigger.TriggerDefinition.data.DataRequirement.dateFilter.value[x]
Id
DataRequirement.dateFilter.value[x]
Type
Cardinality
0 - 1
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.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.trigger.TriggerDefinition.data.DataRequirement.valueFilter
Id
DataRequirement.valueFilter
Type
Cardinality
0 - *
Definition
Value filters specify additional constraints on the data for elements other than code-valued or date-valued. Each value filter specifies an additional constraint on the data (i.e. valueFilters are AND'ed, not OR'ed).
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.trigger.TriggerDefinition.data.DataRequirement.valueFilter.path
Id
DataRequirement.valueFilter.path
Type
Cardinality
0 - 1
Definition
The attribute of the filter. The specified path SHALL be a FHIRPath resolvable 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](fhirpath.html#simple) for full details). Note that the index must be an integer constant. The path must resolve to an element of a type that is comparable to the valueFilter.value[x] element for the filter.
Comment
The path attribute contains a [Simple FHIR Subset](fhirpath.html#simple) that allows path traversal, but not calculation.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.trigger.TriggerDefinition.data.DataRequirement.valueFilter.searchParam
Id
DataRequirement.valueFilter.searchParam
Type
Cardinality
0 - 1
Definition
A search parameter defined on the specified type of the DataRequirement, and which searches on elements of a type compatible with the type of the valueFilter.value[x] for the filter.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.trigger.TriggerDefinition.data.DataRequirement.valueFilter.comparator
Id
DataRequirement.valueFilter.comparator
Type
Cardinality
0 - 1
Definition
The comparator to be used to determine whether the value is matching.
Comment
Binding
Strength
required
Description
Possible comparators for the valueFilter element.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.trigger.TriggerDefinition.data.DataRequirement.valueFilter.value[x]
Id
DataRequirement.valueFilter.value[x]
Type
Cardinality
0 - 1
Definition
The value of the filter.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.trigger.TriggerDefinition.data.DataRequirement.limit
Id
DataRequirement.limit
Type
Cardinality
0 - 1
Definition
Specifies a maximum number of results that are required (uses the _count search parameter).
Comment
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".
Requirements
Enables the requirement "most recent 5 results" to be expressed.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.trigger.TriggerDefinition.data.DataRequirement.sort
Id
DataRequirement.sort
Type
Cardinality
0 - *
Definition
Specifies the order of the results to be returned.
Comment
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.
Requirements
Enables the requirement "most recent 5 results" to be expressed.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.trigger.TriggerDefinition.data.DataRequirement.sort.path
Id
DataRequirement.sort.path
Type
Cardinality
1 - 1
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.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.trigger.TriggerDefinition.data.DataRequirement.sort.direction
Id
DataRequirement.sort.direction
Type
Cardinality
1 - 1
Definition
The direction of the sort, ascending or descending.
Comment
Binding
Strength
required
Description
The possible sort directions, ascending or descending.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.trigger.TriggerDefinition.condition
Id
TriggerDefinition.condition
Type
Cardinality
0 - 1
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.
Comment
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.
Requirements
Need to be able to formally describe the triggering criteria.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
trd-2
Path
PlanDefinition.action.trigger.TriggerDefinition.condition.Expression.description
Id
Expression.description
Type
Cardinality
0 - 1
Definition
A brief, natural language description of the condition that effectively communicates the intended semantics.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.trigger.TriggerDefinition.condition.Expression.name
Id
Expression.name
Type
Cardinality
0 - 1
Definition
A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
exp-2
Path
PlanDefinition.action.trigger.TriggerDefinition.condition.Expression.expression
Id
Expression.expression
Type
Cardinality
0 - 1
Definition
An expression in the specified language that returns a value.
Comment
If Expression.expression and Expression.reference are both present, the Expression.expression might just be a name pointing something within the referenced content.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
exp-1
Path
PlanDefinition.action.trigger.TriggerDefinition.condition.Expression.reference
Id
Expression.reference
Type
Cardinality
0 - 1
Definition
A URI that defines where the expression is found.
Comment
If both a reference and an expression is found, the reference SHALL point to the same expression.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
exp-1
Path
PlanDefinition.action.condition
Id
PlanDefinition.action.condition
Type
Cardinality
0 - *
Definition
An expression that describes applicability criteria or start/stop conditions for the action.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.condition.kind
Id
PlanDefinition.action.condition.kind
Type
Cardinality
1 - 1
Definition
The kind of condition.
Comment
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.
Binding
Strength
required
Description
Defines the kinds of conditions that can appear on actions.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.condition.expression
Id
PlanDefinition.action.condition.expression
Type
Cardinality
0 - 1
Definition
An expression that returns true or false, indicating whether the condition is satisfied.
Comment
The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.condition.expression.Expression.description
Id
Expression.description
Type
Cardinality
0 - 1
Definition
A brief, natural language description of the condition that effectively communicates the intended semantics.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.condition.expression.Expression.name
Id
Expression.name
Type
Cardinality
0 - 1
Definition
A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
exp-2
Path
PlanDefinition.action.condition.expression.Expression.expression
Id
Expression.expression
Type
Cardinality
0 - 1
Definition
An expression in the specified language that returns a value.
Comment
If Expression.expression and Expression.reference are both present, the Expression.expression might just be a name pointing something within the referenced content.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
exp-1
Path
PlanDefinition.action.condition.expression.Expression.reference
Id
Expression.reference
Type
Cardinality
0 - 1
Definition
A URI that defines where the expression is found.
Comment
If both a reference and an expression is found, the reference SHALL point to the same expression.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
exp-1
Path
PlanDefinition.action.input
Id
PlanDefinition.action.input
Type
Cardinality
0 - *
Definition
Defines input data requirements for the action.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
pld-0 [error]
Input data elements must have a requirement or a relatedData, but not both
Path
PlanDefinition.action.input.title
Id
PlanDefinition.action.input.title
Type
Cardinality
0 - 1
Definition
A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.input.requirement
Id
PlanDefinition.action.input.requirement
Type
Cardinality
0 - 1
Definition
Defines the data that is to be provided as input to the action.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
pld-0
Path
PlanDefinition.action.input.requirement.DataRequirement.type
Id
DataRequirement.type
Type
Cardinality
1 - 1
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.
Comment
Binding
Strength
required
Description
List of FHIR types (resources, data types).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.input.requirement.DataRequirement.profile
Id
DataRequirement.profile
Type
Cardinality
0 - *
Definition
The profile of the required data, specified as the uri of the profile definition.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
subject[x]
E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Path
PlanDefinition.action.input.requirement.DataRequirement.subject[x]
Id
DataRequirement.subject[x]
Type
Cardinality
0 - 1
Definition
The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.
Comment
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.
Binding
Strength
extensible
Description
The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
mustSupport
Indicates specific structure elements that are referenced by the knowledge module
Path
PlanDefinition.action.input.requirement.DataRequirement.mustSupport
Id
DataRequirement.mustSupport
Type
Cardinality
0 - *
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 resolvable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.input.requirement.DataRequirement.codeFilter
Id
DataRequirement.codeFilter
Type
Cardinality
0 - *
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.
Comment
Constraint
drq-1 [error]
Either a path or a searchParam must be provided, but not both
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.input.requirement.DataRequirement.codeFilter.path
Id
DataRequirement.codeFilter.path
Type
Cardinality
0 - 1
Definition
The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolvable 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](fhirpath.html#simple) 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.
Comment
The path attribute contains a [Simple FHIRPath Subset](fhirpath.html#simple) that allows path traversal, but not calculation.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
drq-1
Path
PlanDefinition.action.input.requirement.DataRequirement.codeFilter.searchParam
Id
DataRequirement.codeFilter.searchParam
Type
Cardinality
0 - 1
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.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
drq-1
Path
PlanDefinition.action.input.requirement.DataRequirement.codeFilter.valueSet
Id
DataRequirement.codeFilter.valueSet
Type
Cardinality
0 - 1
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.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.input.requirement.DataRequirement.codeFilter.code
Id
DataRequirement.codeFilter.code
Type
Cardinality
0 - *
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.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.input.requirement.DataRequirement.dateFilter
Id
DataRequirement.dateFilter
Type
Cardinality
0 - *
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.
Comment
Constraint
drq-2 [error]
Either a path or a searchParam must be provided, but not both
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.input.requirement.DataRequirement.dateFilter.path
Id
DataRequirement.dateFilter.path
Type
Cardinality
0 - 1
Definition
The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolvable 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](fhirpath.html#simple) 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.
Comment
The path attribute contains a [Simple FHIR Subset](fhirpath.html#simple) that allows path traversal, but not calculation.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
drq-2
Path
PlanDefinition.action.input.requirement.DataRequirement.dateFilter.searchParam
Id
DataRequirement.dateFilter.searchParam
Type
Cardinality
0 - 1
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.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
drq-2
Path
PlanDefinition.action.input.requirement.DataRequirement.dateFilter.value[x]
Id
DataRequirement.dateFilter.value[x]
Type
Cardinality
0 - 1
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.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.input.requirement.DataRequirement.valueFilter
Id
DataRequirement.valueFilter
Type
Cardinality
0 - *
Definition
Value filters specify additional constraints on the data for elements other than code-valued or date-valued. Each value filter specifies an additional constraint on the data (i.e. valueFilters are AND'ed, not OR'ed).
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.input.requirement.DataRequirement.valueFilter.path
Id
DataRequirement.valueFilter.path
Type
Cardinality
0 - 1
Definition
The attribute of the filter. The specified path SHALL be a FHIRPath resolvable 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](fhirpath.html#simple) for full details). Note that the index must be an integer constant. The path must resolve to an element of a type that is comparable to the valueFilter.value[x] element for the filter.
Comment
The path attribute contains a [Simple FHIR Subset](fhirpath.html#simple) that allows path traversal, but not calculation.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.input.requirement.DataRequirement.valueFilter.searchParam
Id
DataRequirement.valueFilter.searchParam
Type
Cardinality
0 - 1
Definition
A search parameter defined on the specified type of the DataRequirement, and which searches on elements of a type compatible with the type of the valueFilter.value[x] for the filter.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.input.requirement.DataRequirement.valueFilter.comparator
Id
DataRequirement.valueFilter.comparator
Type
Cardinality
0 - 1
Definition
The comparator to be used to determine whether the value is matching.
Comment
Binding
Strength
required
Description
Possible comparators for the valueFilter element.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.input.requirement.DataRequirement.valueFilter.value[x]
Id
DataRequirement.valueFilter.value[x]
Type
Cardinality
0 - 1
Definition
The value of the filter.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.input.requirement.DataRequirement.limit
Id
DataRequirement.limit
Type
Cardinality
0 - 1
Definition
Specifies a maximum number of results that are required (uses the _count search parameter).
Comment
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".
Requirements
Enables the requirement "most recent 5 results" to be expressed.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.input.requirement.DataRequirement.sort
Id
DataRequirement.sort
Type
Cardinality
0 - *
Definition
Specifies the order of the results to be returned.
Comment
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.
Requirements
Enables the requirement "most recent 5 results" to be expressed.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.input.requirement.DataRequirement.sort.path
Id
DataRequirement.sort.path
Type
Cardinality
1 - 1
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.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.input.requirement.DataRequirement.sort.direction
Id
DataRequirement.sort.direction
Type
Cardinality
1 - 1
Definition
The direction of the sort, ascending or descending.
Comment
Binding
Strength
required
Description
The possible sort directions, ascending or descending.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.input.relatedData
Id
PlanDefinition.action.input.relatedData
Type
Cardinality
0 - 1
Definition
Points to an existing input or output element that provides data to this input.
Comment
The relatedData element allows indicating that an input to a parent action is an input to specific child actions. It also allows the output of one action to be identified as the input to a different action
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
pld-0
Path
PlanDefinition.action.output
Id
PlanDefinition.action.output
Type
Cardinality
0 - *
Definition
Defines the outputs of the action, if any.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
pld-1 [error]
Output data element must have a requirement or a relatedData, but not both
Path
PlanDefinition.action.output.title
Id
PlanDefinition.action.output.title
Type
Cardinality
0 - 1
Definition
A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.output.requirement
Id
PlanDefinition.action.output.requirement
Type
Cardinality
0 - 1
Definition
Defines the data that results as output from the action.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
pld-1
Path
PlanDefinition.action.output.requirement.DataRequirement.type
Id
DataRequirement.type
Type
Cardinality
1 - 1
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.
Comment
Binding
Strength
required
Description
List of FHIR types (resources, data types).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.output.requirement.DataRequirement.profile
Id
DataRequirement.profile
Type
Cardinality
0 - *
Definition
The profile of the required data, specified as the uri of the profile definition.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
subject[x]
E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Path
PlanDefinition.action.output.requirement.DataRequirement.subject[x]
Id
DataRequirement.subject[x]
Type
Cardinality
0 - 1
Definition
The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.
Comment
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.
Binding
Strength
extensible
Description
The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
mustSupport
Indicates specific structure elements that are referenced by the knowledge module
Path
PlanDefinition.action.output.requirement.DataRequirement.mustSupport
Id
DataRequirement.mustSupport
Type
Cardinality
0 - *
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 resolvable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.output.requirement.DataRequirement.codeFilter
Id
DataRequirement.codeFilter
Type
Cardinality
0 - *
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.
Comment
Constraint
drq-1 [error]
Either a path or a searchParam must be provided, but not both
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.output.requirement.DataRequirement.codeFilter.path
Id
DataRequirement.codeFilter.path
Type
Cardinality
0 - 1
Definition
The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolvable 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](fhirpath.html#simple) 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.
Comment
The path attribute contains a [Simple FHIRPath Subset](fhirpath.html#simple) that allows path traversal, but not calculation.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
drq-1
Path
PlanDefinition.action.output.requirement.DataRequirement.codeFilter.searchParam
Id
DataRequirement.codeFilter.searchParam
Type
Cardinality
0 - 1
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.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
drq-1
Path
PlanDefinition.action.output.requirement.DataRequirement.codeFilter.valueSet
Id
DataRequirement.codeFilter.valueSet
Type
Cardinality
0 - 1
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.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.output.requirement.DataRequirement.codeFilter.code
Id
DataRequirement.codeFilter.code
Type
Cardinality
0 - *
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.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.output.requirement.DataRequirement.dateFilter
Id
DataRequirement.dateFilter
Type
Cardinality
0 - *
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.
Comment
Constraint
drq-2 [error]
Either a path or a searchParam must be provided, but not both
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.output.requirement.DataRequirement.dateFilter.path
Id
DataRequirement.dateFilter.path
Type
Cardinality
0 - 1
Definition
The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolvable 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](fhirpath.html#simple) 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.
Comment
The path attribute contains a [Simple FHIR Subset](fhirpath.html#simple) that allows path traversal, but not calculation.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
drq-2
Path
PlanDefinition.action.output.requirement.DataRequirement.dateFilter.searchParam
Id
DataRequirement.dateFilter.searchParam
Type
Cardinality
0 - 1
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.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
drq-2
Path
PlanDefinition.action.output.requirement.DataRequirement.dateFilter.value[x]
Id
DataRequirement.dateFilter.value[x]
Type
Cardinality
0 - 1
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.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.output.requirement.DataRequirement.valueFilter
Id
DataRequirement.valueFilter
Type
Cardinality
0 - *
Definition
Value filters specify additional constraints on the data for elements other than code-valued or date-valued. Each value filter specifies an additional constraint on the data (i.e. valueFilters are AND'ed, not OR'ed).
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.output.requirement.DataRequirement.valueFilter.path
Id
DataRequirement.valueFilter.path
Type
Cardinality
0 - 1
Definition
The attribute of the filter. The specified path SHALL be a FHIRPath resolvable 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](fhirpath.html#simple) for full details). Note that the index must be an integer constant. The path must resolve to an element of a type that is comparable to the valueFilter.value[x] element for the filter.
Comment
The path attribute contains a [Simple FHIR Subset](fhirpath.html#simple) that allows path traversal, but not calculation.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.output.requirement.DataRequirement.valueFilter.searchParam
Id
DataRequirement.valueFilter.searchParam
Type
Cardinality
0 - 1
Definition
A search parameter defined on the specified type of the DataRequirement, and which searches on elements of a type compatible with the type of the valueFilter.value[x] for the filter.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.output.requirement.DataRequirement.valueFilter.comparator
Id
DataRequirement.valueFilter.comparator
Type
Cardinality
0 - 1
Definition
The comparator to be used to determine whether the value is matching.
Comment
Binding
Strength
required
Description
Possible comparators for the valueFilter element.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.output.requirement.DataRequirement.valueFilter.value[x]
Id
DataRequirement.valueFilter.value[x]
Type
Cardinality
0 - 1
Definition
The value of the filter.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.output.requirement.DataRequirement.limit
Id
DataRequirement.limit
Type
Cardinality
0 - 1
Definition
Specifies a maximum number of results that are required (uses the _count search parameter).
Comment
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".
Requirements
Enables the requirement "most recent 5 results" to be expressed.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.output.requirement.DataRequirement.sort
Id
DataRequirement.sort
Type
Cardinality
0 - *
Definition
Specifies the order of the results to be returned.
Comment
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.
Requirements
Enables the requirement "most recent 5 results" to be expressed.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.output.requirement.DataRequirement.sort.path
Id
DataRequirement.sort.path
Type
Cardinality
1 - 1
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.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.output.requirement.DataRequirement.sort.direction
Id
DataRequirement.sort.direction
Type
Cardinality
1 - 1
Definition
The direction of the sort, ascending or descending.
Comment
Binding
Strength
required
Description
The possible sort directions, ascending or descending.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.output.relatedData
Id
PlanDefinition.action.output.relatedData
Type
Cardinality
0 - 1
Definition
Points to an existing input or output element that is results as output from the action.
Comment
The relatedData element allows indicating that the output of child action is also the output of a parent action. It also allows the input of one action to be identified as the output of a different action
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
pld-1
Path
PlanDefinition.action.relatedAction
Id
PlanDefinition.action.relatedAction
Type
Cardinality
0 - *
Definition
A relationship to another action such as "before" or "30-60 minutes after start of".
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
pld-4
Path
PlanDefinition.action.relatedAction.targetId
Id
PlanDefinition.action.relatedAction.targetId
Type
Cardinality
1 - 1
Definition
The element id of the target related action.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
pld-4
relationship
before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
Path
PlanDefinition.action.relatedAction.relationship
Id
PlanDefinition.action.relatedAction.relationship
Type
Cardinality
1 - 1
Definition
The relationship of the start of this action to the related action.
Comment
Binding
Strength
required
Description
Defines the types of relationships between actions.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
endRelationship
before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
Path
PlanDefinition.action.relatedAction.endRelationship
Id
PlanDefinition.action.relatedAction.endRelationship
Type
Cardinality
0 - 1
Definition
The relationship of the end of this action to the related action.
Comment
Binding
Strength
required
Description
Defines the types of relationships between actions.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.relatedAction.offset[x]
Id
PlanDefinition.action.relatedAction.offset[x]
Type
Cardinality
0 - 1
Definition
A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.relatedAction.offset[x].Duration.value
Id
Duration.value
Type
Cardinality
0 - 1
Definition
The value of the measured amount. The value includes an implicit precision in the presentation of the value.
Comment
The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).
Requirements
Precision is handled implicitly in almost all cases of measurement.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.relatedAction.offset[x].Duration.comparator
Id
Duration.comparator
Type
Cardinality
0 - 1
Definition
How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.
Comment
Requirements
Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.
Binding
Strength
required
Description
How the Quantity should be understood and represented.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.relatedAction.offset[x].Duration.unit
Id
Duration.unit
Type
Cardinality
0 - 1
Definition
A human-readable form of the unit.
Comment
Requirements
There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.relatedAction.offset[x].Duration.system
Id
Duration.system
Type
Cardinality
0 - 1
Definition
The identification of the system that provides the coded form of the unit.
Comment
Requirements
Need to know the system that defines the coded form of the unit.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
qty-3
Path
PlanDefinition.action.relatedAction.offset[x].Duration.code
Id
Duration.code
Type
Cardinality
0 - 1
Definition
A computer processable form of the unit in some unit representation system.
Comment
The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.
Requirements
Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
qty-3
Path
PlanDefinition.action.timing[x]
Id
PlanDefinition.action.timing[x]
Type
Cardinality
0 - 1
Definition
An optional value describing when the action should be performed.
Comment
The intent of the timing element is to provide timing when the action should be performed. As a definitional resource, this timing is interpreted as part of an apply operation so that the timing of the result actions in a CarePlan or RequestOrchestration, for example, would be specified by evaluating the timing definition in the context of the apply and setting the resulting timing on the appropriate elements of the target resource. If the timing is an Age, the activity is expected to be performed when the subject is the given Age. When the timing is a Duration, the activity is expected to be performed within the specified duration from the apply. When the timing is a Range, it may be a range of Ages or Durations, providing a range for the expected timing of the resulting activity. When the timing is a Timing, it is establishing a schedule for the timing of the resulting activity.
Requirements
Allows prompting for activities and detection of missed planned activities.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.timing[x].Age.value
Id
Age.value
Type
Cardinality
0 - 1
Definition
The value of the measured amount. The value includes an implicit precision in the presentation of the value.
Comment
The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).
Requirements
Precision is handled implicitly in almost all cases of measurement.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.timing[x].Age.comparator
Id
Age.comparator
Type
Cardinality
0 - 1
Definition
How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.
Comment
Requirements
Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.
Binding
Strength
required
Description
How the Quantity should be understood and represented.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.timing[x].Age.unit
Id
Age.unit
Type
Cardinality
0 - 1
Definition
A human-readable form of the unit.
Comment
Requirements
There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.timing[x].Age.system
Id
Age.system
Type
Cardinality
0 - 1
Definition
The identification of the system that provides the coded form of the unit.
Comment
Requirements
Need to know the system that defines the coded form of the unit.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
qty-3
Path
PlanDefinition.action.timing[x].Age.code
Id
Age.code
Type
Cardinality
0 - 1
Definition
A computer processable form of the unit in some unit representation system.
Comment
The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.
Requirements
Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
qty-3
Path
PlanDefinition.action.location
Id
PlanDefinition.action.location
Type
Cardinality
0 - 1
Definition
Identifies the facility where the action will occur; e.g. home, hospital, specific clinic, etc.
Comment
May reference a specific clinical location or may just identify a type of location.
Requirements
Helps in planning of activity.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.location.CodeableReference.concept
Id
CodeableReference.concept
Type
Cardinality
0 - 1
Definition
A reference to a concept - e.g. the information is identified by its general class to the degree of precision found in the terminology.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.location.CodeableReference.concept.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.location.CodeableReference.reference
Id
CodeableReference.reference
Type
Cardinality
0 - 1
Definition
A reference to a resource the provides exact details about the information being referenced.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.location.CodeableReference.reference.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
Definition
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Comment
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
PlanDefinition.action.location.CodeableReference.reference.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.location.CodeableReference.reference.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Comment
When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.
When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference
Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
PlanDefinition.action.location.CodeableReference.reference.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
PlanDefinition.action.participant
Id
PlanDefinition.action.participant
Type
Cardinality
0 - *
Definition
Indicates who should participate in performing the action described.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.participant.actorId
Id
PlanDefinition.action.participant.actorId
Type
Cardinality
0 - 1
Definition
A reference to the id element of the actor who will participate in this action.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
type
careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Path
PlanDefinition.action.participant.type
Id
PlanDefinition.action.participant.type
Type
Cardinality
0 - 1
Definition
The type of participant in the action.
Comment
Binding
Strength
required
Description
The type of participant in the activity.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.participant.typeCanonical
Id
PlanDefinition.action.participant.typeCanonical
Type
Cardinality
0 - 1
Definition
The type of participant in the action.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.participant.typeReference
Id
PlanDefinition.action.participant.typeReference
Type
Cardinality
0 - 1
Definition
The type of participant in the action.
Comment
When this element is a reference, it SHOULD be a reference to a definitional resource (for example, a location type, rather than a specific location).
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.participant.typeReference.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
Definition
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Comment
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
PlanDefinition.action.participant.typeReference.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.participant.typeReference.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Comment
When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.
When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference
Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
PlanDefinition.action.participant.typeReference.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
PlanDefinition.action.participant.role
Id
PlanDefinition.action.participant.role
Type
Cardinality
0 - 1
Definition
The role the participant should play in performing the described action.
Comment
Binding
Strength
example
Description
Defines roles played by participants for the action.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.participant.role.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.participant.function
Id
PlanDefinition.action.participant.function
Type
Cardinality
0 - 1
Definition
Indicates how the actor will be involved in the action - author, reviewer, witness, etc.
Comment
Binding
Strength
example
Description
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.participant.function.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.type
Id
PlanDefinition.action.type
Type
Cardinality
0 - 1
Definition
The type of action to perform (create, update, remove).
Comment
Binding
Strength
extensible
Description
The type of action to be performed.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.type.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.type.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.type.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.type.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
PlanDefinition.action.type.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
PlanDefinition.action.type.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.groupingBehavior
Id
PlanDefinition.action.groupingBehavior
Type
Cardinality
0 - 1
Definition
Defines the grouping behavior for the action and its children.
Comment
Binding
Strength
required
Description
Defines organization behavior of a group.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.selectionBehavior
Id
PlanDefinition.action.selectionBehavior
Type
Cardinality
0 - 1
Definition
Defines the selection behavior for the action and its children.
Comment
Binding
Strength
required
Description
Defines selection behavior of a group.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.requiredBehavior
Id
PlanDefinition.action.requiredBehavior
Type
Cardinality
0 - 1
Definition
Defines the required behavior for the action.
Comment
Binding
Strength
required
Description
Defines expectations around whether an action or action group is required.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.precheckBehavior
Id
PlanDefinition.action.precheckBehavior
Type
Cardinality
0 - 1
Definition
Defines whether the action should usually be preselected.
Comment
Binding
Strength
required
Description
Defines selection frequency behavior for an action or group.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.cardinalityBehavior
Id
PlanDefinition.action.cardinalityBehavior
Type
Cardinality
0 - 1
Definition
Defines whether the action can be selected multiple times.
Comment
Binding
Strength
required
Description
Defines behavior for an action or a group for how many times that item may be repeated.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.definition[x]
Id
PlanDefinition.action.definition[x]
Type
Cardinality
0 - 1
Definition
A reference to an ActivityDefinition that describes the action to be taken in detail, a MessageDefinition describing a message to be snet, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, a SpecimenDefinition describing a specimen to be collected, or an ObservationDefinition that specifies what observation should be captured.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.transform
Id
PlanDefinition.action.transform
Type
Cardinality
0 - 1
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.dynamicValue
Id
PlanDefinition.action.dynamicValue
Type
Cardinality
0 - *
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.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.dynamicValue.path
Id
PlanDefinition.action.dynamicValue.path
Type
Cardinality
0 - 1
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 resolvable 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](fhirpath.html#simple) for full details).
Comment
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](fhirpath.html#simple) that allows path traversal, but not calculation.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.dynamicValue.expression
Id
PlanDefinition.action.dynamicValue.expression
Type
Cardinality
0 - 1
Definition
An expression specifying the value of the customized element.
Comment
The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.dynamicValue.expression.Expression.description
Id
Expression.description
Type
Cardinality
0 - 1
Definition
A brief, natural language description of the condition that effectively communicates the intended semantics.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.action.dynamicValue.expression.Expression.name
Id
Expression.name
Type
Cardinality
0 - 1
Definition
A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
exp-2
Path
PlanDefinition.action.dynamicValue.expression.Expression.expression
Id
Expression.expression
Type
Cardinality
0 - 1
Definition
An expression in the specified language that returns a value.
Comment
If Expression.expression and Expression.reference are both present, the Expression.expression might just be a name pointing something within the referenced content.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
exp-1
Path
PlanDefinition.action.dynamicValue.expression.Expression.reference
Id
Expression.reference
Type
Cardinality
0 - 1
Definition
A URI that defines where the expression is found.
Comment
If both a reference and an expression is found, the reference SHALL point to the same expression.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
exp-1
Path
PlanDefinition.action.action
Id
PlanDefinition.action.action
Type
Cardinality
0 - *
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.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
PlanDefinition.asNeeded[x]
Id
PlanDefinition.asNeeded[x]
Type
Cardinality
0 - 1
Definition
If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc.
Comment
Binding
Strength
example
Description
A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children