US Public Health Profiles Library
2.0.0 -
US Public Health Profiles Library, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-us-ph-library/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-plandefinition | Version: 2.0.0 | |||
| Standards status: Trial-use Active as of 2025-10-23 | Maturity Level: 3 | Computable Name: USPublicHealthPlanDefinition | ||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.58.42.43 | ||||
This PlanDefinition profile describes the US Public Health PlanDefinition.
This profile is used to represent Knowledge Artifacts in US Public Health use cases.
It is based on the CRMI Shareable PlanDefinition profile.
Published value sets should conform to the CRMI Publishable PlanDefinition profile.
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 1..1 | CRMIShareablePlanDefinition(1.0.0) | US Public Health PlanDefinition Constraints: pdf-0 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) Constraints: ext-1 |
![]() ![]() ![]() |
S | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment Constraints: ext-1 |
![]() ![]() ![]() |
S | 0..1 | Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: version-algorithm (??) (extensible) Constraints: ext-1 |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: ValueSet Artifact Version Policy (extensible): The versioning policy of the artifact Constraints: ext-1 |
![]() ![]() ![]() |
S | 0..1 | Reference(Endpoint) | Indicates the address where the report has to be sent. URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-receiver-address-extension Constraints: ext-1 |
![]() ![]() ![]() |
S | 0..1 | boolean | US Public Health Async Indicator Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-async-indicator-extension Constraints: ext-1 |
![]() ![]() ![]() |
S | 0..1 | boolean | US Public Health Data Encrypted Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encrypted-extension Constraints: ext-1 |
![]() ![]() ![]() |
S | 0..1 | url | US Public Health Receiver Jwks Url URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-receiver-jwks-url-extension Constraints: ext-1 |
![]() ![]() ![]() |
S | 0..1 | code | US Public Health Data Encryption Algorithm URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encryption-algorithm-extension Constraints: ext-1 |
![]() ![]() ![]() |
S | 0..1 | Duration | US Public Health Expected Response Time Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-expected-response-time-extension Constraints: ext-1 |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
![]() ![]() |
SΣ | 1..1 | uri | Canonical identifier for this plan definition, represented as a URI (globally unique) |
![]() ![]() |
SΣ | 1..1 | string | Business version of the plan definition |
![]() ![]() |
SΣC | 1..1 | string | Name for this plan definition (computer friendly) |
![]() ![]() |
SΣ | 1..1 | string | Name for this plan definition (human friendly) |
![]() ![]() |
SΣ | 1..1 | CodeableConcept | Type of this PlanDefinition Binding: PlanDefinitionType (extensible): The type of PlanDefinition. Required Pattern: At least the following |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type | |
![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: workflow-definition | |
![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system Fixed Value: Workflow Definition | |
![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() ![]() |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
![]() ![]() |
SΣ | 0..1 | boolean | For testing purposes, not real usage |
![]() ![]() |
S | 0..1 | Type of individual the plan definition is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). | |
![]() ![]() ![]() |
CodeableConcept | |||
![]() ![]() ![]() |
Reference(Group) | |||
![]() ![]() |
SΣ | 1..1 | dateTime | Date the PlanDefinition was last changed |
![]() ![]() |
SΣ | 0..1 | string | Name of the publisher (organization or individual) |
![]() ![]() |
SΣ | 1..1 | markdown | Natural language description of the plan definition |
![]() ![]() |
SΣ | 0..1 | Period | When the PlanDefinition is valid |
![]() ![]() ![]() |
ΣC | 1..1 | dateTime | The start of the time period when this PlanDefinition goes into effect |
![]() ![]() |
S | 0..* | canonical(Library) | Logic used by the plan definition |
![]() ![]() |
S | 0..* | BackboneElement | All constraints on action are intended to apply to any nested constraints. |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() |
S | 0..1 | string | Brief description of the action |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: USPublicHealthValueSetPlanDefinitionAction (2.0.0) (extensible): The set of actions that can be used to create plan definition |
![]() ![]() ![]() |
S | 0..* | TriggerDefinition | When the action should be triggered |
![]() ![]() ![]() ![]() |
1..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-named-eventtype-extension Binding: USPublicHealthValueSetTriggerDefinitionNamedEvent (2.0.0) (extensible): US Public Health TriggerDefinition NamedEvents Constraints: ext-1 |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Binding: TriggerType (required): The type of trigger. Fixed Value: named-event |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Whether or not the action is applicable |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() ![]() |
S | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions. |
![]() ![]() ![]() ![]() |
S | 0..1 | Expression | Boolean-valued expression |
![]() ![]() ![]() |
S | 0..* | DataRequirement | Input data requirements |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types. |
![]() ![]() ![]() |
S | 0..* | DataRequirement | Output data definition |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types. |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Relationship to another action |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() ![]() |
S | 1..1 | id | What action is this related to |
![]() ![]() ![]() ![]() |
S | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions. |
![]() ![]() ![]() ![]() |
0..1 | Time offset for the relationship Slice: Unordered, Open by type:$this | ||
![]() ![]() ![]() ![]() ![]() |
Duration | |||
![]() ![]() ![]() ![]() ![]() |
Range | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Duration | Time offset for the relationship |
![]() ![]() ![]() |
S | 0..1 | Duration | When the action should take place |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| PlanDefinition.type | Base | extensible | PlanDefinitionType | 📍4.0.1 | FHIR Std. |
| PlanDefinition.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| PlanDefinition.subject[x] | Base | extensible | Subject type | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.code | Base | extensible | US Public Health ValueSet - PlanDefinition Action | 📍2.0.0 | This IG |
| PlanDefinition.action.trigger.type | Base | required | TriggerType | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.input.type | Base | required | FHIRAllTypes | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.output.type | Base | required | FHIRAllTypes | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | PlanDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | PlanDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | PlanDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | PlanDefinition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | PlanDefinition | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | PlanDefinition.implicitRules, PlanDefinition.extension:knowledgeCapability, PlanDefinition.extension:artifactComment, PlanDefinition.extension:versionAlgorithm, PlanDefinition.extension:versionPolicy, PlanDefinition.extension:receiverAddress, PlanDefinition.extension:asyncIndicator, PlanDefinition.extension:contentEncrypted, PlanDefinition.extension:jwksForContentEncryption, PlanDefinition.extension:contentEncryptionAlgorithm, PlanDefinition.extension:expectedResponseDuration, PlanDefinition.modifierExtension, PlanDefinition.url, PlanDefinition.version, PlanDefinition.name, PlanDefinition.title, PlanDefinition.type, PlanDefinition.status, PlanDefinition.experimental, PlanDefinition.subject[x], PlanDefinition.date, PlanDefinition.publisher, PlanDefinition.description, PlanDefinition.effectivePeriod, PlanDefinition.effectivePeriod.start, PlanDefinition.library, PlanDefinition.action, PlanDefinition.action.modifierExtension, PlanDefinition.action.description, PlanDefinition.action.code, PlanDefinition.action.trigger, PlanDefinition.action.trigger.extension, PlanDefinition.action.trigger.extension:namedEventType, PlanDefinition.action.trigger.type, PlanDefinition.action.condition, PlanDefinition.action.condition.modifierExtension, PlanDefinition.action.condition.kind, PlanDefinition.action.condition.expression, PlanDefinition.action.input, PlanDefinition.action.input.type, PlanDefinition.action.output, PlanDefinition.action.output.type, PlanDefinition.action.relatedAction, PlanDefinition.action.relatedAction.modifierExtension, PlanDefinition.action.relatedAction.actionId, PlanDefinition.action.relatedAction.relationship, PlanDefinition.action.relatedAction.offset[x], PlanDefinition.action.relatedAction.offset[x]:offsetDuration, PlanDefinition.action.timing[x] | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | PlanDefinition.extension:knowledgeCapability, PlanDefinition.extension:artifactComment, PlanDefinition.extension:versionAlgorithm, PlanDefinition.extension:versionPolicy, PlanDefinition.extension:receiverAddress, PlanDefinition.extension:asyncIndicator, PlanDefinition.extension:contentEncrypted, PlanDefinition.extension:jwksForContentEncryption, PlanDefinition.extension:contentEncryptionAlgorithm, PlanDefinition.extension:expectedResponseDuration, PlanDefinition.modifierExtension, PlanDefinition.action.modifierExtension, PlanDefinition.action.trigger.extension, PlanDefinition.action.trigger.extension:namedEventType, PlanDefinition.action.condition.modifierExtension, PlanDefinition.action.relatedAction.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| pdf-0 | warning | PlanDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
1..1 | CRMIShareablePlanDefinition(1.0.0) | US Public Health PlanDefinition | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
S | 0..1 | Reference(Endpoint) | Indicates the address where the report has to be sent. URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-receiver-address-extension |
![]() ![]() ![]() |
S | 0..1 | boolean | US Public Health Async Indicator Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-async-indicator-extension |
![]() ![]() ![]() |
S | 0..1 | boolean | US Public Health Data Encrypted Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encrypted-extension |
![]() ![]() ![]() |
S | 0..1 | url | US Public Health Receiver Jwks Url URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-receiver-jwks-url-extension |
![]() ![]() ![]() |
S | 0..1 | code | US Public Health Data Encryption Algorithm URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encryption-algorithm-extension |
![]() ![]() ![]() |
S | 0..1 | Duration | US Public Health Expected Response Time Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-expected-response-time-extension |
![]() ![]() |
1..1 | string | Name for this plan definition (computer friendly) | |
![]() ![]() |
S | 1..1 | CodeableConcept | Type of this PlanDefinition Required Pattern: At least the following |
![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type | |
![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: workflow-definition | |
![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system Fixed Value: Workflow Definition | |
![]() ![]() |
S | 0..1 | CodeableConcept, Reference(Group) | Type of individual the plan definition is focused on |
![]() ![]() |
S | 1..1 | dateTime | Date the PlanDefinition was last changed |
![]() ![]() |
S | 0..1 | Period | When the PlanDefinition is valid |
![]() ![]() ![]() |
1..1 | dateTime | The start of the time period when this PlanDefinition goes into effect | |
![]() ![]() |
S | 0..* | canonical(Library) | Logic used by the plan definition |
![]() ![]() |
S | 0..* | BackboneElement | All constraints on action are intended to apply to any nested constraints. |
![]() ![]() ![]() |
S | 0..1 | string | Brief description of the action |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: USPublicHealthValueSetPlanDefinitionAction (2.0.0) (extensible): The set of actions that can be used to create plan definition |
![]() ![]() ![]() |
S | 0..* | TriggerDefinition | When the action should be triggered |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-named-eventtype-extension Binding: USPublicHealthValueSetTriggerDefinitionNamedEvent (2.0.0) (extensible): US Public Health TriggerDefinition NamedEvents |
![]() ![]() ![]() ![]() |
S | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Fixed Value: named-event |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Whether or not the action is applicable |
![]() ![]() ![]() ![]() |
S | 1..1 | code | applicability | start | stop |
![]() ![]() ![]() ![]() |
S | 0..1 | Expression | Boolean-valued expression |
![]() ![]() ![]() |
S | 0..* | DataRequirement | Input data requirements |
![]() ![]() ![]() ![]() |
S | 1..1 | code | The type of the required data |
![]() ![]() ![]() |
S | 0..* | DataRequirement | Output data definition |
![]() ![]() ![]() ![]() |
S | 1..1 | code | The type of the required data |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Relationship to another action |
![]() ![]() ![]() ![]() |
S | 1..1 | id | What action is this related to |
![]() ![]() ![]() ![]() |
S | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end |
![]() ![]() ![]() ![]() |
0..1 | Duration, Range | Time offset for the relationship Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Duration | Time offset for the relationship |
![]() ![]() ![]() |
S | 0..1 | Duration | When the action should take place |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| PlanDefinition.action.code | Base | extensible | US Public Health ValueSet - PlanDefinition Action | 📍2.0.0 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 1..1 | CRMIShareablePlanDefinition(1.0.0) | US Public Health PlanDefinition Constraints: pdf-0 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() |
S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) Constraints: ext-1 | ||||
![]() ![]() ![]() |
S | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment Constraints: ext-1 | ||||
![]() ![]() ![]() |
S | 0..1 | Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: version-algorithm (??) (extensible) Constraints: ext-1 | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: ValueSet Artifact Version Policy (extensible): The versioning policy of the artifact Constraints: ext-1 | ||||
![]() ![]() ![]() |
S | 0..1 | Reference(Endpoint) | Indicates the address where the report has to be sent. URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-receiver-address-extension Constraints: ext-1 | ||||
![]() ![]() ![]() |
S | 0..1 | boolean | US Public Health Async Indicator Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-async-indicator-extension Constraints: ext-1 | ||||
![]() ![]() ![]() |
S | 0..1 | boolean | US Public Health Data Encrypted Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encrypted-extension Constraints: ext-1 | ||||
![]() ![]() ![]() |
S | 0..1 | url | US Public Health Receiver Jwks Url URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-receiver-jwks-url-extension Constraints: ext-1 | ||||
![]() ![]() ![]() |
S | 0..1 | code | US Public Health Data Encryption Algorithm URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encryption-algorithm-extension Constraints: ext-1 | ||||
![]() ![]() ![]() |
S | 0..1 | Duration | US Public Health Expected Response Time Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-expected-response-time-extension Constraints: ext-1 | ||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
![]() ![]() |
SΣ | 1..1 | uri | Canonical identifier for this plan definition, represented as a URI (globally unique) | ||||
![]() ![]() |
Σ | 0..* | Identifier | Additional identifier for the plan definition | ||||
![]() ![]() |
SΣ | 1..1 | string | Business version of the plan definition | ||||
![]() ![]() |
SΣC | 1..1 | string | Name for this plan definition (computer friendly) | ||||
![]() ![]() |
SΣ | 1..1 | string | Name for this plan definition (human friendly) | ||||
![]() ![]() |
0..1 | string | Subordinate title of the plan definition | |||||
![]() ![]() |
SΣ | 1..1 | CodeableConcept | Type of this PlanDefinition Binding: PlanDefinitionType (extensible): The type of PlanDefinition. Required Pattern: At least the following | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: workflow-definition | |||||
![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system Fixed Value: Workflow Definition | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
![]() ![]() |
SΣ | 0..1 | boolean | For testing purposes, not real usage | ||||
![]() ![]() |
S | 0..1 | Type of individual the plan definition is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). | |||||
![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() |
Reference(Group) | |||||||
![]() ![]() |
SΣ | 1..1 | dateTime | Date the PlanDefinition was last changed | ||||
![]() ![]() |
SΣ | 0..1 | string | Name of the publisher (organization or individual) | ||||
![]() ![]() |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
![]() ![]() |
SΣ | 1..1 | markdown | Natural language description of the plan definition | ||||
![]() ![]() |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Intended jurisdiction for plan definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
![]() ![]() |
0..1 | markdown | Why this plan definition is defined | |||||
![]() ![]() |
0..1 | string | Describes the clinical usage of the plan | |||||
![]() ![]() |
0..1 | markdown | Use and/or publishing restrictions | |||||
![]() ![]() |
0..1 | date | When the plan definition was approved by publisher | |||||
![]() ![]() |
0..1 | date | When the plan definition was last reviewed | |||||
![]() ![]() |
SΣ | 0..1 | Period | When the PlanDefinition is valid | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 1..1 | dateTime | The start of the time period when this PlanDefinition goes into effect | ||||
![]() ![]() ![]() |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
![]() ![]() |
0..* | CodeableConcept | E.g. Education, Treatment, Assessment Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering. | |||||
![]() ![]() |
0..* | ContactDetail | Who authored the content | |||||
![]() ![]() |
0..* | ContactDetail | Who edited the content | |||||
![]() ![]() |
0..* | ContactDetail | Who reviewed the content | |||||
![]() ![]() |
0..* | ContactDetail | Who endorsed the content | |||||
![]() ![]() |
0..* | RelatedArtifact | Additional documentation, citations | |||||
![]() ![]() |
S | 0..* | canonical(Library) | Logic used by the plan definition | ||||
![]() ![]() |
0..* | BackboneElement | What the plan is trying to accomplish | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | E.g. Treatment, dietary, behavioral Binding: GoalCategory (example): Example codes for grouping goals for filtering or presentation. | |||||
![]() ![]() ![]() |
1..1 | CodeableConcept | Code or text describing the goal Binding: SNOMEDCTClinicalFindings (example): Describes goals that can be achieved. | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: GoalPriority (preferred): Indicates the level of importance associated with reaching or sustaining a goal. | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | When goal pursuit begins Binding: GoalStartEvent (example): Identifies the types of events that might trigger the start of a goal. | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | What does the goal address Binding: Condition/Problem/DiagnosisCodes (example): Identifies problems, conditions, issues, or concerns that goals may address. | |||||
![]() ![]() ![]() |
0..* | RelatedArtifact | Supporting documentation for the goal | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Target outcome for the goal | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | The parameter whose value is to be tracked Binding: LOINCCodes (example): Identifies types of parameters that can be tracked to determine goal achievement. | |||||
![]() ![]() ![]() ![]() |
0..1 | The target value to be achieved | ||||||
![]() ![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
0..1 | Duration | Reach goal within | |||||
![]() ![]() |
S | 0..* | BackboneElement | All constraints on action are intended to apply to any nested constraints. | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
0..1 | string | User-visible prefix for the action (e.g. 1. or A.) | |||||
![]() ![]() ![]() |
0..1 | string | User-visible title | |||||
![]() ![]() ![]() |
S | 0..1 | string | Brief description of the action | ||||
![]() ![]() ![]() |
0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system | |||||
![]() ![]() ![]() |
0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: USPublicHealthValueSetPlanDefinitionAction (2.0.0) (extensible): The set of actions that can be used to create plan definition | ||||
![]() ![]() ![]() |
0..* | CodeableConcept | Why the action should be performed | |||||
![]() ![]() ![]() |
0..* | RelatedArtifact | Supporting documentation for the intended performer of the action | |||||
![]() ![]() ![]() |
0..* | id | What goals this action supports | |||||
![]() ![]() ![]() |
0..1 | Type of individual the action is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). | ||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Reference(Group) | |||||||
![]() ![]() ![]() |
S | 0..* | TriggerDefinition | When the action should be triggered | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
1..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-named-eventtype-extension Binding: USPublicHealthValueSetTriggerDefinitionNamedEvent (2.0.0) (extensible): US Public Health TriggerDefinition NamedEvents Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Binding: TriggerType (required): The type of trigger. Fixed Value: named-event | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Name or URI that identifies the event | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Timing of the event | |||||
![]() ![]() ![]() ![]() ![]() |
Timing | |||||||
![]() ![]() ![]() ![]() ![]() |
Reference(Schedule) | |||||||
![]() ![]() ![]() ![]() ![]() |
date | |||||||
![]() ![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | DataRequirement | Triggering data of the event (multiple = 'and') | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Expression | Whether the event triggers (boolean expression) | ||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | Whether or not the action is applicable | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions. | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | Expression | Boolean-valued expression | ||||
![]() ![]() ![]() |
S | 0..* | DataRequirement | Input data requirements | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | canonical(StructureDefinition) | The profile of the required data | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: SubjectType (extensible): The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.). | |||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() ![]() |
Reference(Group) | |||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..* | Element | What codes are expected Constraints: drq-1 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | A code-valued attribute to filter on | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | A coded (token) parameter to search on | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | canonical(ValueSet) | Valueset for the filter | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | What code is expected | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..* | Element | What dates/date ranges are expected Constraints: drq-2 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | A date-valued attribute to filter on | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | A date valued parameter to search on | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | The value of the filter, as a Period, DateTime, or Duration value | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Duration | |||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Number of results | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Element | Order of the results | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The name of the attribute to perform the sort | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | ascending | descending Binding: SortDirection (required): The possible sort directions, ascending or descending. | ||||
![]() ![]() ![]() |
S | 0..* | DataRequirement | Output data definition | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | canonical(StructureDefinition) | The profile of the required data | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: SubjectType (extensible): The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.). | |||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() ![]() |
Reference(Group) | |||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..* | Element | What codes are expected Constraints: drq-1 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | A code-valued attribute to filter on | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | A coded (token) parameter to search on | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | canonical(ValueSet) | Valueset for the filter | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | What code is expected | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..* | Element | What dates/date ranges are expected Constraints: drq-2 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | A date-valued attribute to filter on | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | A date valued parameter to search on | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | The value of the filter, as a Period, DateTime, or Duration value | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Duration | |||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Number of results | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Element | Order of the results | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The name of the attribute to perform the sort | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | ascending | descending Binding: SortDirection (required): The possible sort directions, ascending or descending. | ||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | Relationship to another action | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | id | What action is this related to | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions. | ||||
![]() ![]() ![]() ![]() |
0..1 | Time offset for the relationship Slice: Unordered, Open by type:$this | ||||||
![]() ![]() ![]() ![]() ![]() |
Duration | |||||||
![]() ![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Duration | Time offset for the relationship | ||||
![]() ![]() ![]() |
S | 0..1 | Duration | When the action should take place | ||||
![]() ![]() ![]() |
0..* | BackboneElement | Who should participate in the action | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action. | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example): Defines roles played by participants for the action. | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed. | |||||
![]() ![]() ![]() |
0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group. | |||||
![]() ![]() ![]() |
0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group. | |||||
![]() ![]() ![]() |
0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required. | |||||
![]() ![]() ![]() |
0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group. | |||||
![]() ![]() ![]() |
0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated. | |||||
![]() ![]() ![]() |
0..1 | Description of the activity to be performed | ||||||
![]() ![]() ![]() ![]() |
canonical(ActivityDefinition | PlanDefinition | Questionnaire) | |||||||
![]() ![]() ![]() ![]() |
uri | |||||||
![]() ![]() ![]() |
0..1 | canonical(StructureMap) | Transform to apply the template | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Dynamic aspects of the definition | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | The path to the element to be set dynamically | |||||
![]() ![]() ![]() ![]() |
0..1 | Expression | An expression that provides the dynamic value for the customization | |||||
![]() ![]() ![]() |
0..* | See action (PlanDefinition) | A sub-action | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| PlanDefinition.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| PlanDefinition.type | Base | extensible | PlanDefinitionType | 📍4.0.1 | FHIR Std. |
| PlanDefinition.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| PlanDefinition.subject[x] | Base | extensible | Subject type | 📍4.0.1 | FHIR Std. |
| PlanDefinition.jurisdiction | Base | extensible | Jurisdiction | 📍4.0.1 | FHIR Std. |
| PlanDefinition.topic | Base | example | DefinitionTopic | 📍4.0.1 | FHIR Std. |
| PlanDefinition.goal.category | Base | example | Goal category | 📍4.0.1 | FHIR Std. |
| PlanDefinition.goal.description | Base | example | SNOMED CT Clinical Findings | 📍4.0.1 | FHIR Std. |
| PlanDefinition.goal.priority | Base | preferred | Goal priority | 📍4.0.1 | FHIR Std. |
| PlanDefinition.goal.start | Base | example | Goal start event | 📍4.0.1 | FHIR Std. |
| PlanDefinition.goal.addresses | Base | example | Condition/Problem/Diagnosis Codes | 📍4.0.1 | FHIR Std. |
| PlanDefinition.goal.target.measure | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.code | Base | extensible | US Public Health ValueSet - PlanDefinition Action | 📍2.0.0 | This IG |
| PlanDefinition.action.subject[x] | Base | extensible | Subject type | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.trigger.type | Base | required | TriggerType | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.input.type | Base | required | FHIRAllTypes | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.input.subject[x] | Base | extensible | Subject type | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.input.sort.direction | Base | required | SortDirection | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.output.type | Base | required | FHIRAllTypes | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.output.subject[x] | Base | extensible | Subject type | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.output.sort.direction | Base | required | SortDirection | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.participant.type | Base | required | ActionParticipantType | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.participant.role | Base | example | Action participant role | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.type | Base | extensible | ActionType | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.groupingBehavior | Base | required | ActionGroupingBehavior | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.selectionBehavior | Base | required | ActionSelectionBehavior | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.requiredBehavior | Base | required | ActionRequiredBehavior | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.precheckBehavior | Base | required | ActionPrecheckBehavior | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.cardinalityBehavior | Base | required | ActionCardinalityBehavior | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | PlanDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | PlanDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | PlanDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | PlanDefinition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | PlanDefinition | A resource should have narrative for robust management |
text.`div`.exists()
|
| drq-1 | error | PlanDefinition.action.input.codeFilter, PlanDefinition.action.output.codeFilter | Either a path or a searchParam must be provided, but not both |
path.exists() xor searchParam.exists()
|
| drq-2 | error | PlanDefinition.action.input.dateFilter, PlanDefinition.action.output.dateFilter | Either a path or a searchParam must be provided, but not both |
path.exists() xor searchParam.exists()
|
| ele-1 | error | PlanDefinition.meta, PlanDefinition.implicitRules, PlanDefinition.language, PlanDefinition.text, PlanDefinition.extension, PlanDefinition.extension:knowledgeCapability, PlanDefinition.extension:artifactComment, PlanDefinition.extension:versionAlgorithm, PlanDefinition.extension:versionPolicy, PlanDefinition.extension:receiverAddress, PlanDefinition.extension:asyncIndicator, PlanDefinition.extension:contentEncrypted, PlanDefinition.extension:jwksForContentEncryption, PlanDefinition.extension:contentEncryptionAlgorithm, PlanDefinition.extension:expectedResponseDuration, PlanDefinition.modifierExtension, PlanDefinition.url, PlanDefinition.identifier, PlanDefinition.version, PlanDefinition.name, PlanDefinition.title, PlanDefinition.subtitle, PlanDefinition.type, PlanDefinition.status, PlanDefinition.experimental, PlanDefinition.subject[x], PlanDefinition.date, PlanDefinition.publisher, PlanDefinition.contact, PlanDefinition.description, PlanDefinition.useContext, PlanDefinition.jurisdiction, PlanDefinition.purpose, PlanDefinition.usage, PlanDefinition.copyright, PlanDefinition.approvalDate, PlanDefinition.lastReviewDate, PlanDefinition.effectivePeriod, PlanDefinition.effectivePeriod.extension, PlanDefinition.effectivePeriod.start, PlanDefinition.effectivePeriod.end, PlanDefinition.topic, PlanDefinition.author, PlanDefinition.editor, PlanDefinition.reviewer, PlanDefinition.endorser, PlanDefinition.relatedArtifact, PlanDefinition.library, PlanDefinition.goal, PlanDefinition.goal.extension, PlanDefinition.goal.modifierExtension, PlanDefinition.goal.category, PlanDefinition.goal.description, PlanDefinition.goal.priority, PlanDefinition.goal.start, PlanDefinition.goal.addresses, PlanDefinition.goal.documentation, PlanDefinition.goal.target, PlanDefinition.goal.target.extension, PlanDefinition.goal.target.modifierExtension, PlanDefinition.goal.target.measure, PlanDefinition.goal.target.detail[x], PlanDefinition.goal.target.due, PlanDefinition.action, PlanDefinition.action.extension, PlanDefinition.action.modifierExtension, PlanDefinition.action.prefix, PlanDefinition.action.title, PlanDefinition.action.description, PlanDefinition.action.textEquivalent, PlanDefinition.action.priority, PlanDefinition.action.code, PlanDefinition.action.reason, PlanDefinition.action.documentation, PlanDefinition.action.goalId, PlanDefinition.action.subject[x], PlanDefinition.action.trigger, PlanDefinition.action.trigger.extension, PlanDefinition.action.trigger.extension:namedEventType, PlanDefinition.action.trigger.type, PlanDefinition.action.trigger.name, PlanDefinition.action.trigger.timing[x], PlanDefinition.action.trigger.data, PlanDefinition.action.trigger.condition, PlanDefinition.action.condition, PlanDefinition.action.condition.extension, PlanDefinition.action.condition.modifierExtension, PlanDefinition.action.condition.kind, PlanDefinition.action.condition.expression, PlanDefinition.action.input, PlanDefinition.action.input.extension, PlanDefinition.action.input.type, PlanDefinition.action.input.profile, PlanDefinition.action.input.subject[x], PlanDefinition.action.input.mustSupport, PlanDefinition.action.input.codeFilter, PlanDefinition.action.input.codeFilter.extension, PlanDefinition.action.input.codeFilter.path, PlanDefinition.action.input.codeFilter.searchParam, PlanDefinition.action.input.codeFilter.valueSet, PlanDefinition.action.input.codeFilter.code, PlanDefinition.action.input.dateFilter, PlanDefinition.action.input.dateFilter.extension, PlanDefinition.action.input.dateFilter.path, PlanDefinition.action.input.dateFilter.searchParam, PlanDefinition.action.input.dateFilter.value[x], PlanDefinition.action.input.limit, PlanDefinition.action.input.sort, PlanDefinition.action.input.sort.extension, PlanDefinition.action.input.sort.path, PlanDefinition.action.input.sort.direction, PlanDefinition.action.output, PlanDefinition.action.output.extension, PlanDefinition.action.output.type, PlanDefinition.action.output.profile, PlanDefinition.action.output.subject[x], PlanDefinition.action.output.mustSupport, PlanDefinition.action.output.codeFilter, PlanDefinition.action.output.codeFilter.extension, PlanDefinition.action.output.codeFilter.path, PlanDefinition.action.output.codeFilter.searchParam, PlanDefinition.action.output.codeFilter.valueSet, PlanDefinition.action.output.codeFilter.code, PlanDefinition.action.output.dateFilter, PlanDefinition.action.output.dateFilter.extension, PlanDefinition.action.output.dateFilter.path, PlanDefinition.action.output.dateFilter.searchParam, PlanDefinition.action.output.dateFilter.value[x], PlanDefinition.action.output.limit, PlanDefinition.action.output.sort, PlanDefinition.action.output.sort.extension, PlanDefinition.action.output.sort.path, PlanDefinition.action.output.sort.direction, PlanDefinition.action.relatedAction, PlanDefinition.action.relatedAction.extension, PlanDefinition.action.relatedAction.modifierExtension, PlanDefinition.action.relatedAction.actionId, PlanDefinition.action.relatedAction.relationship, PlanDefinition.action.relatedAction.offset[x], PlanDefinition.action.relatedAction.offset[x]:offsetDuration, PlanDefinition.action.timing[x], PlanDefinition.action.participant, PlanDefinition.action.participant.extension, PlanDefinition.action.participant.modifierExtension, PlanDefinition.action.participant.type, PlanDefinition.action.participant.role, PlanDefinition.action.type, PlanDefinition.action.groupingBehavior, PlanDefinition.action.selectionBehavior, PlanDefinition.action.requiredBehavior, PlanDefinition.action.precheckBehavior, PlanDefinition.action.cardinalityBehavior, PlanDefinition.action.definition[x], PlanDefinition.action.transform, PlanDefinition.action.dynamicValue, PlanDefinition.action.dynamicValue.extension, PlanDefinition.action.dynamicValue.modifierExtension, PlanDefinition.action.dynamicValue.path, PlanDefinition.action.dynamicValue.expression, PlanDefinition.action.action | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | PlanDefinition.extension, PlanDefinition.extension:knowledgeCapability, PlanDefinition.extension:artifactComment, PlanDefinition.extension:versionAlgorithm, PlanDefinition.extension:versionPolicy, PlanDefinition.extension:receiverAddress, PlanDefinition.extension:asyncIndicator, PlanDefinition.extension:contentEncrypted, PlanDefinition.extension:jwksForContentEncryption, PlanDefinition.extension:contentEncryptionAlgorithm, PlanDefinition.extension:expectedResponseDuration, PlanDefinition.modifierExtension, PlanDefinition.effectivePeriod.extension, PlanDefinition.goal.extension, PlanDefinition.goal.modifierExtension, PlanDefinition.goal.target.extension, PlanDefinition.goal.target.modifierExtension, PlanDefinition.action.extension, PlanDefinition.action.modifierExtension, PlanDefinition.action.trigger.extension, PlanDefinition.action.trigger.extension:namedEventType, PlanDefinition.action.condition.extension, PlanDefinition.action.condition.modifierExtension, PlanDefinition.action.input.extension, PlanDefinition.action.input.codeFilter.extension, PlanDefinition.action.input.dateFilter.extension, PlanDefinition.action.input.sort.extension, PlanDefinition.action.output.extension, PlanDefinition.action.output.codeFilter.extension, PlanDefinition.action.output.dateFilter.extension, PlanDefinition.action.output.sort.extension, PlanDefinition.action.relatedAction.extension, PlanDefinition.action.relatedAction.modifierExtension, PlanDefinition.action.participant.extension, PlanDefinition.action.participant.modifierExtension, PlanDefinition.action.dynamicValue.extension, PlanDefinition.action.dynamicValue.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| pdf-0 | warning | PlanDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
Summary
Mandatory: 3 elements(1 nested mandatory element)
Must-Support: 29 elements
Fixed: 1 element
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 3
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 1..1 | CRMIShareablePlanDefinition(1.0.0) | US Public Health PlanDefinition Constraints: pdf-0 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) Constraints: ext-1 |
![]() ![]() ![]() |
S | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment Constraints: ext-1 |
![]() ![]() ![]() |
S | 0..1 | Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: version-algorithm (??) (extensible) Constraints: ext-1 |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: ValueSet Artifact Version Policy (extensible): The versioning policy of the artifact Constraints: ext-1 |
![]() ![]() ![]() |
S | 0..1 | Reference(Endpoint) | Indicates the address where the report has to be sent. URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-receiver-address-extension Constraints: ext-1 |
![]() ![]() ![]() |
S | 0..1 | boolean | US Public Health Async Indicator Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-async-indicator-extension Constraints: ext-1 |
![]() ![]() ![]() |
S | 0..1 | boolean | US Public Health Data Encrypted Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encrypted-extension Constraints: ext-1 |
![]() ![]() ![]() |
S | 0..1 | url | US Public Health Receiver Jwks Url URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-receiver-jwks-url-extension Constraints: ext-1 |
![]() ![]() ![]() |
S | 0..1 | code | US Public Health Data Encryption Algorithm URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encryption-algorithm-extension Constraints: ext-1 |
![]() ![]() ![]() |
S | 0..1 | Duration | US Public Health Expected Response Time Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-expected-response-time-extension Constraints: ext-1 |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
![]() ![]() |
SΣ | 1..1 | uri | Canonical identifier for this plan definition, represented as a URI (globally unique) |
![]() ![]() |
SΣ | 1..1 | string | Business version of the plan definition |
![]() ![]() |
SΣC | 1..1 | string | Name for this plan definition (computer friendly) |
![]() ![]() |
SΣ | 1..1 | string | Name for this plan definition (human friendly) |
![]() ![]() |
SΣ | 1..1 | CodeableConcept | Type of this PlanDefinition Binding: PlanDefinitionType (extensible): The type of PlanDefinition. Required Pattern: At least the following |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type | |
![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: workflow-definition | |
![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system Fixed Value: Workflow Definition | |
![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() ![]() |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
![]() ![]() |
SΣ | 0..1 | boolean | For testing purposes, not real usage |
![]() ![]() |
S | 0..1 | Type of individual the plan definition is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). | |
![]() ![]() ![]() |
CodeableConcept | |||
![]() ![]() ![]() |
Reference(Group) | |||
![]() ![]() |
SΣ | 1..1 | dateTime | Date the PlanDefinition was last changed |
![]() ![]() |
SΣ | 0..1 | string | Name of the publisher (organization or individual) |
![]() ![]() |
SΣ | 1..1 | markdown | Natural language description of the plan definition |
![]() ![]() |
SΣ | 0..1 | Period | When the PlanDefinition is valid |
![]() ![]() ![]() |
ΣC | 1..1 | dateTime | The start of the time period when this PlanDefinition goes into effect |
![]() ![]() |
S | 0..* | canonical(Library) | Logic used by the plan definition |
![]() ![]() |
S | 0..* | BackboneElement | All constraints on action are intended to apply to any nested constraints. |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() |
S | 0..1 | string | Brief description of the action |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: USPublicHealthValueSetPlanDefinitionAction (2.0.0) (extensible): The set of actions that can be used to create plan definition |
![]() ![]() ![]() |
S | 0..* | TriggerDefinition | When the action should be triggered |
![]() ![]() ![]() ![]() |
1..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-named-eventtype-extension Binding: USPublicHealthValueSetTriggerDefinitionNamedEvent (2.0.0) (extensible): US Public Health TriggerDefinition NamedEvents Constraints: ext-1 |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Binding: TriggerType (required): The type of trigger. Fixed Value: named-event |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Whether or not the action is applicable |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() ![]() |
S | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions. |
![]() ![]() ![]() ![]() |
S | 0..1 | Expression | Boolean-valued expression |
![]() ![]() ![]() |
S | 0..* | DataRequirement | Input data requirements |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types. |
![]() ![]() ![]() |
S | 0..* | DataRequirement | Output data definition |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types. |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Relationship to another action |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() ![]() |
S | 1..1 | id | What action is this related to |
![]() ![]() ![]() ![]() |
S | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions. |
![]() ![]() ![]() ![]() |
0..1 | Time offset for the relationship Slice: Unordered, Open by type:$this | ||
![]() ![]() ![]() ![]() ![]() |
Duration | |||
![]() ![]() ![]() ![]() ![]() |
Range | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Duration | Time offset for the relationship |
![]() ![]() ![]() |
S | 0..1 | Duration | When the action should take place |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| PlanDefinition.type | Base | extensible | PlanDefinitionType | 📍4.0.1 | FHIR Std. |
| PlanDefinition.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| PlanDefinition.subject[x] | Base | extensible | Subject type | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.code | Base | extensible | US Public Health ValueSet - PlanDefinition Action | 📍2.0.0 | This IG |
| PlanDefinition.action.trigger.type | Base | required | TriggerType | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.input.type | Base | required | FHIRAllTypes | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.output.type | Base | required | FHIRAllTypes | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | PlanDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | PlanDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | PlanDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | PlanDefinition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | PlanDefinition | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | PlanDefinition.implicitRules, PlanDefinition.extension:knowledgeCapability, PlanDefinition.extension:artifactComment, PlanDefinition.extension:versionAlgorithm, PlanDefinition.extension:versionPolicy, PlanDefinition.extension:receiverAddress, PlanDefinition.extension:asyncIndicator, PlanDefinition.extension:contentEncrypted, PlanDefinition.extension:jwksForContentEncryption, PlanDefinition.extension:contentEncryptionAlgorithm, PlanDefinition.extension:expectedResponseDuration, PlanDefinition.modifierExtension, PlanDefinition.url, PlanDefinition.version, PlanDefinition.name, PlanDefinition.title, PlanDefinition.type, PlanDefinition.status, PlanDefinition.experimental, PlanDefinition.subject[x], PlanDefinition.date, PlanDefinition.publisher, PlanDefinition.description, PlanDefinition.effectivePeriod, PlanDefinition.effectivePeriod.start, PlanDefinition.library, PlanDefinition.action, PlanDefinition.action.modifierExtension, PlanDefinition.action.description, PlanDefinition.action.code, PlanDefinition.action.trigger, PlanDefinition.action.trigger.extension, PlanDefinition.action.trigger.extension:namedEventType, PlanDefinition.action.trigger.type, PlanDefinition.action.condition, PlanDefinition.action.condition.modifierExtension, PlanDefinition.action.condition.kind, PlanDefinition.action.condition.expression, PlanDefinition.action.input, PlanDefinition.action.input.type, PlanDefinition.action.output, PlanDefinition.action.output.type, PlanDefinition.action.relatedAction, PlanDefinition.action.relatedAction.modifierExtension, PlanDefinition.action.relatedAction.actionId, PlanDefinition.action.relatedAction.relationship, PlanDefinition.action.relatedAction.offset[x], PlanDefinition.action.relatedAction.offset[x]:offsetDuration, PlanDefinition.action.timing[x] | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | PlanDefinition.extension:knowledgeCapability, PlanDefinition.extension:artifactComment, PlanDefinition.extension:versionAlgorithm, PlanDefinition.extension:versionPolicy, PlanDefinition.extension:receiverAddress, PlanDefinition.extension:asyncIndicator, PlanDefinition.extension:contentEncrypted, PlanDefinition.extension:jwksForContentEncryption, PlanDefinition.extension:contentEncryptionAlgorithm, PlanDefinition.extension:expectedResponseDuration, PlanDefinition.modifierExtension, PlanDefinition.action.modifierExtension, PlanDefinition.action.trigger.extension, PlanDefinition.action.trigger.extension:namedEventType, PlanDefinition.action.condition.modifierExtension, PlanDefinition.action.relatedAction.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| pdf-0 | warning | PlanDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
Differential View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
1..1 | CRMIShareablePlanDefinition(1.0.0) | US Public Health PlanDefinition | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
S | 0..1 | Reference(Endpoint) | Indicates the address where the report has to be sent. URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-receiver-address-extension |
![]() ![]() ![]() |
S | 0..1 | boolean | US Public Health Async Indicator Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-async-indicator-extension |
![]() ![]() ![]() |
S | 0..1 | boolean | US Public Health Data Encrypted Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encrypted-extension |
![]() ![]() ![]() |
S | 0..1 | url | US Public Health Receiver Jwks Url URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-receiver-jwks-url-extension |
![]() ![]() ![]() |
S | 0..1 | code | US Public Health Data Encryption Algorithm URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encryption-algorithm-extension |
![]() ![]() ![]() |
S | 0..1 | Duration | US Public Health Expected Response Time Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-expected-response-time-extension |
![]() ![]() |
1..1 | string | Name for this plan definition (computer friendly) | |
![]() ![]() |
S | 1..1 | CodeableConcept | Type of this PlanDefinition Required Pattern: At least the following |
![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type | |
![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: workflow-definition | |
![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system Fixed Value: Workflow Definition | |
![]() ![]() |
S | 0..1 | CodeableConcept, Reference(Group) | Type of individual the plan definition is focused on |
![]() ![]() |
S | 1..1 | dateTime | Date the PlanDefinition was last changed |
![]() ![]() |
S | 0..1 | Period | When the PlanDefinition is valid |
![]() ![]() ![]() |
1..1 | dateTime | The start of the time period when this PlanDefinition goes into effect | |
![]() ![]() |
S | 0..* | canonical(Library) | Logic used by the plan definition |
![]() ![]() |
S | 0..* | BackboneElement | All constraints on action are intended to apply to any nested constraints. |
![]() ![]() ![]() |
S | 0..1 | string | Brief description of the action |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: USPublicHealthValueSetPlanDefinitionAction (2.0.0) (extensible): The set of actions that can be used to create plan definition |
![]() ![]() ![]() |
S | 0..* | TriggerDefinition | When the action should be triggered |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-named-eventtype-extension Binding: USPublicHealthValueSetTriggerDefinitionNamedEvent (2.0.0) (extensible): US Public Health TriggerDefinition NamedEvents |
![]() ![]() ![]() ![]() |
S | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Fixed Value: named-event |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Whether or not the action is applicable |
![]() ![]() ![]() ![]() |
S | 1..1 | code | applicability | start | stop |
![]() ![]() ![]() ![]() |
S | 0..1 | Expression | Boolean-valued expression |
![]() ![]() ![]() |
S | 0..* | DataRequirement | Input data requirements |
![]() ![]() ![]() ![]() |
S | 1..1 | code | The type of the required data |
![]() ![]() ![]() |
S | 0..* | DataRequirement | Output data definition |
![]() ![]() ![]() ![]() |
S | 1..1 | code | The type of the required data |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Relationship to another action |
![]() ![]() ![]() ![]() |
S | 1..1 | id | What action is this related to |
![]() ![]() ![]() ![]() |
S | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end |
![]() ![]() ![]() ![]() |
0..1 | Duration, Range | Time offset for the relationship Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Duration | Time offset for the relationship |
![]() ![]() ![]() |
S | 0..1 | Duration | When the action should take place |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| PlanDefinition.action.code | Base | extensible | US Public Health ValueSet - PlanDefinition Action | 📍2.0.0 | This IG |
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 1..1 | CRMIShareablePlanDefinition(1.0.0) | US Public Health PlanDefinition Constraints: pdf-0 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() |
S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) Constraints: ext-1 | ||||
![]() ![]() ![]() |
S | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment Constraints: ext-1 | ||||
![]() ![]() ![]() |
S | 0..1 | Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: version-algorithm (??) (extensible) Constraints: ext-1 | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: ValueSet Artifact Version Policy (extensible): The versioning policy of the artifact Constraints: ext-1 | ||||
![]() ![]() ![]() |
S | 0..1 | Reference(Endpoint) | Indicates the address where the report has to be sent. URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-receiver-address-extension Constraints: ext-1 | ||||
![]() ![]() ![]() |
S | 0..1 | boolean | US Public Health Async Indicator Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-async-indicator-extension Constraints: ext-1 | ||||
![]() ![]() ![]() |
S | 0..1 | boolean | US Public Health Data Encrypted Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encrypted-extension Constraints: ext-1 | ||||
![]() ![]() ![]() |
S | 0..1 | url | US Public Health Receiver Jwks Url URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-receiver-jwks-url-extension Constraints: ext-1 | ||||
![]() ![]() ![]() |
S | 0..1 | code | US Public Health Data Encryption Algorithm URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encryption-algorithm-extension Constraints: ext-1 | ||||
![]() ![]() ![]() |
S | 0..1 | Duration | US Public Health Expected Response Time Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-expected-response-time-extension Constraints: ext-1 | ||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
![]() ![]() |
SΣ | 1..1 | uri | Canonical identifier for this plan definition, represented as a URI (globally unique) | ||||
![]() ![]() |
Σ | 0..* | Identifier | Additional identifier for the plan definition | ||||
![]() ![]() |
SΣ | 1..1 | string | Business version of the plan definition | ||||
![]() ![]() |
SΣC | 1..1 | string | Name for this plan definition (computer friendly) | ||||
![]() ![]() |
SΣ | 1..1 | string | Name for this plan definition (human friendly) | ||||
![]() ![]() |
0..1 | string | Subordinate title of the plan definition | |||||
![]() ![]() |
SΣ | 1..1 | CodeableConcept | Type of this PlanDefinition Binding: PlanDefinitionType (extensible): The type of PlanDefinition. Required Pattern: At least the following | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: workflow-definition | |||||
![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system Fixed Value: Workflow Definition | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
![]() ![]() |
SΣ | 0..1 | boolean | For testing purposes, not real usage | ||||
![]() ![]() |
S | 0..1 | Type of individual the plan definition is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). | |||||
![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() |
Reference(Group) | |||||||
![]() ![]() |
SΣ | 1..1 | dateTime | Date the PlanDefinition was last changed | ||||
![]() ![]() |
SΣ | 0..1 | string | Name of the publisher (organization or individual) | ||||
![]() ![]() |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
![]() ![]() |
SΣ | 1..1 | markdown | Natural language description of the plan definition | ||||
![]() ![]() |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Intended jurisdiction for plan definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
![]() ![]() |
0..1 | markdown | Why this plan definition is defined | |||||
![]() ![]() |
0..1 | string | Describes the clinical usage of the plan | |||||
![]() ![]() |
0..1 | markdown | Use and/or publishing restrictions | |||||
![]() ![]() |
0..1 | date | When the plan definition was approved by publisher | |||||
![]() ![]() |
0..1 | date | When the plan definition was last reviewed | |||||
![]() ![]() |
SΣ | 0..1 | Period | When the PlanDefinition is valid | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 1..1 | dateTime | The start of the time period when this PlanDefinition goes into effect | ||||
![]() ![]() ![]() |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
![]() ![]() |
0..* | CodeableConcept | E.g. Education, Treatment, Assessment Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering. | |||||
![]() ![]() |
0..* | ContactDetail | Who authored the content | |||||
![]() ![]() |
0..* | ContactDetail | Who edited the content | |||||
![]() ![]() |
0..* | ContactDetail | Who reviewed the content | |||||
![]() ![]() |
0..* | ContactDetail | Who endorsed the content | |||||
![]() ![]() |
0..* | RelatedArtifact | Additional documentation, citations | |||||
![]() ![]() |
S | 0..* | canonical(Library) | Logic used by the plan definition | ||||
![]() ![]() |
0..* | BackboneElement | What the plan is trying to accomplish | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | E.g. Treatment, dietary, behavioral Binding: GoalCategory (example): Example codes for grouping goals for filtering or presentation. | |||||
![]() ![]() ![]() |
1..1 | CodeableConcept | Code or text describing the goal Binding: SNOMEDCTClinicalFindings (example): Describes goals that can be achieved. | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: GoalPriority (preferred): Indicates the level of importance associated with reaching or sustaining a goal. | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | When goal pursuit begins Binding: GoalStartEvent (example): Identifies the types of events that might trigger the start of a goal. | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | What does the goal address Binding: Condition/Problem/DiagnosisCodes (example): Identifies problems, conditions, issues, or concerns that goals may address. | |||||
![]() ![]() ![]() |
0..* | RelatedArtifact | Supporting documentation for the goal | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Target outcome for the goal | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | The parameter whose value is to be tracked Binding: LOINCCodes (example): Identifies types of parameters that can be tracked to determine goal achievement. | |||||
![]() ![]() ![]() ![]() |
0..1 | The target value to be achieved | ||||||
![]() ![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
0..1 | Duration | Reach goal within | |||||
![]() ![]() |
S | 0..* | BackboneElement | All constraints on action are intended to apply to any nested constraints. | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
0..1 | string | User-visible prefix for the action (e.g. 1. or A.) | |||||
![]() ![]() ![]() |
0..1 | string | User-visible title | |||||
![]() ![]() ![]() |
S | 0..1 | string | Brief description of the action | ||||
![]() ![]() ![]() |
0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system | |||||
![]() ![]() ![]() |
0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: USPublicHealthValueSetPlanDefinitionAction (2.0.0) (extensible): The set of actions that can be used to create plan definition | ||||
![]() ![]() ![]() |
0..* | CodeableConcept | Why the action should be performed | |||||
![]() ![]() ![]() |
0..* | RelatedArtifact | Supporting documentation for the intended performer of the action | |||||
![]() ![]() ![]() |
0..* | id | What goals this action supports | |||||
![]() ![]() ![]() |
0..1 | Type of individual the action is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). | ||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Reference(Group) | |||||||
![]() ![]() ![]() |
S | 0..* | TriggerDefinition | When the action should be triggered | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
1..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-named-eventtype-extension Binding: USPublicHealthValueSetTriggerDefinitionNamedEvent (2.0.0) (extensible): US Public Health TriggerDefinition NamedEvents Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Binding: TriggerType (required): The type of trigger. Fixed Value: named-event | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Name or URI that identifies the event | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Timing of the event | |||||
![]() ![]() ![]() ![]() ![]() |
Timing | |||||||
![]() ![]() ![]() ![]() ![]() |
Reference(Schedule) | |||||||
![]() ![]() ![]() ![]() ![]() |
date | |||||||
![]() ![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | DataRequirement | Triggering data of the event (multiple = 'and') | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Expression | Whether the event triggers (boolean expression) | ||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | Whether or not the action is applicable | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions. | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | Expression | Boolean-valued expression | ||||
![]() ![]() ![]() |
S | 0..* | DataRequirement | Input data requirements | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | canonical(StructureDefinition) | The profile of the required data | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: SubjectType (extensible): The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.). | |||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() ![]() |
Reference(Group) | |||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..* | Element | What codes are expected Constraints: drq-1 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | A code-valued attribute to filter on | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | A coded (token) parameter to search on | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | canonical(ValueSet) | Valueset for the filter | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | What code is expected | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..* | Element | What dates/date ranges are expected Constraints: drq-2 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | A date-valued attribute to filter on | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | A date valued parameter to search on | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | The value of the filter, as a Period, DateTime, or Duration value | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Duration | |||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Number of results | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Element | Order of the results | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The name of the attribute to perform the sort | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | ascending | descending Binding: SortDirection (required): The possible sort directions, ascending or descending. | ||||
![]() ![]() ![]() |
S | 0..* | DataRequirement | Output data definition | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | canonical(StructureDefinition) | The profile of the required data | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: SubjectType (extensible): The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.). | |||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() ![]() |
Reference(Group) | |||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..* | Element | What codes are expected Constraints: drq-1 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | A code-valued attribute to filter on | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | A coded (token) parameter to search on | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | canonical(ValueSet) | Valueset for the filter | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | What code is expected | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..* | Element | What dates/date ranges are expected Constraints: drq-2 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | A date-valued attribute to filter on | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | A date valued parameter to search on | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | The value of the filter, as a Period, DateTime, or Duration value | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Duration | |||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Number of results | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Element | Order of the results | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The name of the attribute to perform the sort | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | ascending | descending Binding: SortDirection (required): The possible sort directions, ascending or descending. | ||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | Relationship to another action | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | id | What action is this related to | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions. | ||||
![]() ![]() ![]() ![]() |
0..1 | Time offset for the relationship Slice: Unordered, Open by type:$this | ||||||
![]() ![]() ![]() ![]() ![]() |
Duration | |||||||
![]() ![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Duration | Time offset for the relationship | ||||
![]() ![]() ![]() |
S | 0..1 | Duration | When the action should take place | ||||
![]() ![]() ![]() |
0..* | BackboneElement | Who should participate in the action | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action. | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example): Defines roles played by participants for the action. | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed. | |||||
![]() ![]() ![]() |
0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group. | |||||
![]() ![]() ![]() |
0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group. | |||||
![]() ![]() ![]() |
0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required. | |||||
![]() ![]() ![]() |
0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group. | |||||
![]() ![]() ![]() |
0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated. | |||||
![]() ![]() ![]() |
0..1 | Description of the activity to be performed | ||||||
![]() ![]() ![]() ![]() |
canonical(ActivityDefinition | PlanDefinition | Questionnaire) | |||||||
![]() ![]() ![]() ![]() |
uri | |||||||
![]() ![]() ![]() |
0..1 | canonical(StructureMap) | Transform to apply the template | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Dynamic aspects of the definition | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | The path to the element to be set dynamically | |||||
![]() ![]() ![]() ![]() |
0..1 | Expression | An expression that provides the dynamic value for the customization | |||||
![]() ![]() ![]() |
0..* | See action (PlanDefinition) | A sub-action | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| PlanDefinition.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| PlanDefinition.type | Base | extensible | PlanDefinitionType | 📍4.0.1 | FHIR Std. |
| PlanDefinition.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| PlanDefinition.subject[x] | Base | extensible | Subject type | 📍4.0.1 | FHIR Std. |
| PlanDefinition.jurisdiction | Base | extensible | Jurisdiction | 📍4.0.1 | FHIR Std. |
| PlanDefinition.topic | Base | example | DefinitionTopic | 📍4.0.1 | FHIR Std. |
| PlanDefinition.goal.category | Base | example | Goal category | 📍4.0.1 | FHIR Std. |
| PlanDefinition.goal.description | Base | example | SNOMED CT Clinical Findings | 📍4.0.1 | FHIR Std. |
| PlanDefinition.goal.priority | Base | preferred | Goal priority | 📍4.0.1 | FHIR Std. |
| PlanDefinition.goal.start | Base | example | Goal start event | 📍4.0.1 | FHIR Std. |
| PlanDefinition.goal.addresses | Base | example | Condition/Problem/Diagnosis Codes | 📍4.0.1 | FHIR Std. |
| PlanDefinition.goal.target.measure | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.code | Base | extensible | US Public Health ValueSet - PlanDefinition Action | 📍2.0.0 | This IG |
| PlanDefinition.action.subject[x] | Base | extensible | Subject type | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.trigger.type | Base | required | TriggerType | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.input.type | Base | required | FHIRAllTypes | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.input.subject[x] | Base | extensible | Subject type | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.input.sort.direction | Base | required | SortDirection | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.output.type | Base | required | FHIRAllTypes | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.output.subject[x] | Base | extensible | Subject type | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.output.sort.direction | Base | required | SortDirection | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.participant.type | Base | required | ActionParticipantType | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.participant.role | Base | example | Action participant role | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.type | Base | extensible | ActionType | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.groupingBehavior | Base | required | ActionGroupingBehavior | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.selectionBehavior | Base | required | ActionSelectionBehavior | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.requiredBehavior | Base | required | ActionRequiredBehavior | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.precheckBehavior | Base | required | ActionPrecheckBehavior | 📍4.0.1 | FHIR Std. |
| PlanDefinition.action.cardinalityBehavior | Base | required | ActionCardinalityBehavior | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | PlanDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | PlanDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | PlanDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | PlanDefinition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | PlanDefinition | A resource should have narrative for robust management |
text.`div`.exists()
|
| drq-1 | error | PlanDefinition.action.input.codeFilter, PlanDefinition.action.output.codeFilter | Either a path or a searchParam must be provided, but not both |
path.exists() xor searchParam.exists()
|
| drq-2 | error | PlanDefinition.action.input.dateFilter, PlanDefinition.action.output.dateFilter | Either a path or a searchParam must be provided, but not both |
path.exists() xor searchParam.exists()
|
| ele-1 | error | PlanDefinition.meta, PlanDefinition.implicitRules, PlanDefinition.language, PlanDefinition.text, PlanDefinition.extension, PlanDefinition.extension:knowledgeCapability, PlanDefinition.extension:artifactComment, PlanDefinition.extension:versionAlgorithm, PlanDefinition.extension:versionPolicy, PlanDefinition.extension:receiverAddress, PlanDefinition.extension:asyncIndicator, PlanDefinition.extension:contentEncrypted, PlanDefinition.extension:jwksForContentEncryption, PlanDefinition.extension:contentEncryptionAlgorithm, PlanDefinition.extension:expectedResponseDuration, PlanDefinition.modifierExtension, PlanDefinition.url, PlanDefinition.identifier, PlanDefinition.version, PlanDefinition.name, PlanDefinition.title, PlanDefinition.subtitle, PlanDefinition.type, PlanDefinition.status, PlanDefinition.experimental, PlanDefinition.subject[x], PlanDefinition.date, PlanDefinition.publisher, PlanDefinition.contact, PlanDefinition.description, PlanDefinition.useContext, PlanDefinition.jurisdiction, PlanDefinition.purpose, PlanDefinition.usage, PlanDefinition.copyright, PlanDefinition.approvalDate, PlanDefinition.lastReviewDate, PlanDefinition.effectivePeriod, PlanDefinition.effectivePeriod.extension, PlanDefinition.effectivePeriod.start, PlanDefinition.effectivePeriod.end, PlanDefinition.topic, PlanDefinition.author, PlanDefinition.editor, PlanDefinition.reviewer, PlanDefinition.endorser, PlanDefinition.relatedArtifact, PlanDefinition.library, PlanDefinition.goal, PlanDefinition.goal.extension, PlanDefinition.goal.modifierExtension, PlanDefinition.goal.category, PlanDefinition.goal.description, PlanDefinition.goal.priority, PlanDefinition.goal.start, PlanDefinition.goal.addresses, PlanDefinition.goal.documentation, PlanDefinition.goal.target, PlanDefinition.goal.target.extension, PlanDefinition.goal.target.modifierExtension, PlanDefinition.goal.target.measure, PlanDefinition.goal.target.detail[x], PlanDefinition.goal.target.due, PlanDefinition.action, PlanDefinition.action.extension, PlanDefinition.action.modifierExtension, PlanDefinition.action.prefix, PlanDefinition.action.title, PlanDefinition.action.description, PlanDefinition.action.textEquivalent, PlanDefinition.action.priority, PlanDefinition.action.code, PlanDefinition.action.reason, PlanDefinition.action.documentation, PlanDefinition.action.goalId, PlanDefinition.action.subject[x], PlanDefinition.action.trigger, PlanDefinition.action.trigger.extension, PlanDefinition.action.trigger.extension:namedEventType, PlanDefinition.action.trigger.type, PlanDefinition.action.trigger.name, PlanDefinition.action.trigger.timing[x], PlanDefinition.action.trigger.data, PlanDefinition.action.trigger.condition, PlanDefinition.action.condition, PlanDefinition.action.condition.extension, PlanDefinition.action.condition.modifierExtension, PlanDefinition.action.condition.kind, PlanDefinition.action.condition.expression, PlanDefinition.action.input, PlanDefinition.action.input.extension, PlanDefinition.action.input.type, PlanDefinition.action.input.profile, PlanDefinition.action.input.subject[x], PlanDefinition.action.input.mustSupport, PlanDefinition.action.input.codeFilter, PlanDefinition.action.input.codeFilter.extension, PlanDefinition.action.input.codeFilter.path, PlanDefinition.action.input.codeFilter.searchParam, PlanDefinition.action.input.codeFilter.valueSet, PlanDefinition.action.input.codeFilter.code, PlanDefinition.action.input.dateFilter, PlanDefinition.action.input.dateFilter.extension, PlanDefinition.action.input.dateFilter.path, PlanDefinition.action.input.dateFilter.searchParam, PlanDefinition.action.input.dateFilter.value[x], PlanDefinition.action.input.limit, PlanDefinition.action.input.sort, PlanDefinition.action.input.sort.extension, PlanDefinition.action.input.sort.path, PlanDefinition.action.input.sort.direction, PlanDefinition.action.output, PlanDefinition.action.output.extension, PlanDefinition.action.output.type, PlanDefinition.action.output.profile, PlanDefinition.action.output.subject[x], PlanDefinition.action.output.mustSupport, PlanDefinition.action.output.codeFilter, PlanDefinition.action.output.codeFilter.extension, PlanDefinition.action.output.codeFilter.path, PlanDefinition.action.output.codeFilter.searchParam, PlanDefinition.action.output.codeFilter.valueSet, PlanDefinition.action.output.codeFilter.code, PlanDefinition.action.output.dateFilter, PlanDefinition.action.output.dateFilter.extension, PlanDefinition.action.output.dateFilter.path, PlanDefinition.action.output.dateFilter.searchParam, PlanDefinition.action.output.dateFilter.value[x], PlanDefinition.action.output.limit, PlanDefinition.action.output.sort, PlanDefinition.action.output.sort.extension, PlanDefinition.action.output.sort.path, PlanDefinition.action.output.sort.direction, PlanDefinition.action.relatedAction, PlanDefinition.action.relatedAction.extension, PlanDefinition.action.relatedAction.modifierExtension, PlanDefinition.action.relatedAction.actionId, PlanDefinition.action.relatedAction.relationship, PlanDefinition.action.relatedAction.offset[x], PlanDefinition.action.relatedAction.offset[x]:offsetDuration, PlanDefinition.action.timing[x], PlanDefinition.action.participant, PlanDefinition.action.participant.extension, PlanDefinition.action.participant.modifierExtension, PlanDefinition.action.participant.type, PlanDefinition.action.participant.role, PlanDefinition.action.type, PlanDefinition.action.groupingBehavior, PlanDefinition.action.selectionBehavior, PlanDefinition.action.requiredBehavior, PlanDefinition.action.precheckBehavior, PlanDefinition.action.cardinalityBehavior, PlanDefinition.action.definition[x], PlanDefinition.action.transform, PlanDefinition.action.dynamicValue, PlanDefinition.action.dynamicValue.extension, PlanDefinition.action.dynamicValue.modifierExtension, PlanDefinition.action.dynamicValue.path, PlanDefinition.action.dynamicValue.expression, PlanDefinition.action.action | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | PlanDefinition.extension, PlanDefinition.extension:knowledgeCapability, PlanDefinition.extension:artifactComment, PlanDefinition.extension:versionAlgorithm, PlanDefinition.extension:versionPolicy, PlanDefinition.extension:receiverAddress, PlanDefinition.extension:asyncIndicator, PlanDefinition.extension:contentEncrypted, PlanDefinition.extension:jwksForContentEncryption, PlanDefinition.extension:contentEncryptionAlgorithm, PlanDefinition.extension:expectedResponseDuration, PlanDefinition.modifierExtension, PlanDefinition.effectivePeriod.extension, PlanDefinition.goal.extension, PlanDefinition.goal.modifierExtension, PlanDefinition.goal.target.extension, PlanDefinition.goal.target.modifierExtension, PlanDefinition.action.extension, PlanDefinition.action.modifierExtension, PlanDefinition.action.trigger.extension, PlanDefinition.action.trigger.extension:namedEventType, PlanDefinition.action.condition.extension, PlanDefinition.action.condition.modifierExtension, PlanDefinition.action.input.extension, PlanDefinition.action.input.codeFilter.extension, PlanDefinition.action.input.dateFilter.extension, PlanDefinition.action.input.sort.extension, PlanDefinition.action.output.extension, PlanDefinition.action.output.codeFilter.extension, PlanDefinition.action.output.dateFilter.extension, PlanDefinition.action.output.sort.extension, PlanDefinition.action.relatedAction.extension, PlanDefinition.action.relatedAction.modifierExtension, PlanDefinition.action.participant.extension, PlanDefinition.action.participant.modifierExtension, PlanDefinition.action.dynamicValue.extension, PlanDefinition.action.dynamicValue.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| pdf-0 | warning | PlanDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
Summary
Mandatory: 3 elements(1 nested mandatory element)
Must-Support: 29 elements
Fixed: 1 element
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 3
Other representations of profile: CSV, Excel, Schematron