This page is part of the Making EHR Data MOre available for Research and Public Health (MedMorph) Healthcare Surveys Reporting Content IG (v1.0.0: STU1 Release 1) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/us/health-care-surveys-reporting/StructureDefinition/hcs-plandefinition | Version: 1.0.0 | |||
Active as of 2023-08-22 | Computable Name: HCSPlanDefinition |
This PlanDefinition profile defines the logic and rules around determining: whether or not data from an encounter is reportable to National Center for Health Statistics (NCHS).
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USPublicHealthPlanDefinition
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
PlanDefinition | S | 1..1 | USPublicHealthPlanDefinition | Health Care Surveys Knowledge Artifact |
Slices for action | S | 5..* | BackboneElement | All constraints on action are intended to apply to any nested constraints. Slice: Ordered, Open by value:id |
action:All Slices | Content/Rules for all slices | |||
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 |
input | 0..* | DataRequirement | Input data requirements | |
action:startWorkflow | S | 1..1 | BackboneElement | Start Workflow Action |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: start-workflow |
description | S | 1..1 | string | Starts the workflow Fixed Value: This action represents the start of the reporting workflow in response to the encounter-end event |
textEquivalent | S | 1..1 | string | Text equivalent of the start workflow action. Fixed Value: Start the reporting workflow in response to an encounter-end event |
code | S | 1..1 | CodeableConcept | Code for the "start" action. 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://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: initiate-reporting-workflow | |
trigger | S | 1..* | TriggerDefinition | When the "start" action should be triggered. |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
namedEventType | S | 0..1 | CodeableConcept | Indicates the types of named events to subscribe to from the HER. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-named-eventtype Binding: US Public Health TriggerDefinition NamedEvent (extensible): US Public Health TriggerDefinition NamedEvents |
type | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Fixed Value: named-event | |
name | 0..1 | string | Name or URI that identifies the event Fixed Value: encounter-end | |
relatedAction | S | 1..1 | BackboneElement | Relationship to another action |
actionId | 1..1 | id | What action is this related to Fixed Value: check-reportability | |
relationship | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Fixed Value: before-start | |
offsetDuration | 0..1 | Duration | Time offset for the relationship Example Wait 72 hour before next action.: {"value":72,"unit":"h"} | |
action:executeReportingWorkflow | S | 1..1 | BackboneElement | Execute Reporting Workflow |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: check-reportability |
description | S | 1..1 | string | Check for reportability conditions Fixed Value: This action represents the start of the check for reportable conditions in response to the encounter-end event. This is an example of executing a reporting workflow with other actions. |
code | S | 1..1 | CodeableConcept | Code for the "execute-reporting-workflow" action. 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://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: execute-reporting-workflow | |
Slices for action | 2..* | A sub-action Slice: Unordered, Open by value:id | ||
action:isAmbulatoryEncounterReportable | S | 1..1 | BackboneElement | A sub-action |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: is-ambulatory-encounter-reportable |
code | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions 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://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: evaluate-condition | |
condition | 0..* | BackboneElement | Whether or not the action is applicable | |
kind | 1..1 | code | applicability | start | stop Fixed Value: applicability | |
expression | S | 1..1 | Expression | Boolean-valued expression |
language | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Fixed Value: text/fhirpath | |
input | S | 0..* | DataRequirement | Input data requirements |
id | S | 1..1 | string | Unique id for inter-element referencing |
relatedAction | 0..* | BackboneElement | Relationship to another action | |
actionId | 1..1 | id | What action is this related to Fixed Value: create-hcs-report | |
relationship | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Fixed Value: before-start | |
action:isInpatientEncounterReportable | S | 1..1 | BackboneElement | A sub-action |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: is-inpatient-encounter-reportable |
code | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions 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://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: evaluate-condition | |
condition | 0..* | BackboneElement | Whether or not the action is applicable | |
kind | 1..1 | code | applicability | start | stop Fixed Value: applicability | |
expression | S | 1..1 | Expression | Boolean-valued expression |
language | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Fixed Value: text/fhirpath | |
input | S | 0..* | DataRequirement | Input data requirements |
id | S | 1..1 | string | Unique id for inter-element referencing |
relatedAction | 0..* | BackboneElement | Relationship to another action | |
actionId | 1..1 | id | What action is this related to Fixed Value: create-hcs-report | |
relationship | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Fixed Value: before-start | |
action:createReport | 1..1 | BackboneElement | All constraints on action are intended to apply to any nested constraints. | |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: create-hcs-report |
description | 0..1 | string | Brief description of the action Fixed Value: This action represents the creation, validation and submission of the health care survey report. | |
code | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions 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://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: create-report | |
input | S | 0..* | DataRequirement | Input data requirements |
id | S | 1..1 | string | Unique id for inter-element referencing |
output | S | 0..* | DataRequirement | Output data definition |
id | S | 1..1 | string | Unique id for inter-element referencing |
relatedAction | 0..* | BackboneElement | Relationship to another action | |
actionId | 1..1 | id | What action is this related to Fixed Value: validate-hcs-report | |
relationship | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Fixed Value: before-start | |
action:validateReport | 1..1 | BackboneElement | All constraints on action are intended to apply to any nested constraints. | |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: validate-hcs-report |
description | 0..1 | string | Brief description of the action Fixed Value: This action represents the validation of the HCS Report | |
code | 0..1 | CodeableConcept | Code representing the meaning of the action or sub-actions 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://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: validate-report | |
input | S | 0..* | DataRequirement | Input data requirements |
id | S | 1..1 | string | Unique id for inter-element referencing |
output | S | 0..* | DataRequirement | Output data definition |
id | S | 1..1 | string | Unique id for inter-element referencing |
relatedAction | 0..* | BackboneElement | Relationship to another action | |
actionId | 1..1 | id | What action is this related to Fixed Value: submit-hcs-report | |
relationship | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Fixed Value: before-start | |
action:submitHcsReport | 1..1 | BackboneElement | Route and send HCS Report | |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: submit-hcs-report |
description | S | 1..1 | string | Description of the route and send action. Fixed Value: This action represents the routing and sending of the HCS Report |
textEquivalent | S | 1..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system Fixed Value: Route and send HCS Report |
code | 0..1 | CodeableConcept | Code representing the meaning of the action or sub-actions 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://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: submit-report | |
input | S | 0..* | DataRequirement | Input data requirements |
id | S | 1..1 | string | Unique id for inter-element referencing |
Documentation for this format |
Path | Conformance | ValueSet |
PlanDefinition.action.code | extensible | USPublicHealthPlanDefinitionAction |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
PlanDefinition | SC | 1..1 | USPublicHealthPlanDefinition | Health Care Surveys Knowledge Artifact | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
receiverEndpoint | S | 0..1 | Reference(USPH Endpoint) | Indicates the address where the report has to be sent. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-receiver-endpoint | ||||
asyncIndicator | S | 0..1 | boolean | US Public Health Async Indicator Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-async-indicator | ||||
contentEncrypted | S | 0..1 | boolean | US Public Health Data Encrypted Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-data-encrypted-extension | ||||
jwksForContentEncryption | S | 0..1 | url | US Public Health Receiver Jwks Url URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-receiver-jwks-url | ||||
contentEncryptionAlgorithm | S | 0..1 | code | US Public Health Receiver Jwks Url URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-data-encryption-algorithm | ||||
expectedResponseDuration | S | 0..1 | Duration | US Public Health Expected Response Time Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-expected-responsetime | ||||
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 | Σ | 1..1 | string | Business version of the plan definition | ||||
name | ΣC | 1..1 | string | Name for this plan definition (computer friendly) | ||||
title | SΣ | 0..1 | string | Name for this plan definition (human friendly) | ||||
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 | ||||
Slices for action | S | 5..* | BackboneElement | All constraints on action are intended to apply to any nested constraints. Slice: Ordered, Open by value:id | ||||
action:All Slices | Content/Rules for all slices | |||||||
trustServiceEndpoint | S | 0..1 | Reference(USPH Endpoint) | Indicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-trust-service-endpoint | ||||
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 | ||||
namedEventType | S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-named-eventtype 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. Fixed Value: applicability | ||||
expression | S | 0..1 | Expression | Boolean-valued expression | ||||
language | SΣ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible): The media type of the expression language.
Fixed Value: text/fhirpath | ||||
input | S | 0..* | DataRequirement | Input data requirements | ||||
defaultQuery | S | 0..1 | string | US Public Health FHIR Query Pattern Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension | ||||
relatedDataId | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/medmorph/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. | ||||
profile | SΣ | 0..* | canonical(StructureDefinition) | The profile of the required data | ||||
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. Fixed Value: before-start | ||||
Slices for offset[x] | 0..1 | Duration | Time offset for the relationship Slice: Unordered, Closed by type:$this | |||||
offset[x]:offsetDuration | S | 0..1 | Duration | Time offset for the relationship | ||||
timing[x] | S | 0..1 | Duration | When the action should take place | ||||
action | S | 0..* | See action (PlanDefinition) | A sub-action | ||||
action:startWorkflow | S | 1..1 | BackboneElement | Start Workflow Action | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: start-workflow | ||||
trustServiceEndpoint | S | 0..1 | Reference(USPH Endpoint) | Indicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-trust-service-endpoint | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
description | S | 1..1 | string | Starts the workflow Fixed Value: This action represents the start of the reporting workflow in response to the encounter-end event | ||||
textEquivalent | S | 1..1 | string | Text equivalent of the start workflow action. Fixed Value: Start the reporting workflow in response to an encounter-end event | ||||
code | S | 1..1 | CodeableConcept | Code for the "start" action. Binding: US Public Health PlanDefinition Action (extensible): The set of actions that can be used to create plan definition 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://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: initiate-reporting-workflow | |||||
trigger | S | 1..* | TriggerDefinition | When the "start" action should be triggered. | ||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
namedEventType | S | 0..1 | CodeableConcept | Indicates the types of named events to subscribe to from the HER. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-named-eventtype 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 Fixed Value: encounter-end | ||||
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. Fixed Value: applicability | ||||
expression | S | 0..1 | Expression | Boolean-valued expression | ||||
language | SΣ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible): The media type of the expression language.
Fixed Value: text/fhirpath | ||||
input | S | 0..* | DataRequirement | Input data requirements | ||||
defaultQuery | S | 0..1 | string | US Public Health FHIR Query Pattern Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension | ||||
relatedDataId | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/medmorph/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. | ||||
profile | SΣ | 0..* | canonical(StructureDefinition) | The profile of the required data | ||||
relatedAction | S | 1..1 | 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 Fixed Value: check-reportability | ||||
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. Fixed Value: before-start | ||||
Slices for offset[x] | 0..1 | Duration | Time offset for the relationship Slice: Unordered, Closed by type:$this | |||||
offset[x]:offsetDuration | S | 0..1 | Duration | Time offset for the relationship Example Wait 72 hour before next action.: {"value":72,"unit":"h"} | ||||
timing[x] | S | 0..1 | Duration | When the action should take place | ||||
action | S | 0..* | See action (PlanDefinition) | A sub-action | ||||
action:executeReportingWorkflow | S | 1..1 | BackboneElement | Execute Reporting Workflow | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: check-reportability | ||||
trustServiceEndpoint | S | 0..1 | Reference(USPH Endpoint) | Indicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-trust-service-endpoint | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
description | S | 1..1 | string | Check for reportability conditions Fixed Value: This action represents the start of the check for reportable conditions in response to the encounter-end event. This is an example of executing a reporting workflow with other actions. | ||||
code | S | 1..1 | CodeableConcept | Code for the "execute-reporting-workflow" action. Binding: US Public Health PlanDefinition Action (extensible): The set of actions that can be used to create plan definition 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://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: execute-reporting-workflow | |||||
trigger | S | 0..* | TriggerDefinition | When the action should be triggered | ||||
namedEventType | S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-named-eventtype 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. Fixed Value: applicability | ||||
expression | S | 0..1 | Expression | Boolean-valued expression | ||||
language | SΣ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible): The media type of the expression language.
Fixed Value: text/fhirpath | ||||
input | S | 0..* | DataRequirement | Input data requirements | ||||
defaultQuery | S | 0..1 | string | US Public Health FHIR Query Pattern Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension | ||||
relatedDataId | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/medmorph/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. | ||||
profile | SΣ | 0..* | canonical(StructureDefinition) | The profile of the required data | ||||
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. Fixed Value: before-start | ||||
Slices for offset[x] | 0..1 | Duration | Time offset for the relationship Slice: Unordered, Closed by type:$this | |||||
offset[x]:offsetDuration | S | 0..1 | Duration | Time offset for the relationship | ||||
timing[x] | S | 0..1 | Duration | When the action should take place | ||||
Slices for action | S | 2..* | See action (PlanDefinition) | A sub-action Slice: Unordered, Open by value:id | ||||
action:isAmbulatoryEncounterReportable | S | 1..1 | BackboneElement | A sub-action | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: is-ambulatory-encounter-reportable | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions 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://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: evaluate-condition | |||||
condition | 0..* | BackboneElement | Whether or not the action is applicable | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
kind | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions. Fixed Value: applicability | |||||
expression | S | 1..1 | Expression | Boolean-valued expression | ||||
language | Σ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible): The media type of the expression language.
Fixed Value: text/fhirpath | ||||
input | S | 0..* | DataRequirement | Input data requirements | ||||
id | S | 1..1 | string | Unique id for inter-element referencing | ||||
type | Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types. | ||||
relatedAction | 0..* | BackboneElement | Relationship to another action | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
actionId | 1..1 | id | What action is this related to Fixed Value: create-hcs-report | |||||
relationship | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions. Fixed Value: before-start | |||||
action:isInpatientEncounterReportable | S | 1..1 | BackboneElement | A sub-action | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: is-inpatient-encounter-reportable | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions 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://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: evaluate-condition | |||||
condition | 0..* | BackboneElement | Whether or not the action is applicable | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
kind | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions. Fixed Value: applicability | |||||
expression | S | 1..1 | Expression | Boolean-valued expression | ||||
language | Σ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible): The media type of the expression language.
Fixed Value: text/fhirpath | ||||
input | S | 0..* | DataRequirement | Input data requirements | ||||
id | S | 1..1 | string | Unique id for inter-element referencing | ||||
type | Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types. | ||||
relatedAction | 0..* | BackboneElement | Relationship to another action | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
actionId | 1..1 | id | What action is this related to Fixed Value: create-hcs-report | |||||
relationship | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions. Fixed Value: before-start | |||||
action:createReport | S | 1..1 | BackboneElement | All constraints on action are intended to apply to any nested constraints. | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: create-hcs-report | ||||
trustServiceEndpoint | S | 0..1 | Reference(USPH Endpoint) | Indicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-trust-service-endpoint | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
description | S | 0..1 | string | Brief description of the action Fixed Value: This action represents the creation, validation and submission of the health care survey report. | ||||
code | S | 1..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 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://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: create-report | |||||
trigger | S | 0..* | TriggerDefinition | When the action should be triggered | ||||
namedEventType | S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-named-eventtype 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. Fixed Value: applicability | ||||
expression | S | 0..1 | Expression | Boolean-valued expression | ||||
language | SΣ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible): The media type of the expression language.
Fixed Value: text/fhirpath | ||||
input | S | 0..* | DataRequirement | Input data requirements | ||||
id | S | 1..1 | string | Unique id for inter-element referencing | ||||
defaultQuery | S | 0..1 | string | US Public Health FHIR Query Pattern Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension | ||||
relatedDataId | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/medmorph/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 | ||||
id | S | 1..1 | string | Unique id for inter-element referencing | ||||
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 | SΣ | 0..* | canonical(StructureDefinition) | The profile of the required data | ||||
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 Fixed Value: validate-hcs-report | ||||
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. Fixed Value: before-start | ||||
Slices for offset[x] | 0..1 | Duration | Time offset for the relationship Slice: Unordered, Closed by type:$this | |||||
offset[x]:offsetDuration | S | 0..1 | Duration | Time offset for the relationship | ||||
timing[x] | S | 0..1 | Duration | When the action should take place | ||||
action | S | 0..* | See action (PlanDefinition) | A sub-action | ||||
action:validateReport | S | 1..1 | BackboneElement | All constraints on action are intended to apply to any nested constraints. | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: validate-hcs-report | ||||
trustServiceEndpoint | S | 0..1 | Reference(USPH Endpoint) | Indicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-trust-service-endpoint | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
description | S | 0..1 | string | Brief description of the action Fixed Value: This action represents the validation of the HCS Report | ||||
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 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://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: validate-report | |||||
trigger | S | 0..* | TriggerDefinition | When the action should be triggered | ||||
namedEventType | S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-named-eventtype 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. Fixed Value: applicability | ||||
expression | S | 0..1 | Expression | Boolean-valued expression | ||||
language | SΣ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible): The media type of the expression language.
Fixed Value: text/fhirpath | ||||
input | S | 0..* | DataRequirement | Input data requirements | ||||
id | S | 1..1 | string | Unique id for inter-element referencing | ||||
defaultQuery | S | 0..1 | string | US Public Health FHIR Query Pattern Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension | ||||
relatedDataId | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/medmorph/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 | ||||
id | S | 1..1 | string | Unique id for inter-element referencing | ||||
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 | SΣ | 0..* | canonical(StructureDefinition) | The profile of the required data | ||||
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 Fixed Value: submit-hcs-report | ||||
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. Fixed Value: before-start | ||||
Slices for offset[x] | 0..1 | Duration | Time offset for the relationship Slice: Unordered, Closed by type:$this | |||||
offset[x]:offsetDuration | S | 0..1 | Duration | Time offset for the relationship | ||||
timing[x] | S | 0..1 | Duration | When the action should take place | ||||
action | S | 0..* | See action (PlanDefinition) | A sub-action | ||||
action:submitHcsReport | S | 1..1 | BackboneElement | Route and send HCS Report | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: submit-hcs-report | ||||
trustServiceEndpoint | S | 0..1 | Reference(USPH Endpoint) | Indicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-trust-service-endpoint | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
description | S | 1..1 | string | Description of the route and send action. Fixed Value: This action represents the routing and sending of the HCS Report | ||||
textEquivalent | S | 1..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system Fixed Value: Route and send HCS Report | ||||
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 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://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: submit-report | |||||
trigger | S | 0..* | TriggerDefinition | When the action should be triggered | ||||
namedEventType | S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-named-eventtype 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. Fixed Value: applicability | ||||
expression | S | 0..1 | Expression | Boolean-valued expression | ||||
language | SΣ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible): The media type of the expression language.
Fixed Value: text/fhirpath | ||||
input | S | 0..* | DataRequirement | Input data requirements | ||||
id | S | 1..1 | string | Unique id for inter-element referencing | ||||
defaultQuery | S | 0..1 | string | US Public Health FHIR Query Pattern Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension | ||||
relatedDataId | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/medmorph/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. | ||||
profile | SΣ | 0..* | canonical(StructureDefinition) | The profile of the required data | ||||
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. Fixed Value: before-start | ||||
Slices for offset[x] | 0..1 | Duration | Time offset for the relationship Slice: Unordered, Closed by type:$this | |||||
offset[x]:offsetDuration | S | 0..1 | Duration | Time offset for the relationship | ||||
timing[x] | S | 0..1 | Duration | When the action should take place | ||||
action | S | 0..* | See action (PlanDefinition) | A sub-action | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
PlanDefinition.type | extensible | Pattern: workflow-definition("Workflow Definition") | ||||
PlanDefinition.status | required | PublicationStatus | ||||
PlanDefinition.subject[x] | extensible | SubjectType | ||||
PlanDefinition.jurisdiction | extensible | Jurisdiction ValueSet | ||||
PlanDefinition.action.code | extensible | USPublicHealthPlanDefinitionAction | ||||
PlanDefinition.action.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:startWorkflow.code | extensible | Pattern: initiate-reporting-workflow | ||||
PlanDefinition.action:startWorkflow.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action:startWorkflow.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:startWorkflow.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:startWorkflow.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:startWorkflow.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action:startWorkflow.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:executeReportingWorkflow.code | extensible | Pattern: execute-reporting-workflow | ||||
PlanDefinition.action:executeReportingWorkflow.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action:executeReportingWorkflow.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:executeReportingWorkflow.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:executeReportingWorkflow.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:executeReportingWorkflow.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action:executeReportingWorkflow.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:createReport.code | extensible | Pattern: create-report | ||||
PlanDefinition.action:createReport.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action:createReport.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:createReport.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:createReport.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:createReport.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action:createReport.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:validateReport.code | extensible | Pattern: validate-report | ||||
PlanDefinition.action:validateReport.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action:validateReport.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:validateReport.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:validateReport.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:validateReport.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action:validateReport.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:submitHcsReport.code | extensible | Pattern: submit-report | ||||
PlanDefinition.action:submitHcsReport.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action:submitHcsReport.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:submitHcsReport.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:submitHcsReport.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:submitHcsReport.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action:submitHcsReport.relatedAction.relationship | required | Fixed Value: before-start |
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 | SC | 1..1 | USPublicHealthPlanDefinition | Health Care Surveys Knowledge Artifact | ||||
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 | |||||
receiverEndpoint | S | 0..1 | Reference(USPH Endpoint) | Indicates the address where the report has to be sent. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-receiver-endpoint | ||||
asyncIndicator | S | 0..1 | boolean | US Public Health Async Indicator Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-async-indicator | ||||
contentEncrypted | S | 0..1 | boolean | US Public Health Data Encrypted Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-data-encrypted-extension | ||||
jwksForContentEncryption | S | 0..1 | url | US Public Health Receiver Jwks Url URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-receiver-jwks-url | ||||
contentEncryptionAlgorithm | S | 0..1 | code | US Public Health Receiver Jwks Url URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-data-encryption-algorithm | ||||
expectedResponseDuration | S | 0..1 | Duration | US Public Health Expected Response Time Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-expected-responsetime | ||||
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 | Σ | 1..1 | string | Business version of the plan definition | ||||
name | ΣC | 1..1 | string | Name for this plan definition (computer friendly) | ||||
title | SΣ | 0..1 | string | Name for this plan definition (human friendly) | ||||
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 | |||||
Slices for action | S | 5..* | BackboneElement | All constraints on action are intended to apply to any nested constraints. Slice: Ordered, Open by value:id | ||||
action:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
trustServiceEndpoint | S | 0..1 | Reference(USPH Endpoint) | Indicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-trust-service-endpoint | ||||
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/medmorph/StructureDefinition/us-ph-named-eventtype 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. Fixed Value: applicability | ||||
expression | S | 0..1 | Expression | Boolean-valued expression | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
description | Σ | 0..1 | string | Natural language description of the condition | ||||
name | Σ | 0..1 | id | Short name assigned to expression for reuse | ||||
language | SΣ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible): The media type of the expression language.
Fixed Value: text/fhirpath | ||||
expression | Σ | 0..1 | string | Expression in specified language | ||||
reference | Σ | 0..1 | uri | Where the expression is found | ||||
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 | |||||
defaultQuery | S | 0..1 | string | US Public Health FHIR Query Pattern Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension | ||||
relatedDataId | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/medmorph/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 | ||||
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 | ||||
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 | SΣ | 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 | ||||
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 | ||||
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. Fixed Value: before-start | ||||
Slices for offset[x] | 0..1 | Duration | Time offset for the relationship Slice: Unordered, Closed by type:$this | |||||
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 | S | 0..* | See action (PlanDefinition) | A sub-action | ||||
action:startWorkflow | S | 1..1 | BackboneElement | Start Workflow Action | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: start-workflow | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
trustServiceEndpoint | S | 0..1 | Reference(USPH Endpoint) | Indicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-trust-service-endpoint | ||||
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 | 1..1 | string | Starts the workflow Fixed Value: This action represents the start of the reporting workflow in response to the encounter-end event | ||||
textEquivalent | S | 1..1 | string | Text equivalent of the start workflow action. Fixed Value: Start the reporting workflow in response to an encounter-end event | ||||
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 | 1..1 | CodeableConcept | Code for the "start" action. Binding: US Public Health PlanDefinition Action (extensible): The set of actions that can be used to create plan definition 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://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: initiate-reporting-workflow | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
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 | 1..* | TriggerDefinition | When the "start" 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 | Indicates the types of named events to subscribe to from the HER. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-named-eventtype 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 Fixed Value: encounter-end | ||||
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. Fixed Value: applicability | ||||
expression | S | 0..1 | Expression | Boolean-valued expression | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
description | Σ | 0..1 | string | Natural language description of the condition | ||||
name | Σ | 0..1 | id | Short name assigned to expression for reuse | ||||
language | SΣ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible): The media type of the expression language.
Fixed Value: text/fhirpath | ||||
expression | Σ | 0..1 | string | Expression in specified language | ||||
reference | Σ | 0..1 | uri | Where the expression is found | ||||
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 | |||||
defaultQuery | S | 0..1 | string | US Public Health FHIR Query Pattern Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension | ||||
relatedDataId | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/medmorph/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 | ||||
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 | ||||
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 | SΣ | 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 | ||||
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 | ||||
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 | 1..1 | 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 Fixed Value: check-reportability | ||||
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. Fixed Value: before-start | ||||
Slices for offset[x] | 0..1 | Duration | Time offset for the relationship Slice: Unordered, Closed by type:$this | |||||
offset[x]:offsetDuration | S | 0..1 | Duration | Time offset for the relationship Example Wait 72 hour before next action.: {"value":72,"unit":"h"} | ||||
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 | S | 0..* | See action (PlanDefinition) | A sub-action | ||||
action:executeReportingWorkflow | S | 1..1 | BackboneElement | Execute Reporting Workflow | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: check-reportability | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
trustServiceEndpoint | S | 0..1 | Reference(USPH Endpoint) | Indicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-trust-service-endpoint | ||||
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 | 1..1 | string | Check for reportability conditions Fixed Value: This action represents the start of the check for reportable conditions in response to the encounter-end event. This is an example of executing a reporting workflow with other actions. | ||||
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 | 1..1 | CodeableConcept | Code for the "execute-reporting-workflow" action. Binding: US Public Health PlanDefinition Action (extensible): The set of actions that can be used to create plan definition 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://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: execute-reporting-workflow | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
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/medmorph/StructureDefinition/us-ph-named-eventtype 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. Fixed Value: applicability | ||||
expression | S | 0..1 | Expression | Boolean-valued expression | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
description | Σ | 0..1 | string | Natural language description of the condition | ||||
name | Σ | 0..1 | id | Short name assigned to expression for reuse | ||||
language | SΣ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible): The media type of the expression language.
Fixed Value: text/fhirpath | ||||
expression | Σ | 0..1 | string | Expression in specified language | ||||
reference | Σ | 0..1 | uri | Where the expression is found | ||||
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 | |||||
defaultQuery | S | 0..1 | string | US Public Health FHIR Query Pattern Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension | ||||
relatedDataId | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/medmorph/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 | ||||
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 | ||||
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 | SΣ | 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 | ||||
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 | ||||
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. Fixed Value: before-start | ||||
Slices for offset[x] | 0..1 | Duration | Time offset for the relationship Slice: Unordered, Closed by type:$this | |||||
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 | |||||
Slices for action | S | 2..* | See action (PlanDefinition) | A sub-action Slice: Unordered, Open by value:id | ||||
action:isAmbulatoryEncounterReportable | S | 1..1 | BackboneElement | A sub-action | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: is-ambulatory-encounter-reportable | ||||
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 | 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 | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions 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://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: evaluate-condition | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
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 | 0..* | TriggerDefinition | When the action should be triggered | |||||
condition | 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 | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions. Fixed Value: applicability | |||||
expression | S | 1..1 | Expression | Boolean-valued expression | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
description | Σ | 0..1 | string | Natural language description of the condition | ||||
name | Σ | 0..1 | id | Short name assigned to expression for reuse | ||||
language | Σ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible): The media type of the expression language.
Fixed Value: text/fhirpath | ||||
expression | Σ | 0..1 | string | Expression in specified language | ||||
reference | Σ | 0..1 | uri | Where the expression is found | ||||
input | S | 0..* | DataRequirement | Input data requirements | ||||
id | S | 1..1 | string | Unique id for inter-element referencing | ||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
type | Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types. | ||||
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 | ||||
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 | ||||
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 | 0..* | DataRequirement | Output data definition | |||||
relatedAction | 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 | 1..1 | id | What action is this related to Fixed Value: create-hcs-report | |||||
relationship | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions. Fixed Value: before-start | |||||
offset[x] | 0..1 | Time offset for the relationship | ||||||
offsetDuration | Duration | |||||||
offsetRange | Range | |||||||
timing[x] | 0..1 | When the action should take place | ||||||
timingDateTime | dateTime | |||||||
timingAge | Age | |||||||
timingPeriod | Period | |||||||
timingDuration | Duration | |||||||
timingRange | Range | |||||||
timingTiming | Timing | |||||||
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 | |||||
action:isInpatientEncounterReportable | S | 1..1 | BackboneElement | A sub-action | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: is-inpatient-encounter-reportable | ||||
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 | 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 | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions 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://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: evaluate-condition | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
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 | 0..* | TriggerDefinition | When the action should be triggered | |||||
condition | 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 | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions. Fixed Value: applicability | |||||
expression | S | 1..1 | Expression | Boolean-valued expression | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
description | Σ | 0..1 | string | Natural language description of the condition | ||||
name | Σ | 0..1 | id | Short name assigned to expression for reuse | ||||
language | Σ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible): The media type of the expression language.
Fixed Value: text/fhirpath | ||||
expression | Σ | 0..1 | string | Expression in specified language | ||||
reference | Σ | 0..1 | uri | Where the expression is found | ||||
input | S | 0..* | DataRequirement | Input data requirements | ||||
id | S | 1..1 | string | Unique id for inter-element referencing | ||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
type | Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types. | ||||
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 | ||||
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 | ||||
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 | 0..* | DataRequirement | Output data definition | |||||
relatedAction | 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 | 1..1 | id | What action is this related to Fixed Value: create-hcs-report | |||||
relationship | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions. Fixed Value: before-start | |||||
offset[x] | 0..1 | Time offset for the relationship | ||||||
offsetDuration | Duration | |||||||
offsetRange | Range | |||||||
timing[x] | 0..1 | When the action should take place | ||||||
timingDateTime | dateTime | |||||||
timingAge | Age | |||||||
timingPeriod | Period | |||||||
timingDuration | Duration | |||||||
timingRange | Range | |||||||
timingTiming | Timing | |||||||
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 | |||||
action:createReport | S | 1..1 | BackboneElement | All constraints on action are intended to apply to any nested constraints. | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: create-hcs-report | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
trustServiceEndpoint | S | 0..1 | Reference(USPH Endpoint) | Indicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-trust-service-endpoint | ||||
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 Fixed Value: This action represents the creation, validation and submission of the health care survey report. | ||||
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 | 1..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 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://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: create-report | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
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/medmorph/StructureDefinition/us-ph-named-eventtype 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. Fixed Value: applicability | ||||
expression | S | 0..1 | Expression | Boolean-valued expression | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
description | Σ | 0..1 | string | Natural language description of the condition | ||||
name | Σ | 0..1 | id | Short name assigned to expression for reuse | ||||
language | SΣ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible): The media type of the expression language.
Fixed Value: text/fhirpath | ||||
expression | Σ | 0..1 | string | Expression in specified language | ||||
reference | Σ | 0..1 | uri | Where the expression is found | ||||
input | S | 0..* | DataRequirement | Input data requirements | ||||
id | S | 1..1 | string | Unique id for inter-element referencing | ||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
defaultQuery | S | 0..1 | string | US Public Health FHIR Query Pattern Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension | ||||
relatedDataId | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/medmorph/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 | ||||
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 | ||||
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 | S | 1..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 | SΣ | 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 | ||||
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 | ||||
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 Fixed Value: validate-hcs-report | ||||
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. Fixed Value: before-start | ||||
Slices for offset[x] | 0..1 | Duration | Time offset for the relationship Slice: Unordered, Closed by type:$this | |||||
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 | S | 0..* | See action (PlanDefinition) | A sub-action | ||||
action:validateReport | S | 1..1 | BackboneElement | All constraints on action are intended to apply to any nested constraints. | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: validate-hcs-report | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
trustServiceEndpoint | S | 0..1 | Reference(USPH Endpoint) | Indicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-trust-service-endpoint | ||||
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 Fixed Value: This action represents the validation of the HCS Report | ||||
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 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://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: validate-report | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
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/medmorph/StructureDefinition/us-ph-named-eventtype 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. Fixed Value: applicability | ||||
expression | S | 0..1 | Expression | Boolean-valued expression | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
description | Σ | 0..1 | string | Natural language description of the condition | ||||
name | Σ | 0..1 | id | Short name assigned to expression for reuse | ||||
language | SΣ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible): The media type of the expression language.
Fixed Value: text/fhirpath | ||||
expression | Σ | 0..1 | string | Expression in specified language | ||||
reference | Σ | 0..1 | uri | Where the expression is found | ||||
input | S | 0..* | DataRequirement | Input data requirements | ||||
id | S | 1..1 | string | Unique id for inter-element referencing | ||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
defaultQuery | S | 0..1 | string | US Public Health FHIR Query Pattern Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension | ||||
relatedDataId | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/medmorph/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 | ||||
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 | ||||
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 | S | 1..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 | SΣ | 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 | ||||
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 | ||||
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 Fixed Value: submit-hcs-report | ||||
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. Fixed Value: before-start | ||||
Slices for offset[x] | 0..1 | Duration | Time offset for the relationship Slice: Unordered, Closed by type:$this | |||||
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 | S | 0..* | See action (PlanDefinition) | A sub-action | ||||
action:submitHcsReport | S | 1..1 | BackboneElement | Route and send HCS Report | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: submit-hcs-report | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
trustServiceEndpoint | S | 0..1 | Reference(USPH Endpoint) | Indicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-trust-service-endpoint | ||||
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 | 1..1 | string | Description of the route and send action. Fixed Value: This action represents the routing and sending of the HCS Report | ||||
textEquivalent | S | 1..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system Fixed Value: Route and send HCS Report | ||||
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 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://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: submit-report | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
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/medmorph/StructureDefinition/us-ph-named-eventtype 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. Fixed Value: applicability | ||||
expression | S | 0..1 | Expression | Boolean-valued expression | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
description | Σ | 0..1 | string | Natural language description of the condition | ||||
name | Σ | 0..1 | id | Short name assigned to expression for reuse | ||||
language | SΣ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible): The media type of the expression language.
Fixed Value: text/fhirpath | ||||
expression | Σ | 0..1 | string | Expression in specified language | ||||
reference | Σ | 0..1 | uri | Where the expression is found | ||||
input | S | 0..* | DataRequirement | Input data requirements | ||||
id | S | 1..1 | string | Unique id for inter-element referencing | ||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
defaultQuery | S | 0..1 | string | US Public Health FHIR Query Pattern Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension | ||||
relatedDataId | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/medmorph/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 | ||||
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 | ||||
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 | SΣ | 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 | ||||
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 | ||||
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. Fixed Value: before-start | ||||
Slices for offset[x] | 0..1 | Duration | Time offset for the relationship Slice: Unordered, Closed by type:$this | |||||
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 | S | 0..* | See action (PlanDefinition) | A sub-action | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
PlanDefinition.language | preferred | CommonLanguages
| ||||
PlanDefinition.type | extensible | Pattern: workflow-definition("Workflow Definition") | ||||
PlanDefinition.status | required | PublicationStatus | ||||
PlanDefinition.subject[x] | extensible | SubjectType | ||||
PlanDefinition.jurisdiction | extensible | Jurisdiction ValueSet | ||||
PlanDefinition.topic | example | DefinitionTopic | ||||
PlanDefinition.goal.category | example | GoalCategory | ||||
PlanDefinition.goal.description | example | SNOMEDCTClinicalFindings | ||||
PlanDefinition.goal.priority | preferred | GoalPriority | ||||
PlanDefinition.goal.start | example | GoalStartEvent | ||||
PlanDefinition.goal.addresses | example | Condition/Problem/DiagnosisCodes | ||||
PlanDefinition.goal.target.measure | example | LOINCCodes (a valid code from LOINC) | ||||
PlanDefinition.action.priority | required | RequestPriority | ||||
PlanDefinition.action.code | extensible | USPublicHealthPlanDefinitionAction | ||||
PlanDefinition.action.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action.input.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action.input.sort.direction | required | SortDirection | ||||
PlanDefinition.action.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action.output.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action.output.sort.direction | required | SortDirection | ||||
PlanDefinition.action.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action.participant.type | required | ActionParticipantType | ||||
PlanDefinition.action.participant.role | example | ActionParticipantRole | ||||
PlanDefinition.action.type | extensible | ActionType | ||||
PlanDefinition.action.groupingBehavior | required | ActionGroupingBehavior | ||||
PlanDefinition.action.selectionBehavior | required | ActionSelectionBehavior | ||||
PlanDefinition.action.requiredBehavior | required | ActionRequiredBehavior | ||||
PlanDefinition.action.precheckBehavior | required | ActionPrecheckBehavior | ||||
PlanDefinition.action.cardinalityBehavior | required | ActionCardinalityBehavior | ||||
PlanDefinition.action:startWorkflow.priority | required | RequestPriority | ||||
PlanDefinition.action:startWorkflow.code | extensible | Pattern: initiate-reporting-workflow | ||||
PlanDefinition.action:startWorkflow.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:startWorkflow.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action:startWorkflow.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:startWorkflow.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:startWorkflow.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:startWorkflow.input.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:startWorkflow.input.sort.direction | required | SortDirection | ||||
PlanDefinition.action:startWorkflow.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action:startWorkflow.output.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:startWorkflow.output.sort.direction | required | SortDirection | ||||
PlanDefinition.action:startWorkflow.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:startWorkflow.participant.type | required | ActionParticipantType | ||||
PlanDefinition.action:startWorkflow.participant.role | example | ActionParticipantRole | ||||
PlanDefinition.action:startWorkflow.type | extensible | ActionType | ||||
PlanDefinition.action:startWorkflow.groupingBehavior | required | ActionGroupingBehavior | ||||
PlanDefinition.action:startWorkflow.selectionBehavior | required | ActionSelectionBehavior | ||||
PlanDefinition.action:startWorkflow.requiredBehavior | required | ActionRequiredBehavior | ||||
PlanDefinition.action:startWorkflow.precheckBehavior | required | ActionPrecheckBehavior | ||||
PlanDefinition.action:startWorkflow.cardinalityBehavior | required | ActionCardinalityBehavior | ||||
PlanDefinition.action:executeReportingWorkflow.priority | required | RequestPriority | ||||
PlanDefinition.action:executeReportingWorkflow.code | extensible | Pattern: execute-reporting-workflow | ||||
PlanDefinition.action:executeReportingWorkflow.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:executeReportingWorkflow.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action:executeReportingWorkflow.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:executeReportingWorkflow.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:executeReportingWorkflow.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:executeReportingWorkflow.input.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:executeReportingWorkflow.input.sort.direction | required | SortDirection | ||||
PlanDefinition.action:executeReportingWorkflow.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action:executeReportingWorkflow.output.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:executeReportingWorkflow.output.sort.direction | required | SortDirection | ||||
PlanDefinition.action:executeReportingWorkflow.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:executeReportingWorkflow.participant.type | required | ActionParticipantType | ||||
PlanDefinition.action:executeReportingWorkflow.participant.role | example | ActionParticipantRole | ||||
PlanDefinition.action:executeReportingWorkflow.type | extensible | ActionType | ||||
PlanDefinition.action:executeReportingWorkflow.groupingBehavior | required | ActionGroupingBehavior | ||||
PlanDefinition.action:executeReportingWorkflow.selectionBehavior | required | ActionSelectionBehavior | ||||
PlanDefinition.action:executeReportingWorkflow.requiredBehavior | required | ActionRequiredBehavior | ||||
PlanDefinition.action:executeReportingWorkflow.precheckBehavior | required | ActionPrecheckBehavior | ||||
PlanDefinition.action:executeReportingWorkflow.cardinalityBehavior | required | ActionCardinalityBehavior | ||||
PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.priority | required | RequestPriority | ||||
PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.sort.direction | required | SortDirection | ||||
PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.participant.type | required | ActionParticipantType | ||||
PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.participant.role | example | ActionParticipantRole | ||||
PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.type | extensible | ActionType | ||||
PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.groupingBehavior | required | ActionGroupingBehavior | ||||
PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.selectionBehavior | required | ActionSelectionBehavior | ||||
PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.requiredBehavior | required | ActionRequiredBehavior | ||||
PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.precheckBehavior | required | ActionPrecheckBehavior | ||||
PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.cardinalityBehavior | required | ActionCardinalityBehavior | ||||
PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.priority | required | RequestPriority | ||||
PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.sort.direction | required | SortDirection | ||||
PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.participant.type | required | ActionParticipantType | ||||
PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.participant.role | example | ActionParticipantRole | ||||
PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.type | extensible | ActionType | ||||
PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.groupingBehavior | required | ActionGroupingBehavior | ||||
PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.selectionBehavior | required | ActionSelectionBehavior | ||||
PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.requiredBehavior | required | ActionRequiredBehavior | ||||
PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.precheckBehavior | required | ActionPrecheckBehavior | ||||
PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.cardinalityBehavior | required | ActionCardinalityBehavior | ||||
PlanDefinition.action:createReport.priority | required | RequestPriority | ||||
PlanDefinition.action:createReport.code | extensible | Pattern: create-report | ||||
PlanDefinition.action:createReport.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:createReport.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action:createReport.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:createReport.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:createReport.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:createReport.input.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:createReport.input.sort.direction | required | SortDirection | ||||
PlanDefinition.action:createReport.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action:createReport.output.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:createReport.output.sort.direction | required | SortDirection | ||||
PlanDefinition.action:createReport.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:createReport.participant.type | required | ActionParticipantType | ||||
PlanDefinition.action:createReport.participant.role | example | ActionParticipantRole | ||||
PlanDefinition.action:createReport.type | extensible | ActionType | ||||
PlanDefinition.action:createReport.groupingBehavior | required | ActionGroupingBehavior | ||||
PlanDefinition.action:createReport.selectionBehavior | required | ActionSelectionBehavior | ||||
PlanDefinition.action:createReport.requiredBehavior | required | ActionRequiredBehavior | ||||
PlanDefinition.action:createReport.precheckBehavior | required | ActionPrecheckBehavior | ||||
PlanDefinition.action:createReport.cardinalityBehavior | required | ActionCardinalityBehavior | ||||
PlanDefinition.action:validateReport.priority | required | RequestPriority | ||||
PlanDefinition.action:validateReport.code | extensible | Pattern: validate-report | ||||
PlanDefinition.action:validateReport.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:validateReport.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action:validateReport.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:validateReport.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:validateReport.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:validateReport.input.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:validateReport.input.sort.direction | required | SortDirection | ||||
PlanDefinition.action:validateReport.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action:validateReport.output.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:validateReport.output.sort.direction | required | SortDirection | ||||
PlanDefinition.action:validateReport.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:validateReport.participant.type | required | ActionParticipantType | ||||
PlanDefinition.action:validateReport.participant.role | example | ActionParticipantRole | ||||
PlanDefinition.action:validateReport.type | extensible | ActionType | ||||
PlanDefinition.action:validateReport.groupingBehavior | required | ActionGroupingBehavior | ||||
PlanDefinition.action:validateReport.selectionBehavior | required | ActionSelectionBehavior | ||||
PlanDefinition.action:validateReport.requiredBehavior | required | ActionRequiredBehavior | ||||
PlanDefinition.action:validateReport.precheckBehavior | required | ActionPrecheckBehavior | ||||
PlanDefinition.action:validateReport.cardinalityBehavior | required | ActionCardinalityBehavior | ||||
PlanDefinition.action:submitHcsReport.priority | required | RequestPriority | ||||
PlanDefinition.action:submitHcsReport.code | extensible | Pattern: submit-report | ||||
PlanDefinition.action:submitHcsReport.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:submitHcsReport.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action:submitHcsReport.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:submitHcsReport.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:submitHcsReport.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:submitHcsReport.input.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:submitHcsReport.input.sort.direction | required | SortDirection | ||||
PlanDefinition.action:submitHcsReport.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action:submitHcsReport.output.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:submitHcsReport.output.sort.direction | required | SortDirection | ||||
PlanDefinition.action:submitHcsReport.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:submitHcsReport.participant.type | required | ActionParticipantType | ||||
PlanDefinition.action:submitHcsReport.participant.role | example | ActionParticipantRole | ||||
PlanDefinition.action:submitHcsReport.type | extensible | ActionType | ||||
PlanDefinition.action:submitHcsReport.groupingBehavior | required | ActionGroupingBehavior | ||||
PlanDefinition.action:submitHcsReport.selectionBehavior | required | ActionSelectionBehavior | ||||
PlanDefinition.action:submitHcsReport.requiredBehavior | required | ActionRequiredBehavior | ||||
PlanDefinition.action:submitHcsReport.precheckBehavior | required | ActionPrecheckBehavior | ||||
PlanDefinition.action:submitHcsReport.cardinalityBehavior | required | ActionCardinalityBehavior |
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, PlanDefinition.action:startWorkflow.input.codeFilter, PlanDefinition.action:startWorkflow.output.codeFilter, PlanDefinition.action:executeReportingWorkflow.input.codeFilter, PlanDefinition.action:executeReportingWorkflow.output.codeFilter, PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.codeFilter, PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.codeFilter, PlanDefinition.action:createReport.input.codeFilter, PlanDefinition.action:createReport.output.codeFilter, PlanDefinition.action:validateReport.input.codeFilter, PlanDefinition.action:validateReport.output.codeFilter, PlanDefinition.action:submitHcsReport.input.codeFilter, PlanDefinition.action:submitHcsReport.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, PlanDefinition.action:startWorkflow.input.dateFilter, PlanDefinition.action:startWorkflow.output.dateFilter, PlanDefinition.action:executeReportingWorkflow.input.dateFilter, PlanDefinition.action:executeReportingWorkflow.output.dateFilter, PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.dateFilter, PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.dateFilter, PlanDefinition.action:createReport.input.dateFilter, PlanDefinition.action:createReport.output.dateFilter, PlanDefinition.action:validateReport.input.dateFilter, PlanDefinition.action:validateReport.output.dateFilter, PlanDefinition.action:submitHcsReport.input.dateFilter, PlanDefinition.action:submitHcsReport.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 USPublicHealthPlanDefinition
Summary
Mandatory: 26 elements (9 nested mandatory elements)
Must-Support: 39 elements
Fixed Value: 30 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from USPublicHealthPlanDefinition
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
PlanDefinition | S | 1..1 | USPublicHealthPlanDefinition | Health Care Surveys Knowledge Artifact |
Slices for action | S | 5..* | BackboneElement | All constraints on action are intended to apply to any nested constraints. Slice: Ordered, Open by value:id |
action:All Slices | Content/Rules for all slices | |||
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 |
input | 0..* | DataRequirement | Input data requirements | |
action:startWorkflow | S | 1..1 | BackboneElement | Start Workflow Action |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: start-workflow |
description | S | 1..1 | string | Starts the workflow Fixed Value: This action represents the start of the reporting workflow in response to the encounter-end event |
textEquivalent | S | 1..1 | string | Text equivalent of the start workflow action. Fixed Value: Start the reporting workflow in response to an encounter-end event |
code | S | 1..1 | CodeableConcept | Code for the "start" action. 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://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: initiate-reporting-workflow | |
trigger | S | 1..* | TriggerDefinition | When the "start" action should be triggered. |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
namedEventType | S | 0..1 | CodeableConcept | Indicates the types of named events to subscribe to from the HER. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-named-eventtype Binding: US Public Health TriggerDefinition NamedEvent (extensible): US Public Health TriggerDefinition NamedEvents |
type | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Fixed Value: named-event | |
name | 0..1 | string | Name or URI that identifies the event Fixed Value: encounter-end | |
relatedAction | S | 1..1 | BackboneElement | Relationship to another action |
actionId | 1..1 | id | What action is this related to Fixed Value: check-reportability | |
relationship | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Fixed Value: before-start | |
offsetDuration | 0..1 | Duration | Time offset for the relationship Example Wait 72 hour before next action.: {"value":72,"unit":"h"} | |
action:executeReportingWorkflow | S | 1..1 | BackboneElement | Execute Reporting Workflow |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: check-reportability |
description | S | 1..1 | string | Check for reportability conditions Fixed Value: This action represents the start of the check for reportable conditions in response to the encounter-end event. This is an example of executing a reporting workflow with other actions. |
code | S | 1..1 | CodeableConcept | Code for the "execute-reporting-workflow" action. 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://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: execute-reporting-workflow | |
Slices for action | 2..* | A sub-action Slice: Unordered, Open by value:id | ||
action:isAmbulatoryEncounterReportable | S | 1..1 | BackboneElement | A sub-action |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: is-ambulatory-encounter-reportable |
code | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions 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://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: evaluate-condition | |
condition | 0..* | BackboneElement | Whether or not the action is applicable | |
kind | 1..1 | code | applicability | start | stop Fixed Value: applicability | |
expression | S | 1..1 | Expression | Boolean-valued expression |
language | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Fixed Value: text/fhirpath | |
input | S | 0..* | DataRequirement | Input data requirements |
id | S | 1..1 | string | Unique id for inter-element referencing |
relatedAction | 0..* | BackboneElement | Relationship to another action | |
actionId | 1..1 | id | What action is this related to Fixed Value: create-hcs-report | |
relationship | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Fixed Value: before-start | |
action:isInpatientEncounterReportable | S | 1..1 | BackboneElement | A sub-action |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: is-inpatient-encounter-reportable |
code | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions 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://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: evaluate-condition | |
condition | 0..* | BackboneElement | Whether or not the action is applicable | |
kind | 1..1 | code | applicability | start | stop Fixed Value: applicability | |
expression | S | 1..1 | Expression | Boolean-valued expression |
language | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Fixed Value: text/fhirpath | |
input | S | 0..* | DataRequirement | Input data requirements |
id | S | 1..1 | string | Unique id for inter-element referencing |
relatedAction | 0..* | BackboneElement | Relationship to another action | |
actionId | 1..1 | id | What action is this related to Fixed Value: create-hcs-report | |
relationship | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Fixed Value: before-start | |
action:createReport | 1..1 | BackboneElement | All constraints on action are intended to apply to any nested constraints. | |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: create-hcs-report |
description | 0..1 | string | Brief description of the action Fixed Value: This action represents the creation, validation and submission of the health care survey report. | |
code | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions 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://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: create-report | |
input | S | 0..* | DataRequirement | Input data requirements |
id | S | 1..1 | string | Unique id for inter-element referencing |
output | S | 0..* | DataRequirement | Output data definition |
id | S | 1..1 | string | Unique id for inter-element referencing |
relatedAction | 0..* | BackboneElement | Relationship to another action | |
actionId | 1..1 | id | What action is this related to Fixed Value: validate-hcs-report | |
relationship | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Fixed Value: before-start | |
action:validateReport | 1..1 | BackboneElement | All constraints on action are intended to apply to any nested constraints. | |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: validate-hcs-report |
description | 0..1 | string | Brief description of the action Fixed Value: This action represents the validation of the HCS Report | |
code | 0..1 | CodeableConcept | Code representing the meaning of the action or sub-actions 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://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: validate-report | |
input | S | 0..* | DataRequirement | Input data requirements |
id | S | 1..1 | string | Unique id for inter-element referencing |
output | S | 0..* | DataRequirement | Output data definition |
id | S | 1..1 | string | Unique id for inter-element referencing |
relatedAction | 0..* | BackboneElement | Relationship to another action | |
actionId | 1..1 | id | What action is this related to Fixed Value: submit-hcs-report | |
relationship | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Fixed Value: before-start | |
action:submitHcsReport | 1..1 | BackboneElement | Route and send HCS Report | |
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: submit-hcs-report |
description | S | 1..1 | string | Description of the route and send action. Fixed Value: This action represents the routing and sending of the HCS Report |
textEquivalent | S | 1..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system Fixed Value: Route and send HCS Report |
code | 0..1 | CodeableConcept | Code representing the meaning of the action or sub-actions 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://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: submit-report | |
input | S | 0..* | DataRequirement | Input data requirements |
id | S | 1..1 | string | Unique id for inter-element referencing |
Documentation for this format |
Path | Conformance | ValueSet |
PlanDefinition.action.code | extensible | USPublicHealthPlanDefinitionAction |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
PlanDefinition | SC | 1..1 | USPublicHealthPlanDefinition | Health Care Surveys Knowledge Artifact | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
receiverEndpoint | S | 0..1 | Reference(USPH Endpoint) | Indicates the address where the report has to be sent. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-receiver-endpoint | ||||
asyncIndicator | S | 0..1 | boolean | US Public Health Async Indicator Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-async-indicator | ||||
contentEncrypted | S | 0..1 | boolean | US Public Health Data Encrypted Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-data-encrypted-extension | ||||
jwksForContentEncryption | S | 0..1 | url | US Public Health Receiver Jwks Url URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-receiver-jwks-url | ||||
contentEncryptionAlgorithm | S | 0..1 | code | US Public Health Receiver Jwks Url URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-data-encryption-algorithm | ||||
expectedResponseDuration | S | 0..1 | Duration | US Public Health Expected Response Time Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-expected-responsetime | ||||
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 | Σ | 1..1 | string | Business version of the plan definition | ||||
name | ΣC | 1..1 | string | Name for this plan definition (computer friendly) | ||||
title | SΣ | 0..1 | string | Name for this plan definition (human friendly) | ||||
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 | ||||
Slices for action | S | 5..* | BackboneElement | All constraints on action are intended to apply to any nested constraints. Slice: Ordered, Open by value:id | ||||
action:All Slices | Content/Rules for all slices | |||||||
trustServiceEndpoint | S | 0..1 | Reference(USPH Endpoint) | Indicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-trust-service-endpoint | ||||
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 | ||||
namedEventType | S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-named-eventtype 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. Fixed Value: applicability | ||||
expression | S | 0..1 | Expression | Boolean-valued expression | ||||
language | SΣ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible): The media type of the expression language.
Fixed Value: text/fhirpath | ||||
input | S | 0..* | DataRequirement | Input data requirements | ||||
defaultQuery | S | 0..1 | string | US Public Health FHIR Query Pattern Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension | ||||
relatedDataId | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/medmorph/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. | ||||
profile | SΣ | 0..* | canonical(StructureDefinition) | The profile of the required data | ||||
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. Fixed Value: before-start | ||||
Slices for offset[x] | 0..1 | Duration | Time offset for the relationship Slice: Unordered, Closed by type:$this | |||||
offset[x]:offsetDuration | S | 0..1 | Duration | Time offset for the relationship | ||||
timing[x] | S | 0..1 | Duration | When the action should take place | ||||
action | S | 0..* | See action (PlanDefinition) | A sub-action | ||||
action:startWorkflow | S | 1..1 | BackboneElement | Start Workflow Action | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: start-workflow | ||||
trustServiceEndpoint | S | 0..1 | Reference(USPH Endpoint) | Indicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-trust-service-endpoint | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
description | S | 1..1 | string | Starts the workflow Fixed Value: This action represents the start of the reporting workflow in response to the encounter-end event | ||||
textEquivalent | S | 1..1 | string | Text equivalent of the start workflow action. Fixed Value: Start the reporting workflow in response to an encounter-end event | ||||
code | S | 1..1 | CodeableConcept | Code for the "start" action. Binding: US Public Health PlanDefinition Action (extensible): The set of actions that can be used to create plan definition 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://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: initiate-reporting-workflow | |||||
trigger | S | 1..* | TriggerDefinition | When the "start" action should be triggered. | ||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
namedEventType | S | 0..1 | CodeableConcept | Indicates the types of named events to subscribe to from the HER. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-named-eventtype 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 Fixed Value: encounter-end | ||||
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. Fixed Value: applicability | ||||
expression | S | 0..1 | Expression | Boolean-valued expression | ||||
language | SΣ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible): The media type of the expression language.
Fixed Value: text/fhirpath | ||||
input | S | 0..* | DataRequirement | Input data requirements | ||||
defaultQuery | S | 0..1 | string | US Public Health FHIR Query Pattern Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension | ||||
relatedDataId | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/medmorph/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. | ||||
profile | SΣ | 0..* | canonical(StructureDefinition) | The profile of the required data | ||||
relatedAction | S | 1..1 | 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 Fixed Value: check-reportability | ||||
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. Fixed Value: before-start | ||||
Slices for offset[x] | 0..1 | Duration | Time offset for the relationship Slice: Unordered, Closed by type:$this | |||||
offset[x]:offsetDuration | S | 0..1 | Duration | Time offset for the relationship Example Wait 72 hour before next action.: {"value":72,"unit":"h"} | ||||
timing[x] | S | 0..1 | Duration | When the action should take place | ||||
action | S | 0..* | See action (PlanDefinition) | A sub-action | ||||
action:executeReportingWorkflow | S | 1..1 | BackboneElement | Execute Reporting Workflow | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: check-reportability | ||||
trustServiceEndpoint | S | 0..1 | Reference(USPH Endpoint) | Indicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-trust-service-endpoint | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
description | S | 1..1 | string | Check for reportability conditions Fixed Value: This action represents the start of the check for reportable conditions in response to the encounter-end event. This is an example of executing a reporting workflow with other actions. | ||||
code | S | 1..1 | CodeableConcept | Code for the "execute-reporting-workflow" action. Binding: US Public Health PlanDefinition Action (extensible): The set of actions that can be used to create plan definition 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://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: execute-reporting-workflow | |||||
trigger | S | 0..* | TriggerDefinition | When the action should be triggered | ||||
namedEventType | S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-named-eventtype 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. Fixed Value: applicability | ||||
expression | S | 0..1 | Expression | Boolean-valued expression | ||||
language | SΣ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible): The media type of the expression language.
Fixed Value: text/fhirpath | ||||
input | S | 0..* | DataRequirement | Input data requirements | ||||
defaultQuery | S | 0..1 | string | US Public Health FHIR Query Pattern Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension | ||||
relatedDataId | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/medmorph/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. | ||||
profile | SΣ | 0..* | canonical(StructureDefinition) | The profile of the required data | ||||
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. Fixed Value: before-start | ||||
Slices for offset[x] | 0..1 | Duration | Time offset for the relationship Slice: Unordered, Closed by type:$this | |||||
offset[x]:offsetDuration | S | 0..1 | Duration | Time offset for the relationship | ||||
timing[x] | S | 0..1 | Duration | When the action should take place | ||||
Slices for action | S | 2..* | See action (PlanDefinition) | A sub-action Slice: Unordered, Open by value:id | ||||
action:isAmbulatoryEncounterReportable | S | 1..1 | BackboneElement | A sub-action | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: is-ambulatory-encounter-reportable | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions 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://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: evaluate-condition | |||||
condition | 0..* | BackboneElement | Whether or not the action is applicable | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
kind | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions. Fixed Value: applicability | |||||
expression | S | 1..1 | Expression | Boolean-valued expression | ||||
language | Σ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible): The media type of the expression language.
Fixed Value: text/fhirpath | ||||
input | S | 0..* | DataRequirement | Input data requirements | ||||
id | S | 1..1 | string | Unique id for inter-element referencing | ||||
type | Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types. | ||||
relatedAction | 0..* | BackboneElement | Relationship to another action | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
actionId | 1..1 | id | What action is this related to Fixed Value: create-hcs-report | |||||
relationship | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions. Fixed Value: before-start | |||||
action:isInpatientEncounterReportable | S | 1..1 | BackboneElement | A sub-action | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: is-inpatient-encounter-reportable | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions 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://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: evaluate-condition | |||||
condition | 0..* | BackboneElement | Whether or not the action is applicable | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
kind | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions. Fixed Value: applicability | |||||
expression | S | 1..1 | Expression | Boolean-valued expression | ||||
language | Σ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible): The media type of the expression language.
Fixed Value: text/fhirpath | ||||
input | S | 0..* | DataRequirement | Input data requirements | ||||
id | S | 1..1 | string | Unique id for inter-element referencing | ||||
type | Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types. | ||||
relatedAction | 0..* | BackboneElement | Relationship to another action | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
actionId | 1..1 | id | What action is this related to Fixed Value: create-hcs-report | |||||
relationship | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions. Fixed Value: before-start | |||||
action:createReport | S | 1..1 | BackboneElement | All constraints on action are intended to apply to any nested constraints. | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: create-hcs-report | ||||
trustServiceEndpoint | S | 0..1 | Reference(USPH Endpoint) | Indicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-trust-service-endpoint | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
description | S | 0..1 | string | Brief description of the action Fixed Value: This action represents the creation, validation and submission of the health care survey report. | ||||
code | S | 1..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 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://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: create-report | |||||
trigger | S | 0..* | TriggerDefinition | When the action should be triggered | ||||
namedEventType | S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-named-eventtype 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. Fixed Value: applicability | ||||
expression | S | 0..1 | Expression | Boolean-valued expression | ||||
language | SΣ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible): The media type of the expression language.
Fixed Value: text/fhirpath | ||||
input | S | 0..* | DataRequirement | Input data requirements | ||||
id | S | 1..1 | string | Unique id for inter-element referencing | ||||
defaultQuery | S | 0..1 | string | US Public Health FHIR Query Pattern Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension | ||||
relatedDataId | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/medmorph/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 | ||||
id | S | 1..1 | string | Unique id for inter-element referencing | ||||
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 | SΣ | 0..* | canonical(StructureDefinition) | The profile of the required data | ||||
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 Fixed Value: validate-hcs-report | ||||
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. Fixed Value: before-start | ||||
Slices for offset[x] | 0..1 | Duration | Time offset for the relationship Slice: Unordered, Closed by type:$this | |||||
offset[x]:offsetDuration | S | 0..1 | Duration | Time offset for the relationship | ||||
timing[x] | S | 0..1 | Duration | When the action should take place | ||||
action | S | 0..* | See action (PlanDefinition) | A sub-action | ||||
action:validateReport | S | 1..1 | BackboneElement | All constraints on action are intended to apply to any nested constraints. | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: validate-hcs-report | ||||
trustServiceEndpoint | S | 0..1 | Reference(USPH Endpoint) | Indicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-trust-service-endpoint | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
description | S | 0..1 | string | Brief description of the action Fixed Value: This action represents the validation of the HCS Report | ||||
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 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://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: validate-report | |||||
trigger | S | 0..* | TriggerDefinition | When the action should be triggered | ||||
namedEventType | S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-named-eventtype 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. Fixed Value: applicability | ||||
expression | S | 0..1 | Expression | Boolean-valued expression | ||||
language | SΣ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible): The media type of the expression language.
Fixed Value: text/fhirpath | ||||
input | S | 0..* | DataRequirement | Input data requirements | ||||
id | S | 1..1 | string | Unique id for inter-element referencing | ||||
defaultQuery | S | 0..1 | string | US Public Health FHIR Query Pattern Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension | ||||
relatedDataId | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/medmorph/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 | ||||
id | S | 1..1 | string | Unique id for inter-element referencing | ||||
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 | SΣ | 0..* | canonical(StructureDefinition) | The profile of the required data | ||||
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 Fixed Value: submit-hcs-report | ||||
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. Fixed Value: before-start | ||||
Slices for offset[x] | 0..1 | Duration | Time offset for the relationship Slice: Unordered, Closed by type:$this | |||||
offset[x]:offsetDuration | S | 0..1 | Duration | Time offset for the relationship | ||||
timing[x] | S | 0..1 | Duration | When the action should take place | ||||
action | S | 0..* | See action (PlanDefinition) | A sub-action | ||||
action:submitHcsReport | S | 1..1 | BackboneElement | Route and send HCS Report | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: submit-hcs-report | ||||
trustServiceEndpoint | S | 0..1 | Reference(USPH Endpoint) | Indicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-trust-service-endpoint | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
description | S | 1..1 | string | Description of the route and send action. Fixed Value: This action represents the routing and sending of the HCS Report | ||||
textEquivalent | S | 1..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system Fixed Value: Route and send HCS Report | ||||
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 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://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: submit-report | |||||
trigger | S | 0..* | TriggerDefinition | When the action should be triggered | ||||
namedEventType | S | 0..1 | CodeableConcept | US Public Health Named Event Type Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-named-eventtype 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. Fixed Value: applicability | ||||
expression | S | 0..1 | Expression | Boolean-valued expression | ||||
language | SΣ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible): The media type of the expression language.
Fixed Value: text/fhirpath | ||||
input | S | 0..* | DataRequirement | Input data requirements | ||||
id | S | 1..1 | string | Unique id for inter-element referencing | ||||
defaultQuery | S | 0..1 | string | US Public Health FHIR Query Pattern Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension | ||||
relatedDataId | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/medmorph/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. | ||||
profile | SΣ | 0..* | canonical(StructureDefinition) | The profile of the required data | ||||
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. Fixed Value: before-start | ||||
Slices for offset[x] | 0..1 | Duration | Time offset for the relationship Slice: Unordered, Closed by type:$this | |||||
offset[x]:offsetDuration | S | 0..1 | Duration | Time offset for the relationship | ||||
timing[x] | S | 0..1 | Duration | When the action should take place | ||||
action | S | 0..* | See action (PlanDefinition) | A sub-action | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
PlanDefinition.type | extensible | Pattern: workflow-definition("Workflow Definition") | ||||
PlanDefinition.status | required | PublicationStatus | ||||
PlanDefinition.subject[x] | extensible | SubjectType | ||||
PlanDefinition.jurisdiction | extensible | Jurisdiction ValueSet | ||||
PlanDefinition.action.code | extensible | USPublicHealthPlanDefinitionAction | ||||
PlanDefinition.action.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:startWorkflow.code | extensible | Pattern: initiate-reporting-workflow | ||||
PlanDefinition.action:startWorkflow.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action:startWorkflow.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:startWorkflow.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:startWorkflow.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:startWorkflow.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action:startWorkflow.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:executeReportingWorkflow.code | extensible | Pattern: execute-reporting-workflow | ||||
PlanDefinition.action:executeReportingWorkflow.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action:executeReportingWorkflow.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:executeReportingWorkflow.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:executeReportingWorkflow.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:executeReportingWorkflow.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action:executeReportingWorkflow.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:createReport.code | extensible | Pattern: create-report | ||||
PlanDefinition.action:createReport.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action:createReport.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:createReport.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:createReport.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:createReport.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action:createReport.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:validateReport.code | extensible | Pattern: validate-report | ||||
PlanDefinition.action:validateReport.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action:validateReport.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:validateReport.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:validateReport.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:validateReport.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action:validateReport.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:submitHcsReport.code | extensible | Pattern: submit-report | ||||
PlanDefinition.action:submitHcsReport.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action:submitHcsReport.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:submitHcsReport.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:submitHcsReport.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:submitHcsReport.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action:submitHcsReport.relatedAction.relationship | required | Fixed Value: before-start |
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 | SC | 1..1 | USPublicHealthPlanDefinition | Health Care Surveys Knowledge Artifact | ||||
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 | |||||
receiverEndpoint | S | 0..1 | Reference(USPH Endpoint) | Indicates the address where the report has to be sent. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-receiver-endpoint | ||||
asyncIndicator | S | 0..1 | boolean | US Public Health Async Indicator Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-async-indicator | ||||
contentEncrypted | S | 0..1 | boolean | US Public Health Data Encrypted Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-data-encrypted-extension | ||||
jwksForContentEncryption | S | 0..1 | url | US Public Health Receiver Jwks Url URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-receiver-jwks-url | ||||
contentEncryptionAlgorithm | S | 0..1 | code | US Public Health Receiver Jwks Url URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-data-encryption-algorithm | ||||
expectedResponseDuration | S | 0..1 | Duration | US Public Health Expected Response Time Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-expected-responsetime | ||||
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 | Σ | 1..1 | string | Business version of the plan definition | ||||
name | ΣC | 1..1 | string | Name for this plan definition (computer friendly) | ||||
title | SΣ | 0..1 | string | Name for this plan definition (human friendly) | ||||
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 | |||||
Slices for action | S | 5..* | BackboneElement | All constraints on action are intended to apply to any nested constraints. Slice: Ordered, Open by value:id | ||||
action:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
trustServiceEndpoint | S | 0..1 | Reference(USPH Endpoint) | Indicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-trust-service-endpoint | ||||
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/medmorph/StructureDefinition/us-ph-named-eventtype 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. Fixed Value: applicability | ||||
expression | S | 0..1 | Expression | Boolean-valued expression | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
description | Σ | 0..1 | string | Natural language description of the condition | ||||
name | Σ | 0..1 | id | Short name assigned to expression for reuse | ||||
language | SΣ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible): The media type of the expression language.
Fixed Value: text/fhirpath | ||||
expression | Σ | 0..1 | string | Expression in specified language | ||||
reference | Σ | 0..1 | uri | Where the expression is found | ||||
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 | |||||
defaultQuery | S | 0..1 | string | US Public Health FHIR Query Pattern Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension | ||||
relatedDataId | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/medmorph/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 | ||||
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 | ||||
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 | SΣ | 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 | ||||
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 | ||||
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. Fixed Value: before-start | ||||
Slices for offset[x] | 0..1 | Duration | Time offset for the relationship Slice: Unordered, Closed by type:$this | |||||
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 | S | 0..* | See action (PlanDefinition) | A sub-action | ||||
action:startWorkflow | S | 1..1 | BackboneElement | Start Workflow Action | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: start-workflow | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
trustServiceEndpoint | S | 0..1 | Reference(USPH Endpoint) | Indicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-trust-service-endpoint | ||||
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 | 1..1 | string | Starts the workflow Fixed Value: This action represents the start of the reporting workflow in response to the encounter-end event | ||||
textEquivalent | S | 1..1 | string | Text equivalent of the start workflow action. Fixed Value: Start the reporting workflow in response to an encounter-end event | ||||
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 | 1..1 | CodeableConcept | Code for the "start" action. Binding: US Public Health PlanDefinition Action (extensible): The set of actions that can be used to create plan definition 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://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: initiate-reporting-workflow | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
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 | 1..* | TriggerDefinition | When the "start" 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 | Indicates the types of named events to subscribe to from the HER. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-named-eventtype 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 Fixed Value: encounter-end | ||||
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. Fixed Value: applicability | ||||
expression | S | 0..1 | Expression | Boolean-valued expression | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
description | Σ | 0..1 | string | Natural language description of the condition | ||||
name | Σ | 0..1 | id | Short name assigned to expression for reuse | ||||
language | SΣ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible): The media type of the expression language.
Fixed Value: text/fhirpath | ||||
expression | Σ | 0..1 | string | Expression in specified language | ||||
reference | Σ | 0..1 | uri | Where the expression is found | ||||
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 | |||||
defaultQuery | S | 0..1 | string | US Public Health FHIR Query Pattern Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension | ||||
relatedDataId | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/medmorph/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 | ||||
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 | ||||
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 | SΣ | 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 | ||||
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 | ||||
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 | 1..1 | 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 Fixed Value: check-reportability | ||||
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. Fixed Value: before-start | ||||
Slices for offset[x] | 0..1 | Duration | Time offset for the relationship Slice: Unordered, Closed by type:$this | |||||
offset[x]:offsetDuration | S | 0..1 | Duration | Time offset for the relationship Example Wait 72 hour before next action.: {"value":72,"unit":"h"} | ||||
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 | S | 0..* | See action (PlanDefinition) | A sub-action | ||||
action:executeReportingWorkflow | S | 1..1 | BackboneElement | Execute Reporting Workflow | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: check-reportability | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
trustServiceEndpoint | S | 0..1 | Reference(USPH Endpoint) | Indicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-trust-service-endpoint | ||||
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 | 1..1 | string | Check for reportability conditions Fixed Value: This action represents the start of the check for reportable conditions in response to the encounter-end event. This is an example of executing a reporting workflow with other actions. | ||||
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 | 1..1 | CodeableConcept | Code for the "execute-reporting-workflow" action. Binding: US Public Health PlanDefinition Action (extensible): The set of actions that can be used to create plan definition 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://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: execute-reporting-workflow | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
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/medmorph/StructureDefinition/us-ph-named-eventtype 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. Fixed Value: applicability | ||||
expression | S | 0..1 | Expression | Boolean-valued expression | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
description | Σ | 0..1 | string | Natural language description of the condition | ||||
name | Σ | 0..1 | id | Short name assigned to expression for reuse | ||||
language | SΣ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible): The media type of the expression language.
Fixed Value: text/fhirpath | ||||
expression | Σ | 0..1 | string | Expression in specified language | ||||
reference | Σ | 0..1 | uri | Where the expression is found | ||||
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 | |||||
defaultQuery | S | 0..1 | string | US Public Health FHIR Query Pattern Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension | ||||
relatedDataId | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/medmorph/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 | ||||
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 | ||||
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 | SΣ | 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 | ||||
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 | ||||
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. Fixed Value: before-start | ||||
Slices for offset[x] | 0..1 | Duration | Time offset for the relationship Slice: Unordered, Closed by type:$this | |||||
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 | |||||
Slices for action | S | 2..* | See action (PlanDefinition) | A sub-action Slice: Unordered, Open by value:id | ||||
action:isAmbulatoryEncounterReportable | S | 1..1 | BackboneElement | A sub-action | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: is-ambulatory-encounter-reportable | ||||
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 | 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 | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions 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://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: evaluate-condition | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
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 | 0..* | TriggerDefinition | When the action should be triggered | |||||
condition | 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 | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions. Fixed Value: applicability | |||||
expression | S | 1..1 | Expression | Boolean-valued expression | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
description | Σ | 0..1 | string | Natural language description of the condition | ||||
name | Σ | 0..1 | id | Short name assigned to expression for reuse | ||||
language | Σ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible): The media type of the expression language.
Fixed Value: text/fhirpath | ||||
expression | Σ | 0..1 | string | Expression in specified language | ||||
reference | Σ | 0..1 | uri | Where the expression is found | ||||
input | S | 0..* | DataRequirement | Input data requirements | ||||
id | S | 1..1 | string | Unique id for inter-element referencing | ||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
type | Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types. | ||||
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 | ||||
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 | ||||
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 | 0..* | DataRequirement | Output data definition | |||||
relatedAction | 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 | 1..1 | id | What action is this related to Fixed Value: create-hcs-report | |||||
relationship | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions. Fixed Value: before-start | |||||
offset[x] | 0..1 | Time offset for the relationship | ||||||
offsetDuration | Duration | |||||||
offsetRange | Range | |||||||
timing[x] | 0..1 | When the action should take place | ||||||
timingDateTime | dateTime | |||||||
timingAge | Age | |||||||
timingPeriod | Period | |||||||
timingDuration | Duration | |||||||
timingRange | Range | |||||||
timingTiming | Timing | |||||||
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 | |||||
action:isInpatientEncounterReportable | S | 1..1 | BackboneElement | A sub-action | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: is-inpatient-encounter-reportable | ||||
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 | 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 | 1..1 | CodeableConcept | Code representing the meaning of the action or sub-actions 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://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: evaluate-condition | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
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 | 0..* | TriggerDefinition | When the action should be triggered | |||||
condition | 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 | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions. Fixed Value: applicability | |||||
expression | S | 1..1 | Expression | Boolean-valued expression | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
description | Σ | 0..1 | string | Natural language description of the condition | ||||
name | Σ | 0..1 | id | Short name assigned to expression for reuse | ||||
language | Σ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible): The media type of the expression language.
Fixed Value: text/fhirpath | ||||
expression | Σ | 0..1 | string | Expression in specified language | ||||
reference | Σ | 0..1 | uri | Where the expression is found | ||||
input | S | 0..* | DataRequirement | Input data requirements | ||||
id | S | 1..1 | string | Unique id for inter-element referencing | ||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
type | Σ | 1..1 | code | The type of the required data Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types. | ||||
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 | ||||
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 | ||||
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 | 0..* | DataRequirement | Output data definition | |||||
relatedAction | 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 | 1..1 | id | What action is this related to Fixed Value: create-hcs-report | |||||
relationship | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions. Fixed Value: before-start | |||||
offset[x] | 0..1 | Time offset for the relationship | ||||||
offsetDuration | Duration | |||||||
offsetRange | Range | |||||||
timing[x] | 0..1 | When the action should take place | ||||||
timingDateTime | dateTime | |||||||
timingAge | Age | |||||||
timingPeriod | Period | |||||||
timingDuration | Duration | |||||||
timingRange | Range | |||||||
timingTiming | Timing | |||||||
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 | |||||
action:createReport | S | 1..1 | BackboneElement | All constraints on action are intended to apply to any nested constraints. | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: create-hcs-report | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
trustServiceEndpoint | S | 0..1 | Reference(USPH Endpoint) | Indicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-trust-service-endpoint | ||||
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 Fixed Value: This action represents the creation, validation and submission of the health care survey report. | ||||
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 | 1..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 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://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: create-report | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
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/medmorph/StructureDefinition/us-ph-named-eventtype 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. Fixed Value: applicability | ||||
expression | S | 0..1 | Expression | Boolean-valued expression | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
description | Σ | 0..1 | string | Natural language description of the condition | ||||
name | Σ | 0..1 | id | Short name assigned to expression for reuse | ||||
language | SΣ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible): The media type of the expression language.
Fixed Value: text/fhirpath | ||||
expression | Σ | 0..1 | string | Expression in specified language | ||||
reference | Σ | 0..1 | uri | Where the expression is found | ||||
input | S | 0..* | DataRequirement | Input data requirements | ||||
id | S | 1..1 | string | Unique id for inter-element referencing | ||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
defaultQuery | S | 0..1 | string | US Public Health FHIR Query Pattern Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension | ||||
relatedDataId | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/medmorph/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 | ||||
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 | ||||
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 | S | 1..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 | SΣ | 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 | ||||
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 | ||||
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 Fixed Value: validate-hcs-report | ||||
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. Fixed Value: before-start | ||||
Slices for offset[x] | 0..1 | Duration | Time offset for the relationship Slice: Unordered, Closed by type:$this | |||||
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 | S | 0..* | See action (PlanDefinition) | A sub-action | ||||
action:validateReport | S | 1..1 | BackboneElement | All constraints on action are intended to apply to any nested constraints. | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: validate-hcs-report | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
trustServiceEndpoint | S | 0..1 | Reference(USPH Endpoint) | Indicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-trust-service-endpoint | ||||
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 Fixed Value: This action represents the validation of the HCS Report | ||||
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 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://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: validate-report | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
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/medmorph/StructureDefinition/us-ph-named-eventtype 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. Fixed Value: applicability | ||||
expression | S | 0..1 | Expression | Boolean-valued expression | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
description | Σ | 0..1 | string | Natural language description of the condition | ||||
name | Σ | 0..1 | id | Short name assigned to expression for reuse | ||||
language | SΣ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible): The media type of the expression language.
Fixed Value: text/fhirpath | ||||
expression | Σ | 0..1 | string | Expression in specified language | ||||
reference | Σ | 0..1 | uri | Where the expression is found | ||||
input | S | 0..* | DataRequirement | Input data requirements | ||||
id | S | 1..1 | string | Unique id for inter-element referencing | ||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
defaultQuery | S | 0..1 | string | US Public Health FHIR Query Pattern Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension | ||||
relatedDataId | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/medmorph/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 | ||||
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 | ||||
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 | S | 1..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 | SΣ | 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 | ||||
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 | ||||
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 Fixed Value: submit-hcs-report | ||||
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. Fixed Value: before-start | ||||
Slices for offset[x] | 0..1 | Duration | Time offset for the relationship Slice: Unordered, Closed by type:$this | |||||
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 | S | 0..* | See action (PlanDefinition) | A sub-action | ||||
action:submitHcsReport | S | 1..1 | BackboneElement | Route and send HCS Report | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Fixed Value: submit-hcs-report | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
trustServiceEndpoint | S | 0..1 | Reference(USPH Endpoint) | Indicates the endpoint address which implements Trust Services and can be used by specific actions requiring trust services with appropriate authorities and policies. URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-trust-service-endpoint | ||||
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 | 1..1 | string | Description of the route and send action. Fixed Value: This action represents the routing and sending of the HCS Report | ||||
textEquivalent | S | 1..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system Fixed Value: Route and send HCS Report | ||||
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 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://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: submit-report | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
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/medmorph/StructureDefinition/us-ph-named-eventtype 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. Fixed Value: applicability | ||||
expression | S | 0..1 | Expression | Boolean-valued expression | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
description | Σ | 0..1 | string | Natural language description of the condition | ||||
name | Σ | 0..1 | id | Short name assigned to expression for reuse | ||||
language | SΣ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible): The media type of the expression language.
Fixed Value: text/fhirpath | ||||
expression | Σ | 0..1 | string | Expression in specified language | ||||
reference | Σ | 0..1 | uri | Where the expression is found | ||||
input | S | 0..* | DataRequirement | Input data requirements | ||||
id | S | 1..1 | string | Unique id for inter-element referencing | ||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
defaultQuery | S | 0..1 | string | US Public Health FHIR Query Pattern Extension URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension | ||||
relatedDataId | S | 0..1 | string | US Public Health Related Data Extension URL: http://hl7.org/fhir/us/medmorph/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 | ||||
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 | ||||
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 | SΣ | 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 | ||||
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 | ||||
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. Fixed Value: before-start | ||||
Slices for offset[x] | 0..1 | Duration | Time offset for the relationship Slice: Unordered, Closed by type:$this | |||||
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 | S | 0..* | See action (PlanDefinition) | A sub-action | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
PlanDefinition.language | preferred | CommonLanguages
| ||||
PlanDefinition.type | extensible | Pattern: workflow-definition("Workflow Definition") | ||||
PlanDefinition.status | required | PublicationStatus | ||||
PlanDefinition.subject[x] | extensible | SubjectType | ||||
PlanDefinition.jurisdiction | extensible | Jurisdiction ValueSet | ||||
PlanDefinition.topic | example | DefinitionTopic | ||||
PlanDefinition.goal.category | example | GoalCategory | ||||
PlanDefinition.goal.description | example | SNOMEDCTClinicalFindings | ||||
PlanDefinition.goal.priority | preferred | GoalPriority | ||||
PlanDefinition.goal.start | example | GoalStartEvent | ||||
PlanDefinition.goal.addresses | example | Condition/Problem/DiagnosisCodes | ||||
PlanDefinition.goal.target.measure | example | LOINCCodes (a valid code from LOINC) | ||||
PlanDefinition.action.priority | required | RequestPriority | ||||
PlanDefinition.action.code | extensible | USPublicHealthPlanDefinitionAction | ||||
PlanDefinition.action.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action.input.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action.input.sort.direction | required | SortDirection | ||||
PlanDefinition.action.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action.output.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action.output.sort.direction | required | SortDirection | ||||
PlanDefinition.action.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action.participant.type | required | ActionParticipantType | ||||
PlanDefinition.action.participant.role | example | ActionParticipantRole | ||||
PlanDefinition.action.type | extensible | ActionType | ||||
PlanDefinition.action.groupingBehavior | required | ActionGroupingBehavior | ||||
PlanDefinition.action.selectionBehavior | required | ActionSelectionBehavior | ||||
PlanDefinition.action.requiredBehavior | required | ActionRequiredBehavior | ||||
PlanDefinition.action.precheckBehavior | required | ActionPrecheckBehavior | ||||
PlanDefinition.action.cardinalityBehavior | required | ActionCardinalityBehavior | ||||
PlanDefinition.action:startWorkflow.priority | required | RequestPriority | ||||
PlanDefinition.action:startWorkflow.code | extensible | Pattern: initiate-reporting-workflow | ||||
PlanDefinition.action:startWorkflow.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:startWorkflow.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action:startWorkflow.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:startWorkflow.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:startWorkflow.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:startWorkflow.input.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:startWorkflow.input.sort.direction | required | SortDirection | ||||
PlanDefinition.action:startWorkflow.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action:startWorkflow.output.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:startWorkflow.output.sort.direction | required | SortDirection | ||||
PlanDefinition.action:startWorkflow.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:startWorkflow.participant.type | required | ActionParticipantType | ||||
PlanDefinition.action:startWorkflow.participant.role | example | ActionParticipantRole | ||||
PlanDefinition.action:startWorkflow.type | extensible | ActionType | ||||
PlanDefinition.action:startWorkflow.groupingBehavior | required | ActionGroupingBehavior | ||||
PlanDefinition.action:startWorkflow.selectionBehavior | required | ActionSelectionBehavior | ||||
PlanDefinition.action:startWorkflow.requiredBehavior | required | ActionRequiredBehavior | ||||
PlanDefinition.action:startWorkflow.precheckBehavior | required | ActionPrecheckBehavior | ||||
PlanDefinition.action:startWorkflow.cardinalityBehavior | required | ActionCardinalityBehavior | ||||
PlanDefinition.action:executeReportingWorkflow.priority | required | RequestPriority | ||||
PlanDefinition.action:executeReportingWorkflow.code | extensible | Pattern: execute-reporting-workflow | ||||
PlanDefinition.action:executeReportingWorkflow.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:executeReportingWorkflow.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action:executeReportingWorkflow.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:executeReportingWorkflow.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:executeReportingWorkflow.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:executeReportingWorkflow.input.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:executeReportingWorkflow.input.sort.direction | required | SortDirection | ||||
PlanDefinition.action:executeReportingWorkflow.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action:executeReportingWorkflow.output.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:executeReportingWorkflow.output.sort.direction | required | SortDirection | ||||
PlanDefinition.action:executeReportingWorkflow.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:executeReportingWorkflow.participant.type | required | ActionParticipantType | ||||
PlanDefinition.action:executeReportingWorkflow.participant.role | example | ActionParticipantRole | ||||
PlanDefinition.action:executeReportingWorkflow.type | extensible | ActionType | ||||
PlanDefinition.action:executeReportingWorkflow.groupingBehavior | required | ActionGroupingBehavior | ||||
PlanDefinition.action:executeReportingWorkflow.selectionBehavior | required | ActionSelectionBehavior | ||||
PlanDefinition.action:executeReportingWorkflow.requiredBehavior | required | ActionRequiredBehavior | ||||
PlanDefinition.action:executeReportingWorkflow.precheckBehavior | required | ActionPrecheckBehavior | ||||
PlanDefinition.action:executeReportingWorkflow.cardinalityBehavior | required | ActionCardinalityBehavior | ||||
PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.priority | required | RequestPriority | ||||
PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.sort.direction | required | SortDirection | ||||
PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.participant.type | required | ActionParticipantType | ||||
PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.participant.role | example | ActionParticipantRole | ||||
PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.type | extensible | ActionType | ||||
PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.groupingBehavior | required | ActionGroupingBehavior | ||||
PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.selectionBehavior | required | ActionSelectionBehavior | ||||
PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.requiredBehavior | required | ActionRequiredBehavior | ||||
PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.precheckBehavior | required | ActionPrecheckBehavior | ||||
PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.cardinalityBehavior | required | ActionCardinalityBehavior | ||||
PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.priority | required | RequestPriority | ||||
PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.sort.direction | required | SortDirection | ||||
PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.participant.type | required | ActionParticipantType | ||||
PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.participant.role | example | ActionParticipantRole | ||||
PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.type | extensible | ActionType | ||||
PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.groupingBehavior | required | ActionGroupingBehavior | ||||
PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.selectionBehavior | required | ActionSelectionBehavior | ||||
PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.requiredBehavior | required | ActionRequiredBehavior | ||||
PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.precheckBehavior | required | ActionPrecheckBehavior | ||||
PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.cardinalityBehavior | required | ActionCardinalityBehavior | ||||
PlanDefinition.action:createReport.priority | required | RequestPriority | ||||
PlanDefinition.action:createReport.code | extensible | Pattern: create-report | ||||
PlanDefinition.action:createReport.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:createReport.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action:createReport.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:createReport.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:createReport.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:createReport.input.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:createReport.input.sort.direction | required | SortDirection | ||||
PlanDefinition.action:createReport.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action:createReport.output.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:createReport.output.sort.direction | required | SortDirection | ||||
PlanDefinition.action:createReport.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:createReport.participant.type | required | ActionParticipantType | ||||
PlanDefinition.action:createReport.participant.role | example | ActionParticipantRole | ||||
PlanDefinition.action:createReport.type | extensible | ActionType | ||||
PlanDefinition.action:createReport.groupingBehavior | required | ActionGroupingBehavior | ||||
PlanDefinition.action:createReport.selectionBehavior | required | ActionSelectionBehavior | ||||
PlanDefinition.action:createReport.requiredBehavior | required | ActionRequiredBehavior | ||||
PlanDefinition.action:createReport.precheckBehavior | required | ActionPrecheckBehavior | ||||
PlanDefinition.action:createReport.cardinalityBehavior | required | ActionCardinalityBehavior | ||||
PlanDefinition.action:validateReport.priority | required | RequestPriority | ||||
PlanDefinition.action:validateReport.code | extensible | Pattern: validate-report | ||||
PlanDefinition.action:validateReport.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:validateReport.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action:validateReport.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:validateReport.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:validateReport.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:validateReport.input.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:validateReport.input.sort.direction | required | SortDirection | ||||
PlanDefinition.action:validateReport.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action:validateReport.output.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:validateReport.output.sort.direction | required | SortDirection | ||||
PlanDefinition.action:validateReport.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:validateReport.participant.type | required | ActionParticipantType | ||||
PlanDefinition.action:validateReport.participant.role | example | ActionParticipantRole | ||||
PlanDefinition.action:validateReport.type | extensible | ActionType | ||||
PlanDefinition.action:validateReport.groupingBehavior | required | ActionGroupingBehavior | ||||
PlanDefinition.action:validateReport.selectionBehavior | required | ActionSelectionBehavior | ||||
PlanDefinition.action:validateReport.requiredBehavior | required | ActionRequiredBehavior | ||||
PlanDefinition.action:validateReport.precheckBehavior | required | ActionPrecheckBehavior | ||||
PlanDefinition.action:validateReport.cardinalityBehavior | required | ActionCardinalityBehavior | ||||
PlanDefinition.action:submitHcsReport.priority | required | RequestPriority | ||||
PlanDefinition.action:submitHcsReport.code | extensible | Pattern: submit-report | ||||
PlanDefinition.action:submitHcsReport.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:submitHcsReport.trigger.type | required | Fixed Value: named-event | ||||
PlanDefinition.action:submitHcsReport.condition.kind | required | Fixed Value: applicability | ||||
PlanDefinition.action:submitHcsReport.condition.expression.language | extensible | Fixed Value: text/fhirpath
| ||||
PlanDefinition.action:submitHcsReport.input.type | required | FHIRAllTypes | ||||
PlanDefinition.action:submitHcsReport.input.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:submitHcsReport.input.sort.direction | required | SortDirection | ||||
PlanDefinition.action:submitHcsReport.output.type | required | FHIRAllTypes | ||||
PlanDefinition.action:submitHcsReport.output.subject[x] | extensible | SubjectType | ||||
PlanDefinition.action:submitHcsReport.output.sort.direction | required | SortDirection | ||||
PlanDefinition.action:submitHcsReport.relatedAction.relationship | required | Fixed Value: before-start | ||||
PlanDefinition.action:submitHcsReport.participant.type | required | ActionParticipantType | ||||
PlanDefinition.action:submitHcsReport.participant.role | example | ActionParticipantRole | ||||
PlanDefinition.action:submitHcsReport.type | extensible | ActionType | ||||
PlanDefinition.action:submitHcsReport.groupingBehavior | required | ActionGroupingBehavior | ||||
PlanDefinition.action:submitHcsReport.selectionBehavior | required | ActionSelectionBehavior | ||||
PlanDefinition.action:submitHcsReport.requiredBehavior | required | ActionRequiredBehavior | ||||
PlanDefinition.action:submitHcsReport.precheckBehavior | required | ActionPrecheckBehavior | ||||
PlanDefinition.action:submitHcsReport.cardinalityBehavior | required | ActionCardinalityBehavior |
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, PlanDefinition.action:startWorkflow.input.codeFilter, PlanDefinition.action:startWorkflow.output.codeFilter, PlanDefinition.action:executeReportingWorkflow.input.codeFilter, PlanDefinition.action:executeReportingWorkflow.output.codeFilter, PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.codeFilter, PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.codeFilter, PlanDefinition.action:createReport.input.codeFilter, PlanDefinition.action:createReport.output.codeFilter, PlanDefinition.action:validateReport.input.codeFilter, PlanDefinition.action:validateReport.output.codeFilter, PlanDefinition.action:submitHcsReport.input.codeFilter, PlanDefinition.action:submitHcsReport.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, PlanDefinition.action:startWorkflow.input.dateFilter, PlanDefinition.action:startWorkflow.output.dateFilter, PlanDefinition.action:executeReportingWorkflow.input.dateFilter, PlanDefinition.action:executeReportingWorkflow.output.dateFilter, PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.dateFilter, PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.dateFilter, PlanDefinition.action:createReport.input.dateFilter, PlanDefinition.action:createReport.output.dateFilter, PlanDefinition.action:validateReport.input.dateFilter, PlanDefinition.action:validateReport.output.dateFilter, PlanDefinition.action:submitHcsReport.input.dateFilter, PlanDefinition.action:submitHcsReport.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 USPublicHealthPlanDefinition
Summary
Mandatory: 26 elements (9 nested mandatory elements)
Must-Support: 39 elements
Fixed Value: 30 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron