HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 2.1.2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/case-reporting/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-plandefinition | Version: 2.1.2 | |||
Active as of 2024-10-30 | Computable Name: USPublicHealthPlanDefinition | |||
Other Identifiers: OID:2.16.840.1.113883.4.642.40.46.42.63 |
This profile describes the US Public Health PlanDefinition.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Shareable PlanDefinition
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
1..1 | Shareable PlanDefinition | 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/ecr/StructureDefinition/us-ph-receiver-address-extension |
![]() ![]() ![]() |
S | 1..1 | string | Business version of the PlanDefinition |
![]() ![]() ![]() |
S | 1..1 | string | Name for this PlanDefinition (computer friendly) |
![]() ![]() ![]() |
S | 1..1 | string | Title for this PlanDefinition |
![]() ![]() ![]() |
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 | 1..1 | string | Name of the agency that published this PlanDefinition |
![]() ![]() ![]() |
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: US Public Health PlanDefinition Action (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/ecr/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health TriggerDefinition NamedEvent (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 |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension |
![]() ![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Duration | Time offset for the relationship |
![]() ![]() ![]() ![]() |
S | 0..1 | Duration | When the action should take place |
![]() |
Path | Conformance | ValueSet | URI |
PlanDefinition.action.code | extensible | USPublicHealthPlanDefinitionAction (a valid code from US Public Health PlanDefinition Action Codes)http://hl7.org/fhir/us/ecr/ValueSet/us-ph-plandefinition-action from this IG | |
PlanDefinition.action.trigger.extension:namedEventType [CanonicalType[http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension]] | extensible | USPublicHealthTriggerDefinitionNamedEvent (a valid code from US Public Health TriggerDefinition NamedEvents)http://hl7.org/fhir/us/ecr/ValueSet/us-ph-triggerdefinition-namedevent from this IG |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 1..1 | Shareable PlanDefinition | US Public Health PlanDefinition pdf-0: Name should be usable as an identifier for the module by machine processing applications such as code generation |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
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/ecr/StructureDefinition/us-ph-receiver-address-extension |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
Σ | 1..1 | uri | Canonical identifier for this plan definition, represented as a URI (globally unique) |
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Additional identifier for the plan definition |
![]() ![]() ![]() |
SΣ | 1..1 | string | Business version of the PlanDefinition |
![]() ![]() ![]() |
SΣC | 1..1 | string | Name for this PlanDefinition (computer friendly) |
![]() ![]() ![]() |
SΣ | 1..1 | string | Title for this PlanDefinition |
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Type of this PlanDefinition Binding: PlanDefinitionType (extensible): The type of 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 | |
![]() ![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
![]() ![]() ![]() |
Σ | 1..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Σ | 1..1 | string | Name of the agency that published this PlanDefinition |
![]() ![]() ![]() |
SΣ | 0..* | ContactDetail | Contact details for the publisher |
![]() ![]() ![]() |
Σ | 1..1 | markdown | Natural language description of the plan definition |
![]() ![]() ![]() |
SΣ | 0..* | UsageContext | The context that the content is intended to support |
![]() ![]() ![]() |
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..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 |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Brief description of the action |
![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() |
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/ecr/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health TriggerDefinition NamedEvent (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 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 |
![]() ![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension |
![]() ![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() |
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 |
![]() |
Path | Conformance | ValueSet / Code | URI |
PlanDefinition.type | extensible | Pattern: workflow-definition("Workflow Definition")http://hl7.org/fhir/ValueSet/plan-definition-type from the FHIR Standard | |
PlanDefinition.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard | |
PlanDefinition.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-type from the FHIR Standard | |
PlanDefinition.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard | |
PlanDefinition.action.code | extensible | USPublicHealthPlanDefinitionAction (a valid code from US Public Health PlanDefinition Action Codes)http://hl7.org/fhir/us/ecr/ValueSet/us-ph-plandefinition-action from this IG | |
PlanDefinition.action.trigger.type | required | Fixed Value: named-eventhttp://hl7.org/fhir/ValueSet/trigger-type|4.0.1 from the FHIR Standard | |
PlanDefinition.action.condition.kind | required | ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1 from the FHIR Standard | |
PlanDefinition.action.input.type | required | FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1 from the FHIR Standard | |
PlanDefinition.action.output.type | required | FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1 from the FHIR Standard | |
PlanDefinition.action.relatedAction.relationship | required | ActionRelationshipTypehttp://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | 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![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 1..1 | Shareable PlanDefinition | US Public Health PlanDefinition pdf-0: Name should be usable as an identifier for the module by machine processing applications such as code generation | ||||
![]() ![]() ![]() |
Σ | 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 | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | Reference(Endpoint) | Indicates the address where the report has to be sent. URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-receiver-address-extension | ||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 1..1 | uri | Canonical identifier for this plan definition, represented as a URI (globally unique) | ||||
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Additional identifier for the plan definition | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Business version of the PlanDefinition | ||||
![]() ![]() ![]() |
SΣC | 1..1 | string | Name for this PlanDefinition (computer friendly) | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Title for this PlanDefinition | ||||
![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
![]() ![]() ![]() |
Σ | 1..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Σ | 1..1 | string | Name of the agency that published this PlanDefinition | ||||
![]() ![]() ![]() |
SΣ | 0..* | ContactDetail | Contact details for the publisher | ||||
![]() ![]() ![]() |
Σ | 1..1 | markdown | Natural language description of the plan definition | ||||
![]() ![]() ![]() |
SΣ | 0..* | UsageContext | The context that the content is intended to support | ||||
![]() ![]() ![]() |
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. | ||||
![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() |
Σ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 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
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: US Public Health PlanDefinition Action (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 | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health TriggerDefinition NamedEvent (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 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 | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension | ||||
![]() ![]() ![]() ![]() ![]() |
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 drq-1: Either a path or a searchParam must be provided, but not both | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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 drq-2: Either a path or a searchParam must be provided, but not both | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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 | |||||
![]() ![]() ![]() ![]() ![]() |
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 drq-1: Either a path or a searchParam must be provided, but not both | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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 drq-2: Either a path or a searchParam must be provided, but not both | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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 | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
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 | |||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
PlanDefinition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
PlanDefinition.type | extensible | Pattern: workflow-definition("Workflow Definition")http://hl7.org/fhir/ValueSet/plan-definition-type from the FHIR Standard | ||||
PlanDefinition.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard | ||||
PlanDefinition.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-type from the FHIR Standard | ||||
PlanDefinition.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard | ||||
PlanDefinition.topic | example | DefinitionTopichttp://hl7.org/fhir/ValueSet/definition-topic from the FHIR Standard | ||||
PlanDefinition.goal.category | example | GoalCategoryhttp://hl7.org/fhir/ValueSet/goal-category from the FHIR Standard | ||||
PlanDefinition.goal.description | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard | ||||
PlanDefinition.goal.priority | preferred | GoalPriorityhttp://hl7.org/fhir/ValueSet/goal-priority from the FHIR Standard | ||||
PlanDefinition.goal.start | example | GoalStartEventhttp://hl7.org/fhir/ValueSet/goal-start-event from the FHIR Standard | ||||
PlanDefinition.goal.addresses | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard | ||||
PlanDefinition.goal.target.measure | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes from the FHIR Standard | ||||
PlanDefinition.action.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard | ||||
PlanDefinition.action.code | extensible | USPublicHealthPlanDefinitionAction (a valid code from US Public Health PlanDefinition Action Codes)http://hl7.org/fhir/us/ecr/ValueSet/us-ph-plandefinition-action from this IG | ||||
PlanDefinition.action.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-type from the FHIR Standard | ||||
PlanDefinition.action.trigger.type | required | Fixed Value: named-eventhttp://hl7.org/fhir/ValueSet/trigger-type|4.0.1 from the FHIR Standard | ||||
PlanDefinition.action.condition.kind | required | ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1 from the FHIR Standard | ||||
PlanDefinition.action.input.type | required | FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1 from the FHIR Standard | ||||
PlanDefinition.action.input.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-type from the FHIR Standard | ||||
PlanDefinition.action.input.sort.direction | required | SortDirectionhttp://hl7.org/fhir/ValueSet/sort-direction|4.0.1 from the FHIR Standard | ||||
PlanDefinition.action.output.type | required | FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1 from the FHIR Standard | ||||
PlanDefinition.action.output.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-type from the FHIR Standard | ||||
PlanDefinition.action.output.sort.direction | required | SortDirectionhttp://hl7.org/fhir/ValueSet/sort-direction|4.0.1 from the FHIR Standard | ||||
PlanDefinition.action.relatedAction.relationship | required | ActionRelationshipTypehttp://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1 from the FHIR Standard | ||||
PlanDefinition.action.participant.type | required | ActionParticipantTypehttp://hl7.org/fhir/ValueSet/action-participant-type|4.0.1 from the FHIR Standard | ||||
PlanDefinition.action.participant.role | example | ActionParticipantRolehttp://hl7.org/fhir/ValueSet/action-participant-role from the FHIR Standard | ||||
PlanDefinition.action.type | extensible | ActionTypehttp://hl7.org/fhir/ValueSet/action-type from the FHIR Standard | ||||
PlanDefinition.action.groupingBehavior | required | ActionGroupingBehaviorhttp://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.1 from the FHIR Standard | ||||
PlanDefinition.action.selectionBehavior | required | ActionSelectionBehaviorhttp://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.1 from the FHIR Standard | ||||
PlanDefinition.action.requiredBehavior | required | ActionRequiredBehaviorhttp://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1 from the FHIR Standard | ||||
PlanDefinition.action.precheckBehavior | required | ActionPrecheckBehaviorhttp://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1 from the FHIR Standard | ||||
PlanDefinition.action.cardinalityBehavior | required | ActionCardinalityBehaviorhttp://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | 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}') |
This structure is derived from Shareable PlanDefinition
Differential View
This structure is derived from Shareable PlanDefinition
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
1..1 | Shareable PlanDefinition | 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/ecr/StructureDefinition/us-ph-receiver-address-extension |
![]() ![]() ![]() |
S | 1..1 | string | Business version of the PlanDefinition |
![]() ![]() ![]() |
S | 1..1 | string | Name for this PlanDefinition (computer friendly) |
![]() ![]() ![]() |
S | 1..1 | string | Title for this PlanDefinition |
![]() ![]() ![]() |
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 | 1..1 | string | Name of the agency that published this PlanDefinition |
![]() ![]() ![]() |
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: US Public Health PlanDefinition Action (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/ecr/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health TriggerDefinition NamedEvent (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 |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension |
![]() ![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Duration | Time offset for the relationship |
![]() ![]() ![]() ![]() |
S | 0..1 | Duration | When the action should take place |
![]() |
Path | Conformance | ValueSet | URI |
PlanDefinition.action.code | extensible | USPublicHealthPlanDefinitionAction (a valid code from US Public Health PlanDefinition Action Codes)http://hl7.org/fhir/us/ecr/ValueSet/us-ph-plandefinition-action from this IG | |
PlanDefinition.action.trigger.extension:namedEventType [CanonicalType[http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension]] | extensible | USPublicHealthTriggerDefinitionNamedEvent (a valid code from US Public Health TriggerDefinition NamedEvents)http://hl7.org/fhir/us/ecr/ValueSet/us-ph-triggerdefinition-namedevent from this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 1..1 | Shareable PlanDefinition | US Public Health PlanDefinition pdf-0: Name should be usable as an identifier for the module by machine processing applications such as code generation |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
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/ecr/StructureDefinition/us-ph-receiver-address-extension |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
Σ | 1..1 | uri | Canonical identifier for this plan definition, represented as a URI (globally unique) |
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Additional identifier for the plan definition |
![]() ![]() ![]() |
SΣ | 1..1 | string | Business version of the PlanDefinition |
![]() ![]() ![]() |
SΣC | 1..1 | string | Name for this PlanDefinition (computer friendly) |
![]() ![]() ![]() |
SΣ | 1..1 | string | Title for this PlanDefinition |
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Type of this PlanDefinition Binding: PlanDefinitionType (extensible): The type of 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 | |
![]() ![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
![]() ![]() ![]() |
Σ | 1..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Σ | 1..1 | string | Name of the agency that published this PlanDefinition |
![]() ![]() ![]() |
SΣ | 0..* | ContactDetail | Contact details for the publisher |
![]() ![]() ![]() |
Σ | 1..1 | markdown | Natural language description of the plan definition |
![]() ![]() ![]() |
SΣ | 0..* | UsageContext | The context that the content is intended to support |
![]() ![]() ![]() |
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..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 |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Brief description of the action |
![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() |
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/ecr/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health TriggerDefinition NamedEvent (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 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 |
![]() ![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension |
![]() ![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() |
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 |
![]() |
Path | Conformance | ValueSet / Code | URI |
PlanDefinition.type | extensible | Pattern: workflow-definition("Workflow Definition")http://hl7.org/fhir/ValueSet/plan-definition-type from the FHIR Standard | |
PlanDefinition.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard | |
PlanDefinition.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-type from the FHIR Standard | |
PlanDefinition.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard | |
PlanDefinition.action.code | extensible | USPublicHealthPlanDefinitionAction (a valid code from US Public Health PlanDefinition Action Codes)http://hl7.org/fhir/us/ecr/ValueSet/us-ph-plandefinition-action from this IG | |
PlanDefinition.action.trigger.type | required | Fixed Value: named-eventhttp://hl7.org/fhir/ValueSet/trigger-type|4.0.1 from the FHIR Standard | |
PlanDefinition.action.condition.kind | required | ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1 from the FHIR Standard | |
PlanDefinition.action.input.type | required | FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1 from the FHIR Standard | |
PlanDefinition.action.output.type | required | FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1 from the FHIR Standard | |
PlanDefinition.action.relatedAction.relationship | required | ActionRelationshipTypehttp://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | 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}') |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 1..1 | Shareable PlanDefinition | US Public Health PlanDefinition pdf-0: Name should be usable as an identifier for the module by machine processing applications such as code generation | ||||
![]() ![]() ![]() |
Σ | 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 | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | Reference(Endpoint) | Indicates the address where the report has to be sent. URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-receiver-address-extension | ||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 1..1 | uri | Canonical identifier for this plan definition, represented as a URI (globally unique) | ||||
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Additional identifier for the plan definition | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Business version of the PlanDefinition | ||||
![]() ![]() ![]() |
SΣC | 1..1 | string | Name for this PlanDefinition (computer friendly) | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Title for this PlanDefinition | ||||
![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
![]() ![]() ![]() |
Σ | 1..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Σ | 1..1 | string | Name of the agency that published this PlanDefinition | ||||
![]() ![]() ![]() |
SΣ | 0..* | ContactDetail | Contact details for the publisher | ||||
![]() ![]() ![]() |
Σ | 1..1 | markdown | Natural language description of the plan definition | ||||
![]() ![]() ![]() |
SΣ | 0..* | UsageContext | The context that the content is intended to support | ||||
![]() ![]() ![]() |
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. | ||||
![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() |
Σ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 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
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: US Public Health PlanDefinition Action (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 | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-named-eventtype-extension Binding: US Public Health TriggerDefinition NamedEvent (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 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 | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension | ||||
![]() ![]() ![]() ![]() ![]() |
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 drq-1: Either a path or a searchParam must be provided, but not both | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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 drq-2: Either a path or a searchParam must be provided, but not both | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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 | |||||
![]() ![]() ![]() ![]() ![]() |
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 drq-1: Either a path or a searchParam must be provided, but not both | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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 drq-2: Either a path or a searchParam must be provided, but not both | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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 | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
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 | |||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
PlanDefinition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
PlanDefinition.type | extensible | Pattern: workflow-definition("Workflow Definition")http://hl7.org/fhir/ValueSet/plan-definition-type from the FHIR Standard | ||||
PlanDefinition.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard | ||||
PlanDefinition.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-type from the FHIR Standard | ||||
PlanDefinition.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard | ||||
PlanDefinition.topic | example | DefinitionTopichttp://hl7.org/fhir/ValueSet/definition-topic from the FHIR Standard | ||||
PlanDefinition.goal.category | example | GoalCategoryhttp://hl7.org/fhir/ValueSet/goal-category from the FHIR Standard | ||||
PlanDefinition.goal.description | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard | ||||
PlanDefinition.goal.priority | preferred | GoalPriorityhttp://hl7.org/fhir/ValueSet/goal-priority from the FHIR Standard | ||||
PlanDefinition.goal.start | example | GoalStartEventhttp://hl7.org/fhir/ValueSet/goal-start-event from the FHIR Standard | ||||
PlanDefinition.goal.addresses | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard | ||||
PlanDefinition.goal.target.measure | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes from the FHIR Standard | ||||
PlanDefinition.action.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard | ||||
PlanDefinition.action.code | extensible | USPublicHealthPlanDefinitionAction (a valid code from US Public Health PlanDefinition Action Codes)http://hl7.org/fhir/us/ecr/ValueSet/us-ph-plandefinition-action from this IG | ||||
PlanDefinition.action.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-type from the FHIR Standard | ||||
PlanDefinition.action.trigger.type | required | Fixed Value: named-eventhttp://hl7.org/fhir/ValueSet/trigger-type|4.0.1 from the FHIR Standard | ||||
PlanDefinition.action.condition.kind | required | ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1 from the FHIR Standard | ||||
PlanDefinition.action.input.type | required | FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1 from the FHIR Standard | ||||
PlanDefinition.action.input.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-type from the FHIR Standard | ||||
PlanDefinition.action.input.sort.direction | required | SortDirectionhttp://hl7.org/fhir/ValueSet/sort-direction|4.0.1 from the FHIR Standard | ||||
PlanDefinition.action.output.type | required | FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1 from the FHIR Standard | ||||
PlanDefinition.action.output.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-type from the FHIR Standard | ||||
PlanDefinition.action.output.sort.direction | required | SortDirectionhttp://hl7.org/fhir/ValueSet/sort-direction|4.0.1 from the FHIR Standard | ||||
PlanDefinition.action.relatedAction.relationship | required | ActionRelationshipTypehttp://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1 from the FHIR Standard | ||||
PlanDefinition.action.participant.type | required | ActionParticipantTypehttp://hl7.org/fhir/ValueSet/action-participant-type|4.0.1 from the FHIR Standard | ||||
PlanDefinition.action.participant.role | example | ActionParticipantRolehttp://hl7.org/fhir/ValueSet/action-participant-role from the FHIR Standard | ||||
PlanDefinition.action.type | extensible | ActionTypehttp://hl7.org/fhir/ValueSet/action-type from the FHIR Standard | ||||
PlanDefinition.action.groupingBehavior | required | ActionGroupingBehaviorhttp://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.1 from the FHIR Standard | ||||
PlanDefinition.action.selectionBehavior | required | ActionSelectionBehaviorhttp://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.1 from the FHIR Standard | ||||
PlanDefinition.action.requiredBehavior | required | ActionRequiredBehaviorhttp://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1 from the FHIR Standard | ||||
PlanDefinition.action.precheckBehavior | required | ActionPrecheckBehaviorhttp://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1 from the FHIR Standard | ||||
PlanDefinition.action.cardinalityBehavior | required | ActionCardinalityBehaviorhttp://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | 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}') |
This structure is derived from Shareable PlanDefinition
Other representations of profile: CSV, Excel, Schematron
IG © 2020+ HL7 International / Public Health. Package hl7.fhir.us.ecr#2.1.2 based on FHIR 4.0.1. Generated 2024-10-30
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change