Left: | US Public Health PlanDefinition (http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-plandefinition) |
Right: | US Public Health PlanDefinition (http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-plandefinition) |
Error | StructureDefinition.version | Values for version differ: '1.1.0' vs '2.0.0' |
Information | StructureDefinition.date | Values for date differ: '2020-12-16T17:06:44+00:00' vs '2022-01-18T12:57:33+00:00' |
Warning | PlanDefinition | Elements differ in definition for mustSupport: 'true' vs 'false' |
Warning | PlanDefinition.extension | Elements differ in short: 'Additional content defined by implementations' vs 'Extension' |
Warning | PlanDefinition.extension | Elements differ in definition: 'May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.' vs 'An Extension' |
Information | PlanDefinition.type | Element minimum cardinalities differ: '0' vs '1' |
Warning | PlanDefinition.subject[x] | Elements differ in definition for mustSupport: 'false' vs 'true' |
Warning | PlanDefinition.date | Elements differ in short: 'Date the PlanDefinition was published' vs 'Date the PlanDefinition was last changed' |
Warning | PlanDefinition.date | Elements differ in definition: 'Date the PlanDefinition was published' vs 'Date the PlanDefinition was last changed' |
Warning | PlanDefinition.publisher | Elements differ in definition for mustSupport: 'false' vs 'true' |
Warning | PlanDefinition.effectivePeriod | Elements differ in short: 'When the PlanDefinition is expected to be used' vs 'When the PlanDefinition is valid' |
Warning | PlanDefinition.effectivePeriod | Elements differ in definition: 'The period during which the PlanDefinition is expected to be used' vs 'The period during which the PlanDefinition is valid' |
Warning | PlanDefinition.effectivePeriod.start | Elements differ in short: 'The start of the time period when this eRSD goes in effect' vs 'The start of the time period when this PlanDefinition goes into effect' |
Warning | PlanDefinition.effectivePeriod.start | Elements differ in definition: 'The start of the time period when this eRSD goes in effect' vs 'The start of the time period when this PlanDefinition goes into effect' |
Warning | PlanDefinition.action | Elements differ in short: 'Action defined by the plan' vs 'All constraints on action are intended to apply to any nested constraints.' |
Warning | PlanDefinition.action | Elements differ in definition for mustSupport: 'false' vs 'true' |
Warning | PlanDefinition.action.description | Elements differ in definition for mustSupport: 'false' vs 'true' |
Warning | PlanDefinition.action.code | Elements differ in definition for mustSupport: 'false' vs 'true' |
Information | PlanDefinition.action.code | Element maximum cardinalities differ: '2147483647' vs '1' |
Warning | PlanDefinition.action.trigger | Elements differ in definition for mustSupport: 'false' vs 'true' |
Warning | PlanDefinition.action.trigger.type | Elements differ in definition for mustSupport: 'false' vs 'true' |
Warning | PlanDefinition.action.condition | Elements differ in definition for mustSupport: 'false' vs 'true' |
Warning | PlanDefinition.action.condition.kind | Elements differ in definition for mustSupport: 'false' vs 'true' |
Warning | PlanDefinition.action.condition.expression | Elements differ in definition for mustSupport: 'false' vs 'true' |
Warning | PlanDefinition.action.input | Elements differ in definition for mustSupport: 'false' vs 'true' |
Warning | PlanDefinition.action.input.type | Elements differ in definition for mustSupport: 'false' vs 'true' |
Warning | PlanDefinition.action.output | Elements differ in definition for mustSupport: 'false' vs 'true' |
Warning | PlanDefinition.action.output.type | Elements differ in definition for mustSupport: 'false' vs 'true' |
Warning | PlanDefinition.action.relatedAction | Elements differ in definition for mustSupport: 'false' vs 'true' |
Warning | PlanDefinition.action.relatedAction.actionId | Elements differ in definition for mustSupport: 'false' vs 'true' |
Warning | PlanDefinition.action.relatedAction.relationship | Elements differ in definition for mustSupport: 'false' vs 'true' |
Warning | PlanDefinition.action.timing[x] | Elements differ in definition for mustSupport: 'false' vs 'true' |
Name | Value | Comments | |
---|---|---|---|
abstract | false | ||
baseDefinition | http://hl7.org/fhir/StructureDefinition/shareableplandefinition | ||
copyright | |||
date | 2020-12-16T17:06:44+00:00 | 2022-01-18T12:57:33+00:00 |
|
description | This profile describes the US Public Health PlanDefinition. | ||
experimental | false | ||
fhirVersion | 4.0.1 | ||
jurisdiction | |||
jurisdiction[0] | urn:iso:std:iso:3166#US | ||
kind | resource | ||
name | USPublicHealthPlanDefinition | ||
publisher | HL7 Public Health Work Group (http://www.hl7.org/Special/committees/pher/index.cfm) | ||
purpose | |||
status | active | ||
title | US Public Health PlanDefinition | ||
type | PlanDefinition | ||
url | http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-plandefinition | ||
version | 1.1.0 | 2.0.0 |
|
Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | L Type | L Description & Constraints | Comments |
---|---|---|---|---|---|---|---|---|---|
PlanDefinition | SI | 1..1 | Shareable PlanDefinition | US Public Health PlanDefinition | I | 1..1 | Shareable PlanDefinition | US Public Health PlanDefinition |
|
id | Σ | 0..1 | string | Logical id of this artifact | Σ | 0..1 | string | Logical id of this artifact | |
meta | Σ | 0..1 | Meta | Metadata about the resource | Σ | 0..1 | Meta | Metadata about the resource | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ?!Σ | 0..1 | uri | A set of rules under which this content was created | |
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||
contained | 0..* | Resource | Contained, inline Resources | 0..* | Resource | Contained, inline Resources | |||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| ||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ?! | 0..* | Extension | Extensions that cannot be ignored | |
url | Σ | 1..1 | uri | Canonical identifier for this plan definition, represented as a URI (globally unique) | Σ | 1..1 | uri | Canonical identifier for this plan definition, represented as a URI (globally unique) | |
identifier | SΣ | 0..* | Identifier | Additional identifier for the plan definition | SΣ | 0..* | Identifier | Additional identifier for the plan definition | |
version | SΣ | 1..1 | string | Business version of the PlanDefinition | SΣ | 1..1 | string | Business version of the PlanDefinition | |
name | SΣI | 1..1 | string | Name for this PlanDefinition (computer friendly) | SΣI | 1..1 | string | Name for this PlanDefinition (computer friendly) | |
title | SΣ | 1..1 | string | Title for this PlanDefinition | SΣ | 1..1 | string | Title for this PlanDefinition | |
subtitle | 0..1 | string | Subordinate title of the plan definition | 0..1 | string | Subordinate title of the plan definition | |||
type | SΣ | 0..1 | CodeableConcept | Type of this PlanDefinition Binding: PlanDefinitionType (extensible): The type of PlanDefinition. Fixed Value: {"coding":[{"system":"http://terminology.hl7.org/CodeSystem/plan-definition-type","code":"workflow-definition","display":"Workflow Definition"}]} | SΣ | 1..1 | CodeableConcept | Type of this PlanDefinition Binding: PlanDefinitionType (extensible): The type of PlanDefinition. Fixed Value: {"coding":[{"system":"http://terminology.hl7.org/CodeSystem/plan-definition-type","code":"workflow-definition","display":"Workflow Definition"}]} |
|
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | |
experimental | Σ | 1..1 | boolean | For testing purposes, not real usage | Σ | 1..1 | boolean | For testing purposes, not real usage | |
subject[x] | 0..1 | CodeableConcept, Reference(Group) | 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.). | S | 0..1 | CodeableConcept, Reference(Group) | 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.). |
| |
date | SΣ | 1..1 | dateTime | Date the PlanDefinition was published | SΣ | 1..1 | dateTime | Date the PlanDefinition was last changed |
|
publisher | Σ | 1..1 | string | Name of the agency that published this PlanDefinition | SΣ | 1..1 | string | Name of the agency that published this PlanDefinition |
|
contact | SΣ | 0..* | ContactDetail | Contact details for the publisher | SΣ | 0..* | ContactDetail | Contact details for the publisher | |
description | Σ | 1..1 | markdown | Natural language description of the plan definition | Σ | 1..1 | markdown | Natural language description of the plan definition | |
useContext | SΣ | 0..* | UsageContext | The context that the content is intended to support | SΣ | 0..* | UsageContext | The context that the content is intended to support | |
jurisdiction | SΣ | 0..* | CodeableConcept | Intended jurisdiction for plan definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | SΣ | 0..* | CodeableConcept | Intended jurisdiction for plan definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | |
purpose | 0..1 | markdown | Why this plan definition is defined | 0..1 | markdown | Why this plan definition is defined | |||
usage | 0..1 | string | Describes the clinical usage of the plan | 0..1 | string | Describes the clinical usage of the plan | |||
copyright | 0..1 | markdown | Use and/or publishing restrictions | 0..1 | markdown | Use and/or publishing restrictions | |||
approvalDate | 0..1 | date | When the plan definition was approved by publisher | 0..1 | date | When the plan definition was approved by publisher | |||
lastReviewDate | 0..1 | date | When the plan definition was last reviewed | 0..1 | date | When the plan definition was last reviewed | |||
effectivePeriod | SΣ | 0..1 | Period | When the PlanDefinition is expected to be used | SΣ | 0..1 | Period | When the PlanDefinition is valid |
|
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||
start | ΣI | 1..1 | dateTime | The start of the time period when this eRSD goes in effect | ΣI | 1..1 | dateTime | The start of the time period when this PlanDefinition goes into effect |
|
end | ΣI | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ΣI | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | |
topic | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering. | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering. | |||
author | 0..* | ContactDetail | Who authored the content | 0..* | ContactDetail | Who authored the content | |||
editor | 0..* | ContactDetail | Who edited the content | 0..* | ContactDetail | Who edited the content | |||
reviewer | 0..* | ContactDetail | Who reviewed the content | 0..* | ContactDetail | Who reviewed the content | |||
endorser | 0..* | ContactDetail | Who endorsed the content | 0..* | ContactDetail | Who endorsed the content | |||
relatedArtifact | 0..* | RelatedArtifact | Additional documentation, citations | 0..* | RelatedArtifact | Additional documentation, citations | |||
library | S | 0..* | canonical(Library) | Logic used by the plan definition | S | 0..* | canonical(Library) | Logic used by the plan definition | |
goal | 0..* | BackboneElement | What the plan is trying to accomplish | 0..* | BackboneElement | What the plan is trying to accomplish | |||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
category | 0..1 | CodeableConcept | E.g. Treatment, dietary, behavioral Binding: GoalCategory (example): Example codes for grouping goals for filtering or presentation. | 0..1 | CodeableConcept | E.g. Treatment, dietary, behavioral Binding: GoalCategory (example): Example codes for grouping goals for filtering or presentation. | |||
description | 1..1 | CodeableConcept | Code or text describing the goal Binding: SNOMEDCTClinicalFindings (example): Describes goals that can be achieved. | 1..1 | CodeableConcept | Code or text describing the goal Binding: SNOMEDCTClinicalFindings (example): Describes goals that can be achieved. | |||
priority | 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 | high-priority | medium-priority | low-priority Binding: GoalPriority (preferred): Indicates the level of importance associated with reaching or sustaining a goal. | |||
start | 0..1 | CodeableConcept | When goal pursuit begins Binding: GoalStartEvent (example): Identifies the types of events that might trigger the start of 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. | |||
addresses | 0..* | CodeableConcept | What does the goal address Binding: Condition/Problem/DiagnosisCodes (example): Identifies problems, conditions, issues, or concerns that goals may address. | 0..* | CodeableConcept | What does the goal address Binding: Condition/Problem/DiagnosisCodes (example): Identifies problems, conditions, issues, or concerns that goals may address. | |||
documentation | 0..* | RelatedArtifact | Supporting documentation for the goal | 0..* | RelatedArtifact | Supporting documentation for the goal | |||
target | 0..* | BackboneElement | Target outcome for the goal | 0..* | BackboneElement | Target outcome for the goal | |||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
measure | 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 | CodeableConcept | The parameter whose value is to be tracked Binding: LOINCCodes (example): Identifies types of parameters that can be tracked to determine goal achievement. | |||
detail[x] | 0..1 | Quantity, Range, CodeableConcept | The target value to be achieved | 0..1 | Quantity, Range, CodeableConcept | The target value to be achieved | |||
due | 0..1 | Duration | Reach goal within | 0..1 | Duration | Reach goal within | |||
action | 0..* | BackboneElement | Action defined by the plan | S | 0..* | BackboneElement | All constraints on action are intended to apply to any nested constraints. |
| |
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
prefix | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.) | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.) | |||
title | 0..1 | string | User-visible title | 0..1 | string | User-visible title | |||
description | 0..1 | string | Brief description of the action | S | 0..1 | string | Brief description of the action |
| |
textEquivalent | 0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system | 0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system | |||
priority | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |||
code | 0..* | CodeableConcept | Code representing the meaning of the action or sub-actions | S | 0..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: US Public Health PlanDefinition Action (extensible): The set of actions that can be used to create plan definition |
| |
reason | 0..* | CodeableConcept | Why the action should be performed | 0..* | CodeableConcept | Why the action should be performed | |||
documentation | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action | |||
goalId | 0..* | id | What goals this action supports | 0..* | id | What goals this action supports | |||
subject[x] | 0..1 | CodeableConcept, Reference(Group) | 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.). | 0..1 | CodeableConcept, Reference(Group) | 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.). | |||
trigger | 0..* | TriggerDefinition | When the action should be triggered | S | 0..* | TriggerDefinition | When the action should be triggered |
| |
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||
type | Σ | 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. | 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 |
|
name | Σ | 0..1 | string | Name or URI that identifies the event | Σ | 0..1 | string | Name or URI that identifies the event | |
timing[x] | Σ | 0..1 | Timing, Reference(Schedule), date, dateTime | Timing of the event | Σ | 0..1 | Timing, Reference(Schedule), date, dateTime | Timing of the event | |
data | Σ | 0..* | DataRequirement | Triggering data of the event (multiple = 'and') | Σ | 0..* | DataRequirement | Triggering data of the event (multiple = 'and') | |
condition | Σ | 0..1 | Expression | Whether the event triggers (boolean expression) | Σ | 0..1 | Expression | Whether the event triggers (boolean expression) | |
condition | 0..* | BackboneElement | Whether or not the action is applicable | S | 0..* | BackboneElement | Whether or not the action is applicable |
| |
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
kind | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions. | S | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions. |
| |
expression | 0..1 | Expression | Boolean-valued expression | S | 0..1 | Expression | Boolean-valued expression |
| |
input | 0..* | DataRequirement | Input data requirements | S | 0..* | DataRequirement | Input data requirements |
| |
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||
type | Σ | 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Σ | 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. |
|
profile | Σ | 0..* | canonical(StructureDefinition) | The profile of the required data | Σ | 0..* | canonical(StructureDefinition) | The profile of the required data | |
subject[x] | Σ | 0..1 | CodeableConcept, Reference(Group) | 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.). | Σ | 0..1 | CodeableConcept, Reference(Group) | 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.). | |
mustSupport | Σ | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module | Σ | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module | |
codeFilter | ΣI | 0..* | Element | What codes are expected drq-1: Either a path or a searchParam must be provided, but not both | ΣI | 0..* | Element | What codes are expected drq-1: Either a path or a searchParam must be provided, but not both | |
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||
path | Σ | 0..1 | string | A code-valued attribute to filter on | Σ | 0..1 | string | A code-valued attribute to filter on | |
searchParam | Σ | 0..1 | string | A coded (token) parameter to search on | Σ | 0..1 | string | A coded (token) parameter to search on | |
valueSet | Σ | 0..1 | canonical(ValueSet) | Valueset for the filter | Σ | 0..1 | canonical(ValueSet) | Valueset for the filter | |
code | Σ | 0..* | Coding | What code is expected | Σ | 0..* | Coding | What code is expected | |
dateFilter | ΣI | 0..* | Element | What dates/date ranges are expected drq-2: Either a path or a searchParam must be provided, but not both | ΣI | 0..* | Element | What dates/date ranges are expected drq-2: Either a path or a searchParam must be provided, but not both | |
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||
path | Σ | 0..1 | string | A date-valued attribute to filter on | Σ | 0..1 | string | A date-valued attribute to filter on | |
searchParam | Σ | 0..1 | string | A date valued parameter to search on | Σ | 0..1 | string | A date valued parameter to search on | |
value[x] | Σ | 0..1 | dateTime, Period, Duration | The value of the filter, as a Period, DateTime, or Duration value | Σ | 0..1 | dateTime, Period, Duration | The value of the filter, as a Period, DateTime, or Duration value | |
limit | Σ | 0..1 | positiveInt | Number of results | Σ | 0..1 | positiveInt | Number of results | |
sort | Σ | 0..* | Element | Order of the results | Σ | 0..* | Element | Order of the results | |
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||
path | Σ | 1..1 | string | The name of the attribute to perform the sort | Σ | 1..1 | string | The name of the attribute to perform the sort | |
direction | Σ | 1..1 | code | ascending | descending Binding: SortDirection (required): The possible sort directions, ascending or descending. | Σ | 1..1 | code | ascending | descending Binding: SortDirection (required): The possible sort directions, ascending or descending. | |
output | 0..* | DataRequirement | Output data definition | S | 0..* | DataRequirement | Output data definition |
| |
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||
type | Σ | 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Σ | 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. |
|
profile | Σ | 0..* | canonical(StructureDefinition) | The profile of the required data | Σ | 0..* | canonical(StructureDefinition) | The profile of the required data | |
subject[x] | Σ | 0..1 | CodeableConcept, Reference(Group) | 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.). | Σ | 0..1 | CodeableConcept, Reference(Group) | 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.). | |
mustSupport | Σ | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module | Σ | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module | |
codeFilter | ΣI | 0..* | Element | What codes are expected drq-1: Either a path or a searchParam must be provided, but not both | ΣI | 0..* | Element | What codes are expected drq-1: Either a path or a searchParam must be provided, but not both | |
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||
path | Σ | 0..1 | string | A code-valued attribute to filter on | Σ | 0..1 | string | A code-valued attribute to filter on | |
searchParam | Σ | 0..1 | string | A coded (token) parameter to search on | Σ | 0..1 | string | A coded (token) parameter to search on | |
valueSet | Σ | 0..1 | canonical(ValueSet) | Valueset for the filter | Σ | 0..1 | canonical(ValueSet) | Valueset for the filter | |
code | Σ | 0..* | Coding | What code is expected | Σ | 0..* | Coding | What code is expected | |
dateFilter | ΣI | 0..* | Element | What dates/date ranges are expected drq-2: Either a path or a searchParam must be provided, but not both | ΣI | 0..* | Element | What dates/date ranges are expected drq-2: Either a path or a searchParam must be provided, but not both | |
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||
path | Σ | 0..1 | string | A date-valued attribute to filter on | Σ | 0..1 | string | A date-valued attribute to filter on | |
searchParam | Σ | 0..1 | string | A date valued parameter to search on | Σ | 0..1 | string | A date valued parameter to search on | |
value[x] | Σ | 0..1 | dateTime, Period, Duration | The value of the filter, as a Period, DateTime, or Duration value | Σ | 0..1 | dateTime, Period, Duration | The value of the filter, as a Period, DateTime, or Duration value | |
limit | Σ | 0..1 | positiveInt | Number of results | Σ | 0..1 | positiveInt | Number of results | |
sort | Σ | 0..* | Element | Order of the results | Σ | 0..* | Element | Order of the results | |
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||
path | Σ | 1..1 | string | The name of the attribute to perform the sort | Σ | 1..1 | string | The name of the attribute to perform the sort | |
direction | Σ | 1..1 | code | ascending | descending Binding: SortDirection (required): The possible sort directions, ascending or descending. | Σ | 1..1 | code | ascending | descending Binding: SortDirection (required): The possible sort directions, ascending or descending. | |
relatedAction | 0..* | BackboneElement | Relationship to another action | S | 0..* | BackboneElement | Relationship to another action |
| |
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
actionId | 1..1 | id | What action is this related to | S | 1..1 | id | What action is this related to |
| |
relationship | 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. | 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. |
| |
offset[x] | 0..1 | Duration, Range | Time offset for the relationship | 0..1 | Duration | Time offset for the relationship Slice: Unordered, Closed by type:$this | |||
timing[x] | 0..1 | dateTime, Age, Period, Duration, Range, Timing | When the action should take place | S | 0..1 | Duration | When the action should take place |
| |
participant | 0..* | BackboneElement | Who should participate in the action | 0..* | BackboneElement | Who should participate in the action | |||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
type | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action. | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action. | |||
role | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example): Defines roles played by participants for the action. | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example): Defines roles played by participants for the action. | |||
type | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed. | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed. | |||
groupingBehavior | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group. | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group. | |||
selectionBehavior | 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 | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group. | |||
requiredBehavior | 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 | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required. | |||
precheckBehavior | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group. | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group. | |||
cardinalityBehavior | 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 | code | single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated. | |||
definition[x] | 0..1 | canonical(ActivityDefinition | PlanDefinition | Questionnaire), uri | Description of the activity to be performed | 0..1 | canonical(ActivityDefinition | PlanDefinition | Questionnaire), uri | Description of the activity to be performed | |||
transform | 0..1 | canonical(StructureMap) | Transform to apply the template | 0..1 | canonical(StructureMap) | Transform to apply the template | |||
dynamicValue | 0..* | BackboneElement | Dynamic aspects of the definition | 0..* | BackboneElement | Dynamic aspects of the definition | |||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
path | 0..1 | string | The path to the element to be set dynamically | 0..1 | string | The path to the element to be set dynamically | |||
expression | 0..1 | Expression | An expression that provides the dynamic value for the customization | 0..1 | Expression | An expression that provides the dynamic value for the customization | |||
action | 0..* | See action (PlanDefinition) | A sub-action | 0..* | See action (PlanDefinition) | A sub-action | |||
Documentation for this format |