HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm
2.1.2 - STU 2
HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm
2.1.2 - STU 2
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 |
|---|---|---|---|---|
  PlanDefinition |
1..1 | Shareable PlanDefinition | US Public Health PlanDefinition | |
  Slices for extension |
Content/Rules for all slices | |||
   receiverAddress |
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 |
  version |
S | 1..1 | string | Business version of the PlanDefinition |
| name |
S | 1..1 | string | Name for this PlanDefinition (computer friendly) |
| title |
S | 1..1 | string | Title for this PlanDefinition |
| type |
S | 1..1 | CodeableConcept | Type of this PlanDefinition Required Pattern: At least the following |
  coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
 system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: workflow-definition | |
 display |
1..1 | string | Representation defined by the system Fixed Value: Workflow Definition | |
| subject[x] |
S | 0..1 | CodeableConcept, Reference(Group) | Type of individual the plan definition is focused on |
| date |
S | 1..1 | dateTime | Date the PlanDefinition was last changed |
| publisher |
S | 1..1 | string | Name of the agency that published this PlanDefinition |
| effectivePeriod |
S | 0..1 | Period | When the PlanDefinition is valid |
| start |
1..1 | dateTime | The start of the time period when this PlanDefinition goes into effect | |
| library |
S | 0..* | canonical(Library) | Logic used by the plan definition |
| action |
S | 0..* | BackboneElement | All constraints on action are intended to apply to any nested constraints. |
| description |
S | 0..1 | string | Brief description of the action |
| code |
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 |
| trigger |
S | 0..* | TriggerDefinition | When the action should be triggered |
| Slices for extension |
Content/Rules for all slices | |||
| namedEventType |
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 |
 type |
S | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Fixed Value: named-event |
| condition |
S | 0..* | BackboneElement | Whether or not the action is applicable |
| kind |
S | 1..1 | code | applicability | start | stop |
| expression |
S | 0..1 | Expression | Boolean-valued expression |
| input |
S | 0..* | DataRequirement | Input data requirements |
| Slices for extension |
Content/Rules for all slices | |||
| relatedData |
S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension |
| type |
S | 1..1 | code | The type of the required data |
| output |
S | 0..* | DataRequirement | Output data definition |
| type |
S | 1..1 | code | The type of the required data |
| relatedAction |
S | 0..* | BackboneElement | Relationship to another action |
| actionId |
S | 1..1 | id | What action is this related to |
| relationship |
S | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end |
| offsetDuration |
S | 0..1 | Duration | Time offset for the relationship |
 timing[x] |
S | 0..1 | Duration | When the action should take place |
| Documentation for this format | ||||
| 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-actionfrom 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-namedeventfrom this IG |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PlanDefinition |
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 |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
Content/Rules for all slices | |||
| receiverAddress |
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 |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| url |
Σ | 1..1 | uri | Canonical identifier for this plan definition, represented as a URI (globally unique) |
| identifier |
SΣ | 0..* | Identifier | Additional identifier for the plan definition |
| version |
SΣ | 1..1 | string | Business version of the PlanDefinition |
| name |
SΣC | 1..1 | string | Name for this PlanDefinition (computer friendly) |
| title |
SΣ | 1..1 | string | Title for this PlanDefinition |
| type |
SΣ | 1..1 | CodeableConcept | Type of this PlanDefinition Binding: PlanDefinitionType (extensible): The type of PlanDefinition. Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: workflow-definition | |
| display |
1..1 | string | Representation defined by the system Fixed Value: Workflow Definition | |
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| experimental |
Σ | 1..1 | boolean | For testing purposes, not real usage |
 subject[x] |
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.). | |
| subjectCodeableConcept |
CodeableConcept | |||
 subjectReference |
Reference(Group) | |||
| date |
SΣ | 1..1 | dateTime | Date the PlanDefinition was last changed |
| publisher |
SΣ | 1..1 | string | Name of the agency that published this PlanDefinition |
| contact |
SΣ | 0..* | ContactDetail | Contact details for the publisher |
| description |
Σ | 1..1 | markdown | Natural language description of the plan definition |
| useContext |
SΣ | 0..* | UsageContext | The context that the content is intended to support |
| jurisdiction |
SΣ | 0..* | CodeableConcept | Intended jurisdiction for plan definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. |
| effectivePeriod |
SΣ | 0..1 | Period | When the PlanDefinition is valid |
| start |
ΣC | 1..1 | dateTime | The start of the time period when this PlanDefinition goes into effect |
| library |
S | 0..* | canonical(Library) | Logic used by the plan definition |
| action |
S | 0..* | BackboneElement | All constraints on action are intended to apply to any nested constraints. |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| description |
S | 0..1 | string | Brief description of the action |
| code |
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 |
| trigger |
S | 0..* | TriggerDefinition | When the action should be triggered |
| Slices for extension |
Content/Rules for all slices | |||
| namedEventType |
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 |
| type |
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 |
| condition |
S | 0..* | BackboneElement | Whether or not the action is applicable |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| kind |
S | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions. |
| expression |
S | 0..1 | Expression | Boolean-valued expression |
| input |
S | 0..* | DataRequirement | Input data requirements |
| Slices for extension |
Content/Rules for all slices | |||
| relatedData |
S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension |
| type |
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. |
| output |
S | 0..* | DataRequirement | Output data definition |
| type |
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. |
| relatedAction |
S | 0..* | BackboneElement | Relationship to another action |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| actionId |
S | 1..1 | id | What action is this related to |
| relationship |
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. |
| Slices for offset[x] |
0..1 | Time offset for the relationship Slice: Unordered, Open by type:$this | ||
 offsetDuration |
Duration | |||
| offsetRange |
Range | |||
| offset[x]:offsetDuration |
S | 0..1 | Duration | Time offset for the relationship |
| timing[x] |
S | 0..1 | Duration | When the action should take place |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| PlanDefinition.type | extensible | Pattern: workflow-definition("Workflow Definition")http://hl7.org/fhir/ValueSet/plan-definition-typefrom the FHIR Standard | |
| PlanDefinition.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | |
| PlanDefinition.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-typefrom the FHIR Standard | |
| PlanDefinition.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdictionfrom 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-actionfrom this IG | |
| PlanDefinition.action.trigger.type | required | Fixed Value: named-eventhttp://hl7.org/fhir/ValueSet/trigger-type|4.0.1from the FHIR Standard | |
| PlanDefinition.action.condition.kind | required | ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1from the FHIR Standard | |
| PlanDefinition.action.input.type | required | FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1from the FHIR Standard | |
| PlanDefinition.action.output.type | required | FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1from the FHIR Standard | |
| PlanDefinition.action.relatedAction.relationship | required | ActionRelationshipTypehttp://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1from 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 | ||||
|---|---|---|---|---|---|---|---|---|
| PlanDefinition |
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 | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| receiverAddress |
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 | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url |
Σ | 1..1 | uri | Canonical identifier for this plan definition, represented as a URI (globally unique) | ||||
| identifier |
SΣ | 0..* | Identifier | Additional identifier for the plan definition | ||||
| version |
SΣ | 1..1 | string | Business version of the PlanDefinition | ||||
| name |
SΣC | 1..1 | string | Name for this PlanDefinition (computer friendly) | ||||
| title |
SΣ | 1..1 | string | Title for this PlanDefinition | ||||
| subtitle |
0..1 | string | Subordinate title of the plan definition | |||||
| type |
SΣ | 1..1 | CodeableConcept | Type of this PlanDefinition Binding: PlanDefinitionType (extensible): The type of PlanDefinition. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: workflow-definition | |||||
| display |
1..1 | string | Representation defined by the system Fixed Value: Workflow Definition | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental |
Σ | 1..1 | boolean | For testing purposes, not real usage | ||||
| subject[x] |
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.). | |||||
| subjectCodeableConcept |
CodeableConcept | |||||||
| subjectReference |
Reference(Group) | |||||||
| date |
SΣ | 1..1 | dateTime | Date the PlanDefinition was last changed | ||||
| publisher |
SΣ | 1..1 | string | Name of the agency that published this PlanDefinition | ||||
| contact |
SΣ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description |
Σ | 1..1 | markdown | Natural language description of the plan definition | ||||
| useContext |
SΣ | 0..* | UsageContext | The context that the content is intended to support | ||||
| jurisdiction |
SΣ | 0..* | CodeableConcept | Intended jurisdiction for plan definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| purpose |
0..1 | markdown | Why this plan definition is defined | |||||
| usage |
0..1 | string | Describes the clinical usage of the plan | |||||
| copyright |
0..1 | markdown | Use and/or publishing restrictions | |||||
| approvalDate |
0..1 | date | When the plan definition was approved by publisher | |||||
| lastReviewDate |
0..1 | date | When the plan definition was last reviewed | |||||
| effectivePeriod |
SΣ | 0..1 | Period | When the PlanDefinition is valid | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start |
ΣC | 1..1 | dateTime | The start of the time period when this PlanDefinition goes into effect | ||||
| end |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
| topic |
0..* | CodeableConcept | E.g. Education, Treatment, Assessment Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering. | |||||
| author |
0..* | ContactDetail | Who authored the content | |||||
| editor |
0..* | ContactDetail | Who edited the content | |||||
| reviewer |
0..* | ContactDetail | Who reviewed the content | |||||
| endorser |
0..* | ContactDetail | Who endorsed the content | |||||
| relatedArtifact |
0..* | RelatedArtifact | Additional documentation, citations | |||||
| library |
S | 0..* | canonical(Library) | Logic used by the plan definition | ||||
| goal |
0..* | BackboneElement | What the plan is trying to accomplish | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| category |
0..1 | CodeableConcept | E.g. Treatment, dietary, behavioral Binding: GoalCategory (example): Example codes for grouping goals for filtering or presentation. | |||||
| description |
1..1 | CodeableConcept | Code or text describing the goal Binding: SNOMEDCTClinicalFindings (example): Describes goals that can be achieved. | |||||
| priority |
0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: GoalPriority (preferred): Indicates the level of importance associated with reaching or sustaining a goal. | |||||
| start |
0..1 | CodeableConcept | When goal pursuit begins Binding: GoalStartEvent (example): Identifies the types of events that might trigger the start of a goal. | |||||
| addresses |
0..* | CodeableConcept | What does the goal address Binding: Condition/Problem/DiagnosisCodes (example): Identifies problems, conditions, issues, or concerns that goals may address. | |||||
| documentation |
0..* | RelatedArtifact | Supporting documentation for the goal | |||||
| target |
0..* | BackboneElement | Target outcome for the goal | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| measure |
0..1 | CodeableConcept | The parameter whose value is to be tracked Binding: LOINCCodes (example): Identifies types of parameters that can be tracked to determine goal achievement. | |||||
| detail[x] |
0..1 | The target value to be achieved | ||||||
| detailQuantity |
Quantity | |||||||
| detailRange |
Range | |||||||
| detailCodeableConcept |
CodeableConcept | |||||||
| due |
0..1 | Duration | Reach goal within | |||||
| action |
S | 0..* | BackboneElement | All constraints on action are intended to apply to any nested constraints. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| prefix |
0..1 | string | User-visible prefix for the action (e.g. 1. or A.) | |||||
| title |
0..1 | string | User-visible title | |||||
| description |
S | 0..1 | string | Brief description of the action | ||||
| textEquivalent |
0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system | |||||
| priority |
0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |||||
| code |
S | 0..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: US Public Health PlanDefinition Action (extensible): The set of actions that can be used to create plan definition | ||||
| reason |
0..* | CodeableConcept | Why the action should be performed | |||||
| documentation |
0..* | RelatedArtifact | Supporting documentation for the intended performer of the action | |||||
| goalId |
0..* | id | What goals this action supports | |||||
| subject[x] |
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.). | ||||||
| subjectCodeableConcept |
CodeableConcept | |||||||
| subjectReference |
Reference(Group) | |||||||
| trigger |
S | 0..* | TriggerDefinition | When the action should be triggered | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| namedEventType |
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 | ||||
| type |
SΣ | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Binding: TriggerType (required): The type of trigger. Fixed Value: named-event | ||||
| name |
Σ | 0..1 | string | Name or URI that identifies the event | ||||
| timing[x] |
Σ | 0..1 | Timing of the event | |||||
| timingTiming |
Timing | |||||||
| timingReference |
Reference(Schedule) | |||||||
| timingDate |
date | |||||||
| timingDateTime |
dateTime | |||||||
| data |
Σ | 0..* | DataRequirement | Triggering data of the event (multiple = 'and') | ||||
| condition |
Σ | 0..1 | Expression | Whether the event triggers (boolean expression) | ||||
| condition |
S | 0..* | BackboneElement | Whether or not the action is applicable | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| kind |
S | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions. | ||||
| expression |
S | 0..1 | Expression | Boolean-valued expression | ||||
| input |
S | 0..* | DataRequirement | Input data requirements | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| relatedData |
S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension | ||||
| type |
SΣ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types. | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | The profile of the required data | ||||
| subject[x] |
Σ | 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.). | |||||
| subjectCodeableConcept |
CodeableConcept | |||||||
| subjectReference |
Reference(Group) | |||||||
| mustSupport |
Σ | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module | ||||
| codeFilter |
ΣC | 0..* | Element | What codes are expected drq-1: Either a path or a searchParam must be provided, but not both | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| path |
Σ | 0..1 | string | A code-valued attribute to filter on | ||||
| searchParam |
Σ | 0..1 | string | A coded (token) parameter to search on | ||||
| valueSet |
Σ | 0..1 | canonical(ValueSet) | Valueset for the filter | ||||
| code |
Σ | 0..* | Coding | What code is expected | ||||
| dateFilter |
ΣC | 0..* | Element | What dates/date ranges are expected drq-2: Either a path or a searchParam must be provided, but not both | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| path |
Σ | 0..1 | string | A date-valued attribute to filter on | ||||
| searchParam |
Σ | 0..1 | string | A date valued parameter to search on | ||||
| value[x] |
Σ | 0..1 | The value of the filter, as a Period, DateTime, or Duration value | |||||
| valueDateTime |
dateTime | |||||||
| valuePeriod |
Period | |||||||
| valueDuration |
Duration | |||||||
| limit |
Σ | 0..1 | positiveInt | Number of results | ||||
| sort |
Σ | 0..* | Element | Order of the results | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| path |
Σ | 1..1 | string | The name of the attribute to perform the sort | ||||
| direction |
Σ | 1..1 | code | ascending | descending Binding: SortDirection (required): The possible sort directions, ascending or descending. | ||||
| output |
S | 0..* | DataRequirement | Output data definition | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| type |
SΣ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types. | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | The profile of the required data | ||||
| subject[x] |
Σ | 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.). | |||||
| subjectCodeableConcept |
CodeableConcept | |||||||
| subjectReference |
Reference(Group) | |||||||
| mustSupport |
Σ | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module | ||||
| codeFilter |
ΣC | 0..* | Element | What codes are expected drq-1: Either a path or a searchParam must be provided, but not both | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| path |
Σ | 0..1 | string | A code-valued attribute to filter on | ||||
| searchParam |
Σ | 0..1 | string | A coded (token) parameter to search on | ||||
| valueSet |
Σ | 0..1 | canonical(ValueSet) | Valueset for the filter | ||||
| code |
Σ | 0..* | Coding | What code is expected | ||||
| dateFilter |
ΣC | 0..* | Element | What dates/date ranges are expected drq-2: Either a path or a searchParam must be provided, but not both | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| path |
Σ | 0..1 | string | A date-valued attribute to filter on | ||||
| searchParam |
Σ | 0..1 | string | A date valued parameter to search on | ||||
| value[x] |
Σ | 0..1 | The value of the filter, as a Period, DateTime, or Duration value | |||||
| valueDateTime |
dateTime | |||||||
| valuePeriod |
Period | |||||||
| valueDuration |
Duration | |||||||
| limit |
Σ | 0..1 | positiveInt | Number of results | ||||
| sort |
Σ | 0..* | Element | Order of the results | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| path |
Σ | 1..1 | string | The name of the attribute to perform the sort | ||||
| direction |
Σ | 1..1 | code | ascending | descending Binding: SortDirection (required): The possible sort directions, ascending or descending. | ||||
| relatedAction |
S | 0..* | BackboneElement | Relationship to another action | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| actionId |
S | 1..1 | id | What action is this related to | ||||
| relationship |
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. | ||||
| Slices for offset[x] |
0..1 | Time offset for the relationship Slice: Unordered, Open by type:$this | ||||||
| offsetDuration |
Duration | |||||||
| offsetRange |
Range | |||||||
| offset[x]:offsetDuration |
S | 0..1 | Duration | Time offset for the relationship | ||||
| timing[x] |
S | 0..1 | Duration | When the action should take place | ||||
| participant |
0..* | BackboneElement | Who should participate in the action | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action. | |||||
| role |
0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example): Defines roles played by participants for the action. | |||||
| type |
0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed. | |||||
| groupingBehavior |
0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group. | |||||
| selectionBehavior |
0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group. | |||||
| requiredBehavior |
0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required. | |||||
| precheckBehavior |
0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group. | |||||
| cardinalityBehavior |
0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated. | |||||
| definition[x] |
0..1 | Description of the activity to be performed | ||||||
| definitionCanonical |
canonical(ActivityDefinition | PlanDefinition | Questionnaire) | |||||||
| definitionUri |
uri | |||||||
| transform |
0..1 | canonical(StructureMap) | Transform to apply the template | |||||
| dynamicValue |
0..* | BackboneElement | Dynamic aspects of the definition | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| path |
0..1 | string | The path to the element to be set dynamically | |||||
| expression |
0..1 | Expression | An expression that provides the dynamic value for the customization | |||||
| action |
0..* | See action (PlanDefinition) | A sub-action | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| PlanDefinition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| PlanDefinition.type | extensible | Pattern: workflow-definition("Workflow Definition")http://hl7.org/fhir/ValueSet/plan-definition-typefrom the FHIR Standard | ||||
| PlanDefinition.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | ||||
| PlanDefinition.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-typefrom the FHIR Standard | ||||
| PlanDefinition.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdictionfrom the FHIR Standard | ||||
| PlanDefinition.topic | example | DefinitionTopichttp://hl7.org/fhir/ValueSet/definition-topicfrom the FHIR Standard | ||||
| PlanDefinition.goal.category | example | GoalCategoryhttp://hl7.org/fhir/ValueSet/goal-categoryfrom the FHIR Standard | ||||
| PlanDefinition.goal.description | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findingsfrom the FHIR Standard | ||||
| PlanDefinition.goal.priority | preferred | GoalPriorityhttp://hl7.org/fhir/ValueSet/goal-priorityfrom the FHIR Standard | ||||
| PlanDefinition.goal.start | example | GoalStartEventhttp://hl7.org/fhir/ValueSet/goal-start-eventfrom the FHIR Standard | ||||
| PlanDefinition.goal.addresses | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-codefrom the FHIR Standard | ||||
| PlanDefinition.goal.target.measure | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | ||||
| PlanDefinition.action.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from 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-actionfrom this IG | ||||
| PlanDefinition.action.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-typefrom the FHIR Standard | ||||
| PlanDefinition.action.trigger.type | required | Fixed Value: named-eventhttp://hl7.org/fhir/ValueSet/trigger-type|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.condition.kind | required | ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.input.type | required | FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.input.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-typefrom the FHIR Standard | ||||
| PlanDefinition.action.input.sort.direction | required | SortDirectionhttp://hl7.org/fhir/ValueSet/sort-direction|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.output.type | required | FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.output.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-typefrom the FHIR Standard | ||||
| PlanDefinition.action.output.sort.direction | required | SortDirectionhttp://hl7.org/fhir/ValueSet/sort-direction|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.relatedAction.relationship | required | ActionRelationshipTypehttp://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.participant.type | required | ActionParticipantTypehttp://hl7.org/fhir/ValueSet/action-participant-type|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.participant.role | example | ActionParticipantRolehttp://hl7.org/fhir/ValueSet/action-participant-rolefrom the FHIR Standard | ||||
| PlanDefinition.action.type | extensible | ActionTypehttp://hl7.org/fhir/ValueSet/action-typefrom the FHIR Standard | ||||
| PlanDefinition.action.groupingBehavior | required | ActionGroupingBehaviorhttp://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.selectionBehavior | required | ActionSelectionBehaviorhttp://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.requiredBehavior | required | ActionRequiredBehaviorhttp://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.precheckBehavior | required | ActionPrecheckBehaviorhttp://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.cardinalityBehavior | required | ActionCardinalityBehaviorhttp://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1from 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 |
|---|---|---|---|---|
| PlanDefinition |
1..1 | Shareable PlanDefinition | US Public Health PlanDefinition | |
| Slices for extension |
Content/Rules for all slices | |||
| receiverAddress |
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 |
| version |
S | 1..1 | string | Business version of the PlanDefinition |
| name |
S | 1..1 | string | Name for this PlanDefinition (computer friendly) |
| title |
S | 1..1 | string | Title for this PlanDefinition |
| type |
S | 1..1 | CodeableConcept | Type of this PlanDefinition Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: workflow-definition | |
| display |
1..1 | string | Representation defined by the system Fixed Value: Workflow Definition | |
| subject[x] |
S | 0..1 | CodeableConcept, Reference(Group) | Type of individual the plan definition is focused on |
| date |
S | 1..1 | dateTime | Date the PlanDefinition was last changed |
| publisher |
S | 1..1 | string | Name of the agency that published this PlanDefinition |
| effectivePeriod |
S | 0..1 | Period | When the PlanDefinition is valid |
| start |
1..1 | dateTime | The start of the time period when this PlanDefinition goes into effect | |
| library |
S | 0..* | canonical(Library) | Logic used by the plan definition |
| action |
S | 0..* | BackboneElement | All constraints on action are intended to apply to any nested constraints. |
| description |
S | 0..1 | string | Brief description of the action |
| code |
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 |
| trigger |
S | 0..* | TriggerDefinition | When the action should be triggered |
| Slices for extension |
Content/Rules for all slices | |||
| namedEventType |
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 |
| type |
S | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Fixed Value: named-event |
| condition |
S | 0..* | BackboneElement | Whether or not the action is applicable |
| kind |
S | 1..1 | code | applicability | start | stop |
| expression |
S | 0..1 | Expression | Boolean-valued expression |
| input |
S | 0..* | DataRequirement | Input data requirements |
| Slices for extension |
Content/Rules for all slices | |||
| relatedData |
S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension |
| type |
S | 1..1 | code | The type of the required data |
| output |
S | 0..* | DataRequirement | Output data definition |
| type |
S | 1..1 | code | The type of the required data |
| relatedAction |
S | 0..* | BackboneElement | Relationship to another action |
| actionId |
S | 1..1 | id | What action is this related to |
| relationship |
S | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end |
| offsetDuration |
S | 0..1 | Duration | Time offset for the relationship |
| timing[x] |
S | 0..1 | Duration | When the action should take place |
| Documentation for this format | ||||
| 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-actionfrom 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-namedeventfrom this IG |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PlanDefinition |
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 |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
Content/Rules for all slices | |||
| receiverAddress |
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 |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| url |
Σ | 1..1 | uri | Canonical identifier for this plan definition, represented as a URI (globally unique) |
| identifier |
SΣ | 0..* | Identifier | Additional identifier for the plan definition |
| version |
SΣ | 1..1 | string | Business version of the PlanDefinition |
| name |
SΣC | 1..1 | string | Name for this PlanDefinition (computer friendly) |
| title |
SΣ | 1..1 | string | Title for this PlanDefinition |
| type |
SΣ | 1..1 | CodeableConcept | Type of this PlanDefinition Binding: PlanDefinitionType (extensible): The type of PlanDefinition. Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: workflow-definition | |
| display |
1..1 | string | Representation defined by the system Fixed Value: Workflow Definition | |
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| experimental |
Σ | 1..1 | boolean | For testing purposes, not real usage |
| subject[x] |
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.). | |
| subjectCodeableConcept |
CodeableConcept | |||
| subjectReference |
Reference(Group) | |||
| date |
SΣ | 1..1 | dateTime | Date the PlanDefinition was last changed |
| publisher |
SΣ | 1..1 | string | Name of the agency that published this PlanDefinition |
| contact |
SΣ | 0..* | ContactDetail | Contact details for the publisher |
| description |
Σ | 1..1 | markdown | Natural language description of the plan definition |
| useContext |
SΣ | 0..* | UsageContext | The context that the content is intended to support |
| jurisdiction |
SΣ | 0..* | CodeableConcept | Intended jurisdiction for plan definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. |
| effectivePeriod |
SΣ | 0..1 | Period | When the PlanDefinition is valid |
| start |
ΣC | 1..1 | dateTime | The start of the time period when this PlanDefinition goes into effect |
| library |
S | 0..* | canonical(Library) | Logic used by the plan definition |
| action |
S | 0..* | BackboneElement | All constraints on action are intended to apply to any nested constraints. |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| description |
S | 0..1 | string | Brief description of the action |
| code |
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 |
| trigger |
S | 0..* | TriggerDefinition | When the action should be triggered |
| Slices for extension |
Content/Rules for all slices | |||
| namedEventType |
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 |
| type |
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 |
| condition |
S | 0..* | BackboneElement | Whether or not the action is applicable |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| kind |
S | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions. |
| expression |
S | 0..1 | Expression | Boolean-valued expression |
| input |
S | 0..* | DataRequirement | Input data requirements |
| Slices for extension |
Content/Rules for all slices | |||
| relatedData |
S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension |
| type |
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. |
| output |
S | 0..* | DataRequirement | Output data definition |
| type |
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. |
| relatedAction |
S | 0..* | BackboneElement | Relationship to another action |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| actionId |
S | 1..1 | id | What action is this related to |
| relationship |
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. |
| Slices for offset[x] |
0..1 | Time offset for the relationship Slice: Unordered, Open by type:$this | ||
| offsetDuration |
Duration | |||
| offsetRange |
Range | |||
| offset[x]:offsetDuration |
S | 0..1 | Duration | Time offset for the relationship |
| timing[x] |
S | 0..1 | Duration | When the action should take place |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| PlanDefinition.type | extensible | Pattern: workflow-definition("Workflow Definition")http://hl7.org/fhir/ValueSet/plan-definition-typefrom the FHIR Standard | |
| PlanDefinition.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | |
| PlanDefinition.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-typefrom the FHIR Standard | |
| PlanDefinition.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdictionfrom 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-actionfrom this IG | |
| PlanDefinition.action.trigger.type | required | Fixed Value: named-eventhttp://hl7.org/fhir/ValueSet/trigger-type|4.0.1from the FHIR Standard | |
| PlanDefinition.action.condition.kind | required | ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1from the FHIR Standard | |
| PlanDefinition.action.input.type | required | FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1from the FHIR Standard | |
| PlanDefinition.action.output.type | required | FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1from the FHIR Standard | |
| PlanDefinition.action.relatedAction.relationship | required | ActionRelationshipTypehttp://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1from 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 | ||||
|---|---|---|---|---|---|---|---|---|
| PlanDefinition |
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 | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| receiverAddress |
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 | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url |
Σ | 1..1 | uri | Canonical identifier for this plan definition, represented as a URI (globally unique) | ||||
| identifier |
SΣ | 0..* | Identifier | Additional identifier for the plan definition | ||||
| version |
SΣ | 1..1 | string | Business version of the PlanDefinition | ||||
| name |
SΣC | 1..1 | string | Name for this PlanDefinition (computer friendly) | ||||
| title |
SΣ | 1..1 | string | Title for this PlanDefinition | ||||
| subtitle |
0..1 | string | Subordinate title of the plan definition | |||||
| type |
SΣ | 1..1 | CodeableConcept | Type of this PlanDefinition Binding: PlanDefinitionType (extensible): The type of PlanDefinition. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: workflow-definition | |||||
| display |
1..1 | string | Representation defined by the system Fixed Value: Workflow Definition | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental |
Σ | 1..1 | boolean | For testing purposes, not real usage | ||||
| subject[x] |
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.). | |||||
| subjectCodeableConcept |
CodeableConcept | |||||||
| subjectReference |
Reference(Group) | |||||||
| date |
SΣ | 1..1 | dateTime | Date the PlanDefinition was last changed | ||||
| publisher |
SΣ | 1..1 | string | Name of the agency that published this PlanDefinition | ||||
| contact |
SΣ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description |
Σ | 1..1 | markdown | Natural language description of the plan definition | ||||
| useContext |
SΣ | 0..* | UsageContext | The context that the content is intended to support | ||||
| jurisdiction |
SΣ | 0..* | CodeableConcept | Intended jurisdiction for plan definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| purpose |
0..1 | markdown | Why this plan definition is defined | |||||
| usage |
0..1 | string | Describes the clinical usage of the plan | |||||
| copyright |
0..1 | markdown | Use and/or publishing restrictions | |||||
| approvalDate |
0..1 | date | When the plan definition was approved by publisher | |||||
| lastReviewDate |
0..1 | date | When the plan definition was last reviewed | |||||
| effectivePeriod |
SΣ | 0..1 | Period | When the PlanDefinition is valid | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start |
ΣC | 1..1 | dateTime | The start of the time period when this PlanDefinition goes into effect | ||||
| end |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
| topic |
0..* | CodeableConcept | E.g. Education, Treatment, Assessment Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering. | |||||
| author |
0..* | ContactDetail | Who authored the content | |||||
| editor |
0..* | ContactDetail | Who edited the content | |||||
| reviewer |
0..* | ContactDetail | Who reviewed the content | |||||
| endorser |
0..* | ContactDetail | Who endorsed the content | |||||
| relatedArtifact |
0..* | RelatedArtifact | Additional documentation, citations | |||||
| library |
S | 0..* | canonical(Library) | Logic used by the plan definition | ||||
| goal |
0..* | BackboneElement | What the plan is trying to accomplish | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| category |
0..1 | CodeableConcept | E.g. Treatment, dietary, behavioral Binding: GoalCategory (example): Example codes for grouping goals for filtering or presentation. | |||||
| description |
1..1 | CodeableConcept | Code or text describing the goal Binding: SNOMEDCTClinicalFindings (example): Describes goals that can be achieved. | |||||
| priority |
0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: GoalPriority (preferred): Indicates the level of importance associated with reaching or sustaining a goal. | |||||
| start |
0..1 | CodeableConcept | When goal pursuit begins Binding: GoalStartEvent (example): Identifies the types of events that might trigger the start of a goal. | |||||
| addresses |
0..* | CodeableConcept | What does the goal address Binding: Condition/Problem/DiagnosisCodes (example): Identifies problems, conditions, issues, or concerns that goals may address. | |||||
| documentation |
0..* | RelatedArtifact | Supporting documentation for the goal | |||||
| target |
0..* | BackboneElement | Target outcome for the goal | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| measure |
0..1 | CodeableConcept | The parameter whose value is to be tracked Binding: LOINCCodes (example): Identifies types of parameters that can be tracked to determine goal achievement. | |||||
| detail[x] |
0..1 | The target value to be achieved | ||||||
| detailQuantity |
Quantity | |||||||
| detailRange |
Range | |||||||
| detailCodeableConcept |
CodeableConcept | |||||||
| due |
0..1 | Duration | Reach goal within | |||||
| action |
S | 0..* | BackboneElement | All constraints on action are intended to apply to any nested constraints. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| prefix |
0..1 | string | User-visible prefix for the action (e.g. 1. or A.) | |||||
| title |
0..1 | string | User-visible title | |||||
| description |
S | 0..1 | string | Brief description of the action | ||||
| textEquivalent |
0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system | |||||
| priority |
0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |||||
| code |
S | 0..1 | CodeableConcept | Code representing the meaning of the action or sub-actions Binding: US Public Health PlanDefinition Action (extensible): The set of actions that can be used to create plan definition | ||||
| reason |
0..* | CodeableConcept | Why the action should be performed | |||||
| documentation |
0..* | RelatedArtifact | Supporting documentation for the intended performer of the action | |||||
| goalId |
0..* | id | What goals this action supports | |||||
| subject[x] |
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.). | ||||||
| subjectCodeableConcept |
CodeableConcept | |||||||
| subjectReference |
Reference(Group) | |||||||
| trigger |
S | 0..* | TriggerDefinition | When the action should be triggered | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| namedEventType |
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 | ||||
| type |
SΣ | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Binding: TriggerType (required): The type of trigger. Fixed Value: named-event | ||||
| name |
Σ | 0..1 | string | Name or URI that identifies the event | ||||
| timing[x] |
Σ | 0..1 | Timing of the event | |||||
| timingTiming |
Timing | |||||||
| timingReference |
Reference(Schedule) | |||||||
| timingDate |
date | |||||||
| timingDateTime |
dateTime | |||||||
| data |
Σ | 0..* | DataRequirement | Triggering data of the event (multiple = 'and') | ||||
| condition |
Σ | 0..1 | Expression | Whether the event triggers (boolean expression) | ||||
| condition |
S | 0..* | BackboneElement | Whether or not the action is applicable | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| kind |
S | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions. | ||||
| expression |
S | 0..1 | Expression | Boolean-valued expression | ||||
| input |
S | 0..* | DataRequirement | Input data requirements | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| relatedData |
S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-relateddata-extension | ||||
| type |
SΣ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types. | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | The profile of the required data | ||||
| subject[x] |
Σ | 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.). | |||||
| subjectCodeableConcept |
CodeableConcept | |||||||
| subjectReference |
Reference(Group) | |||||||
| mustSupport |
Σ | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module | ||||
| codeFilter |
ΣC | 0..* | Element | What codes are expected drq-1: Either a path or a searchParam must be provided, but not both | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| path |
Σ | 0..1 | string | A code-valued attribute to filter on | ||||
| searchParam |
Σ | 0..1 | string | A coded (token) parameter to search on | ||||
| valueSet |
Σ | 0..1 | canonical(ValueSet) | Valueset for the filter | ||||
| code |
Σ | 0..* | Coding | What code is expected | ||||
| dateFilter |
ΣC | 0..* | Element | What dates/date ranges are expected drq-2: Either a path or a searchParam must be provided, but not both | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| path |
Σ | 0..1 | string | A date-valued attribute to filter on | ||||
| searchParam |
Σ | 0..1 | string | A date valued parameter to search on | ||||
| value[x] |
Σ | 0..1 | The value of the filter, as a Period, DateTime, or Duration value | |||||
| valueDateTime |
dateTime | |||||||
| valuePeriod |
Period | |||||||
| valueDuration |
Duration | |||||||
| limit |
Σ | 0..1 | positiveInt | Number of results | ||||
| sort |
Σ | 0..* | Element | Order of the results | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| path |
Σ | 1..1 | string | The name of the attribute to perform the sort | ||||
| direction |
Σ | 1..1 | code | ascending | descending Binding: SortDirection (required): The possible sort directions, ascending or descending. | ||||
| output |
S | 0..* | DataRequirement | Output data definition | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| type |
SΣ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types. | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | The profile of the required data | ||||
| subject[x] |
Σ | 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.). | |||||
| subjectCodeableConcept |
CodeableConcept | |||||||
| subjectReference |
Reference(Group) | |||||||
| mustSupport |
Σ | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module | ||||
| codeFilter |
ΣC | 0..* | Element | What codes are expected drq-1: Either a path or a searchParam must be provided, but not both | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| path |
Σ | 0..1 | string | A code-valued attribute to filter on | ||||
| searchParam |
Σ | 0..1 | string | A coded (token) parameter to search on | ||||
| valueSet |
Σ | 0..1 | canonical(ValueSet) | Valueset for the filter | ||||
| code |
Σ | 0..* | Coding | What code is expected | ||||
| dateFilter |
ΣC | 0..* | Element | What dates/date ranges are expected drq-2: Either a path or a searchParam must be provided, but not both | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| path |
Σ | 0..1 | string | A date-valued attribute to filter on | ||||
| searchParam |
Σ | 0..1 | string | A date valued parameter to search on | ||||
| value[x] |
Σ | 0..1 | The value of the filter, as a Period, DateTime, or Duration value | |||||
| valueDateTime |
dateTime | |||||||
| valuePeriod |
Period | |||||||
| valueDuration |
Duration | |||||||
| limit |
Σ | 0..1 | positiveInt | Number of results | ||||
| sort |
Σ | 0..* | Element | Order of the results | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| path |
Σ | 1..1 | string | The name of the attribute to perform the sort | ||||
| direction |
Σ | 1..1 | code | ascending | descending Binding: SortDirection (required): The possible sort directions, ascending or descending. | ||||
| relatedAction |
S | 0..* | BackboneElement | Relationship to another action | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| actionId |
S | 1..1 | id | What action is this related to | ||||
| relationship |
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. | ||||
| Slices for offset[x] |
0..1 | Time offset for the relationship Slice: Unordered, Open by type:$this | ||||||
| offsetDuration |
Duration | |||||||
| offsetRange |
Range | |||||||
| offset[x]:offsetDuration |
S | 0..1 | Duration | Time offset for the relationship | ||||
| timing[x] |
S | 0..1 | Duration | When the action should take place | ||||
| participant |
0..* | BackboneElement | Who should participate in the action | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action. | |||||
| role |
0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example): Defines roles played by participants for the action. | |||||
| type |
0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed. | |||||
| groupingBehavior |
0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group. | |||||
| selectionBehavior |
0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group. | |||||
| requiredBehavior |
0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required. | |||||
| precheckBehavior |
0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group. | |||||
| cardinalityBehavior |
0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated. | |||||
| definition[x] |
0..1 | Description of the activity to be performed | ||||||
| definitionCanonical |
canonical(ActivityDefinition | PlanDefinition | Questionnaire) | |||||||
| definitionUri |
uri | |||||||
| transform |
0..1 | canonical(StructureMap) | Transform to apply the template | |||||
| dynamicValue |
0..* | BackboneElement | Dynamic aspects of the definition | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| path |
0..1 | string | The path to the element to be set dynamically | |||||
| expression |
0..1 | Expression | An expression that provides the dynamic value for the customization | |||||
| action |
0..* | See action (PlanDefinition) | A sub-action | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| PlanDefinition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| PlanDefinition.type | extensible | Pattern: workflow-definition("Workflow Definition")http://hl7.org/fhir/ValueSet/plan-definition-typefrom the FHIR Standard | ||||
| PlanDefinition.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | ||||
| PlanDefinition.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-typefrom the FHIR Standard | ||||
| PlanDefinition.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdictionfrom the FHIR Standard | ||||
| PlanDefinition.topic | example | DefinitionTopichttp://hl7.org/fhir/ValueSet/definition-topicfrom the FHIR Standard | ||||
| PlanDefinition.goal.category | example | GoalCategoryhttp://hl7.org/fhir/ValueSet/goal-categoryfrom the FHIR Standard | ||||
| PlanDefinition.goal.description | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findingsfrom the FHIR Standard | ||||
| PlanDefinition.goal.priority | preferred | GoalPriorityhttp://hl7.org/fhir/ValueSet/goal-priorityfrom the FHIR Standard | ||||
| PlanDefinition.goal.start | example | GoalStartEventhttp://hl7.org/fhir/ValueSet/goal-start-eventfrom the FHIR Standard | ||||
| PlanDefinition.goal.addresses | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-codefrom the FHIR Standard | ||||
| PlanDefinition.goal.target.measure | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codesfrom the FHIR Standard | ||||
| PlanDefinition.action.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from 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-actionfrom this IG | ||||
| PlanDefinition.action.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-typefrom the FHIR Standard | ||||
| PlanDefinition.action.trigger.type | required | Fixed Value: named-eventhttp://hl7.org/fhir/ValueSet/trigger-type|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.condition.kind | required | ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.input.type | required | FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.input.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-typefrom the FHIR Standard | ||||
| PlanDefinition.action.input.sort.direction | required | SortDirectionhttp://hl7.org/fhir/ValueSet/sort-direction|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.output.type | required | FHIRAllTypeshttp://hl7.org/fhir/ValueSet/all-types|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.output.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-typefrom the FHIR Standard | ||||
| PlanDefinition.action.output.sort.direction | required | SortDirectionhttp://hl7.org/fhir/ValueSet/sort-direction|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.relatedAction.relationship | required | ActionRelationshipTypehttp://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.participant.type | required | ActionParticipantTypehttp://hl7.org/fhir/ValueSet/action-participant-type|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.participant.role | example | ActionParticipantRolehttp://hl7.org/fhir/ValueSet/action-participant-rolefrom the FHIR Standard | ||||
| PlanDefinition.action.type | extensible | ActionTypehttp://hl7.org/fhir/ValueSet/action-typefrom the FHIR Standard | ||||
| PlanDefinition.action.groupingBehavior | required | ActionGroupingBehaviorhttp://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.selectionBehavior | required | ActionSelectionBehaviorhttp://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.requiredBehavior | required | ActionRequiredBehaviorhttp://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.precheckBehavior | required | ActionPrecheckBehaviorhttp://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1from the FHIR Standard | ||||
| PlanDefinition.action.cardinalityBehavior | required | ActionCardinalityBehaviorhttp://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1from 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