Respiratory Virus Hospitalization Surveillance Network (RESP-NET) Content Implementation Guide
1.0.0-ballot - STU1 Ballot United States of America flag

Respiratory Virus Hospitalization Surveillance Network (RESP-NET) Content Implementation Guide, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-resp-net-ig/ and changes regularly. See the Directory of published versions

Resource Profile: RESP-NET PlanDefinition

Official URL: http://hl7.org/fhir/us/resp-net/StructureDefinition/resp-net-plandefinition Version: 1.0.0-ballot
Active as of 2023-12-21 Computable Name: RESPNETPlanDefinition

This PlanDefinition profile defines the logic and rules around determining: whether or not data from an encounter is reportable to RESP-NET.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from USPublicHealthPlanDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition S1..1USPublicHealthPlanDefinitionRESP-NET Knowledge Artifact
... Slices for action S6..*BackboneElementAll 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 S0..1CodeableConceptCode 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..*DataRequirementInput data requirements
.... action:startWorkflow S1..1BackboneElementStart Workflow Action
..... id S1..1stringUnique id for inter-element referencing
Fixed Value: start-workflow
..... description S1..1stringStarts the workflow
Fixed Value: This action represents the start of the reporting workflow in response to the encounter-end event
..... textEquivalent S1..1stringText equivalent of the start workflow action.
Fixed Value: Start the reporting workflow in response to an encounter-end event
..... code S1..1CodeableConceptCode for the "start" action.
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: initiate-reporting-workflow
..... trigger S1..*TriggerDefinitionWhen the "start" action should be triggered.
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... namedEventType S0..1CodeableConceptIndicates the types of named events to subscribe to from the EHR.
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..1codenamed-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Fixed Value: named-event
...... name 0..1stringName or URI that identifies the event
Fixed Value: encounter-end
..... relatedAction S1..1BackboneElementRelationship to another action
...... actionId 1..1idWhat action is this related to
Fixed Value: check-reportability
...... relationship 1..1codebefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Fixed Value: before-start
...... offsetDuration 0..1DurationTime offset for the relationship
Example Wait 72 hour before next action.: {"value":72,"unit":"h"}
.... action:positiveLabResultWorkflow S1..1BackboneElementStart Workflow Action due to a positive lab result
..... id S1..1stringUnique id for inter-element referencing
Fixed Value: start-workflow-for-positive-lab-result
..... description S1..1stringStarts the workflow due to a positive lab result
Fixed Value: This action represents the start of the reporting workflow in response to the labresult-change (e.g new lab result or modified existing lab result) event
..... textEquivalent S1..1stringText equivalent of the start workflow action for positive lab result.
Fixed Value: Start the reporting workflow in response to an labresult-change event
..... code S1..1CodeableConceptCode for the "start" action.
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: initiate-reporting-workflow
..... trigger S1..*TriggerDefinitionWhen the "start" action should be triggered.
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... namedEventType S0..1CodeableConceptIndicates the types of named events to subscribe to from the EHR.
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..1codenamed-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Fixed Value: named-event
...... name 0..1stringName or URI that identifies the event
Fixed Value: labresult-change
..... relatedAction S1..1BackboneElementRelationship to another action
...... actionId 1..1idWhat action is this related to
Fixed Value: check-reportability
...... relationship 1..1codebefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Fixed Value: before-start
.... action:executeReportingWorkflow S1..1BackboneElementExecute Reporting Workflow
..... id S1..1stringUnique id for inter-element referencing
Fixed Value: check-reportability
..... description S1..1stringCheck 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 S1..1CodeableConceptCode for the "execute-reporting-workflow" action.
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions
....... code1..1codeSymbol 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 S1..1BackboneElementA sub-action
....... id S1..1stringUnique id for inter-element referencing
Fixed Value: is-ambulatory-encounter-reportable
....... code 1..1CodeableConceptCode representing the meaning of the action or sub-actions
Required Pattern: At least the following
........ coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
......... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions
......... code1..1codeSymbol in syntax defined by the system
Fixed Value: evaluate-condition
....... condition 0..*BackboneElementWhether or not the action is applicable
........ kind 1..1codeapplicability | start | stop
Fixed Value: applicability
........ expression S1..1ExpressionBoolean-valued expression
......... language 1..1codetext/cql | text/fhirpath | application/x-fhir-query | etc.
Fixed Value: text/fhirpath
....... input S0..*DataRequirementInput data requirements
........ id S1..1stringUnique id for inter-element referencing
....... relatedAction 0..*BackboneElementRelationship to another action
........ actionId 1..1idWhat action is this related to
Fixed Value: create-resp-net-report
........ relationship 1..1codebefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Fixed Value: before-start
...... action:isInpatientEncounterReportable S1..1BackboneElementA sub-action
....... id S1..1stringUnique id for inter-element referencing
Fixed Value: is-inpatient-encounter-reportable
....... code 1..1CodeableConceptCode representing the meaning of the action or sub-actions
Required Pattern: At least the following
........ coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
......... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions
......... code1..1codeSymbol in syntax defined by the system
Fixed Value: evaluate-condition
....... condition 0..*BackboneElementWhether or not the action is applicable
........ kind 1..1codeapplicability | start | stop
Fixed Value: applicability
........ expression S1..1ExpressionBoolean-valued expression
......... language 1..1codetext/cql | text/fhirpath | application/x-fhir-query | etc.
Fixed Value: text/fhirpath
....... input S0..*DataRequirementInput data requirements
........ id S1..1stringUnique id for inter-element referencing
....... relatedAction 0..*BackboneElementRelationship to another action
........ actionId 1..1idWhat action is this related to
Fixed Value: create-resp-net-report
........ relationship 1..1codebefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Fixed Value: before-start
.... action:createReport 1..1BackboneElementAll constraints on action are intended to apply to any nested constraints.
..... id S1..1stringUnique id for inter-element referencing
Fixed Value: create-resp-net-report
..... description 0..1stringBrief description of the action
Fixed Value: This action represents the creation, validation and submission of the RESP-NET report.
..... code 1..1CodeableConceptCode representing the meaning of the action or sub-actions
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: create-report
..... input S0..*DataRequirementInput data requirements
...... id S1..1stringUnique id for inter-element referencing
..... output S0..*DataRequirementOutput data definition
...... id S1..1stringUnique id for inter-element referencing
..... relatedAction 0..*BackboneElementRelationship to another action
...... actionId 1..1idWhat action is this related to
Fixed Value: validate-resp-net-report
...... relationship 1..1codebefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Fixed Value: before-start
.... action:validateReport 1..1BackboneElementAll constraints on action are intended to apply to any nested constraints.
..... id S1..1stringUnique id for inter-element referencing
Fixed Value: validate-resp-net-report
..... description 0..1stringBrief description of the action
Fixed Value: This action represents the validation of the RESP-NET Report
..... code 0..1CodeableConceptCode representing the meaning of the action or sub-actions
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: validate-report
..... input S0..*DataRequirementInput data requirements
...... id S1..1stringUnique id for inter-element referencing
..... output S0..*DataRequirementOutput data definition
...... id S1..1stringUnique id for inter-element referencing
..... relatedAction 0..*BackboneElementRelationship to another action
...... actionId 1..1idWhat action is this related to
Fixed Value: submit-resp-net-report
...... relationship 1..1codebefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Fixed Value: before-start
.... action:submitRespNetReport 1..1BackboneElementRoute and send RESP-NET Report
..... id S1..1stringUnique id for inter-element referencing
Fixed Value: submit-resp-net-report
..... description S1..1stringDescription of the route and send action.
Fixed Value: This action represents the routing and sending of the RESP-NET Report
..... textEquivalent S1..1stringStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
Fixed Value: Route and send RESP-NET Report
..... code 0..1CodeableConceptCode representing the meaning of the action or sub-actions
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: submit-report
..... input S0..*DataRequirementInput data requirements
...... id S1..1stringUnique id for inter-element referencing

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
PlanDefinition.action.codeextensibleUSPublicHealthPlanDefinitionAction
NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition SC1..1USPublicHealthPlanDefinitionRESP-NET Knowledge Artifact
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... receiverEndpoint S0..1Reference(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 S0..1booleanUS Public Health Async Indicator Extension
URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-async-indicator
... jwksForContentEncryption S0..1urlUS Public Health Receiver Jwks Url
URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-receiver-jwks-url
... contentEncryptionAlgorithm S0..1codeUS Public Health Receiver Jwks Url
URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-data-encryption-algorithm
... expectedResponseDuration S0..1DurationUS Public Health Expected Response Time Extension
URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-expected-responsetime
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ1..1uriCanonical identifier for this plan definition, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierAdditional identifier for the plan definition
... version Σ1..1stringBusiness version of the plan definition
... name ΣC1..1stringName for this plan definition (computer friendly)
... title SΣ0..1stringName for this plan definition (human friendly)
... type SΣ1..1CodeableConceptType of this PlanDefinition
Binding: PlanDefinitionType (extensible): The type of PlanDefinition.


Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: workflow-definition
..... display1..1stringRepresentation defined by the system
Fixed Value: Workflow Definition
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ1..1booleanFor testing purposes, not real usage
... subject[x] S0..1Type 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.).

.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date SΣ1..1dateTimeDate the PlanDefinition was last changed
... publisher SΣ1..1stringName of the agency that published this PlanDefinition
... contact SΣ0..*ContactDetailContact details for the publisher
... description Σ1..1markdownNatural language description of the plan definition
... useContext SΣ0..*UsageContextThe context that the content is intended to support
... jurisdiction SΣ0..*CodeableConceptIntended jurisdiction for plan definition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... effectivePeriod SΣ0..1PeriodWhen the PlanDefinition is valid
.... start ΣC1..1dateTimeThe start of the time period when this PlanDefinition goes into effect
... library S0..*canonical(Library)Logic used by the plan definition
... Slices for action S6..*BackboneElementAll 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 S0..1Reference(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..*ExtensionExtensions that cannot be ignored even if unrecognized
..... description S0..1stringBrief description of the action
..... code S0..1CodeableConceptCode 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 S0..*TriggerDefinitionWhen the action should be triggered
...... namedEventType S0..1CodeableConceptUS 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..1codenamed-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 S0..*BackboneElementWhether or not the action is applicable
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... kind S1..1codeapplicability | start | stop
Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.


Fixed Value: applicability
...... expression S0..1ExpressionBoolean-valued expression
....... language SΣ1..1codetext/cql | text/fhirpath | application/x-fhir-query | etc.
Binding: ExpressionLanguage (extensible): The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding

Fixed Value: text/fhirpath
..... input S0..*DataRequirementInput data requirements
...... defaultQuery S0..1stringUS Public Health FHIR Query Pattern Extension
URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension
...... relatedDataId S0..1stringUS Public Health Related Data Extension
URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-relateddata-extension
...... type SΣ1..1codeThe 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 S0..*DataRequirementOutput data definition
...... type SΣ1..1codeThe 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 S0..*BackboneElementRelationship to another action
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... actionId S1..1idWhat action is this related to
...... relationship S1..1codebefore-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..1DurationTime offset for the relationship
Slice: Unordered, Closed by type:$this
....... offset[x]:offsetDuration S0..1DurationTime offset for the relationship
..... timing[x] S0..1DurationWhen the action should take place
..... action S0..*See action (PlanDefinition)A sub-action
.... action:startWorkflow S1..1BackboneElementStart Workflow Action
..... id S1..1stringUnique id for inter-element referencing
Fixed Value: start-workflow
..... trustServiceEndpoint S0..1Reference(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..*ExtensionExtensions that cannot be ignored even if unrecognized
..... description S1..1stringStarts the workflow
Fixed Value: This action represents the start of the reporting workflow in response to the encounter-end event
..... textEquivalent S1..1stringText equivalent of the start workflow action.
Fixed Value: Start the reporting workflow in response to an encounter-end event
..... code S1..1CodeableConceptCode 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
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: initiate-reporting-workflow
..... trigger S1..*TriggerDefinitionWhen the "start" action should be triggered.
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... namedEventType S0..1CodeableConceptIndicates the types of named events to subscribe to from the EHR.
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..1codenamed-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..1stringName or URI that identifies the event
Fixed Value: encounter-end
..... condition S0..*BackboneElementWhether or not the action is applicable
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... kind S1..1codeapplicability | start | stop
Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.


Fixed Value: applicability
...... expression S0..1ExpressionBoolean-valued expression
....... language SΣ1..1codetext/cql | text/fhirpath | application/x-fhir-query | etc.
Binding: ExpressionLanguage (extensible): The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding

Fixed Value: text/fhirpath
..... input S0..*DataRequirementInput data requirements
...... defaultQuery S0..1stringUS Public Health FHIR Query Pattern Extension
URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension
...... relatedDataId S0..1stringUS Public Health Related Data Extension
URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-relateddata-extension
...... type SΣ1..1codeThe 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 S0..*DataRequirementOutput data definition
...... type SΣ1..1codeThe 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 S1..1BackboneElementRelationship to another action
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... actionId S1..1idWhat action is this related to
Fixed Value: check-reportability
...... relationship S1..1codebefore-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..1DurationTime offset for the relationship
Slice: Unordered, Closed by type:$this
....... offset[x]:offsetDuration S0..1DurationTime offset for the relationship
Example Wait 72 hour before next action.: {"value":72,"unit":"h"}
..... timing[x] S0..1DurationWhen the action should take place
..... action S0..*See action (PlanDefinition)A sub-action
.... action:positiveLabResultWorkflow S1..1BackboneElementStart Workflow Action due to a positive lab result
..... id S1..1stringUnique id for inter-element referencing
Fixed Value: start-workflow-for-positive-lab-result
..... trustServiceEndpoint S0..1Reference(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..*ExtensionExtensions that cannot be ignored even if unrecognized
..... description S1..1stringStarts the workflow due to a positive lab result
Fixed Value: This action represents the start of the reporting workflow in response to the labresult-change (e.g new lab result or modified existing lab result) event
..... textEquivalent S1..1stringText equivalent of the start workflow action for positive lab result.
Fixed Value: Start the reporting workflow in response to an labresult-change event
..... code S1..1CodeableConceptCode 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
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: initiate-reporting-workflow
..... trigger S1..*TriggerDefinitionWhen the "start" action should be triggered.
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... namedEventType S0..1CodeableConceptIndicates the types of named events to subscribe to from the EHR.
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..1codenamed-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..1stringName or URI that identifies the event
Fixed Value: labresult-change
..... condition S0..*BackboneElementWhether or not the action is applicable
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... kind S1..1codeapplicability | start | stop
Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.


Fixed Value: applicability
...... expression S0..1ExpressionBoolean-valued expression
....... language SΣ1..1codetext/cql | text/fhirpath | application/x-fhir-query | etc.
Binding: ExpressionLanguage (extensible): The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding

Fixed Value: text/fhirpath
..... input S0..*DataRequirementInput data requirements
...... defaultQuery S0..1stringUS Public Health FHIR Query Pattern Extension
URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension
...... relatedDataId S0..1stringUS Public Health Related Data Extension
URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-relateddata-extension
...... type SΣ1..1codeThe 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 S0..*DataRequirementOutput data definition
...... type SΣ1..1codeThe 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 S1..1BackboneElementRelationship to another action
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... actionId S1..1idWhat action is this related to
Fixed Value: check-reportability
...... relationship S1..1codebefore-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..1DurationTime offset for the relationship
Slice: Unordered, Closed by type:$this
....... offset[x]:offsetDuration S0..1DurationTime offset for the relationship
..... timing[x] S0..1DurationWhen the action should take place
..... action S0..*See action (PlanDefinition)A sub-action
.... action:executeReportingWorkflow S1..1BackboneElementExecute Reporting Workflow
..... id S1..1stringUnique id for inter-element referencing
Fixed Value: check-reportability
..... trustServiceEndpoint S0..1Reference(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..*ExtensionExtensions that cannot be ignored even if unrecognized
..... description S1..1stringCheck 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 S1..1CodeableConceptCode 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
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: execute-reporting-workflow
..... trigger S0..*TriggerDefinitionWhen the action should be triggered
...... namedEventType S0..1CodeableConceptUS 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..1codenamed-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 S0..*BackboneElementWhether or not the action is applicable
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... kind S1..1codeapplicability | start | stop
Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.


Fixed Value: applicability
...... expression S0..1ExpressionBoolean-valued expression
....... language SΣ1..1codetext/cql | text/fhirpath | application/x-fhir-query | etc.
Binding: ExpressionLanguage (extensible): The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding

Fixed Value: text/fhirpath
..... input S0..*DataRequirementInput data requirements
...... defaultQuery S0..1stringUS Public Health FHIR Query Pattern Extension
URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension
...... relatedDataId S0..1stringUS Public Health Related Data Extension
URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-relateddata-extension
...... type SΣ1..1codeThe 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 S0..*DataRequirementOutput data definition
...... type SΣ1..1codeThe 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 S0..*BackboneElementRelationship to another action
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... actionId S1..1idWhat action is this related to
...... relationship S1..1codebefore-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..1DurationTime offset for the relationship
Slice: Unordered, Closed by type:$this
....... offset[x]:offsetDuration S0..1DurationTime offset for the relationship
..... timing[x] S0..1DurationWhen the action should take place
..... Slices for action S2..*See action (PlanDefinition)A sub-action
Slice: Unordered, Open by value:id
...... action:isAmbulatoryEncounterReportable S1..1BackboneElementA sub-action
....... id S1..1stringUnique id for inter-element referencing
Fixed Value: is-ambulatory-encounter-reportable
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... code 1..1CodeableConceptCode representing the meaning of the action or sub-actions

Required Pattern: At least the following
........ coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
......... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions
......... code1..1codeSymbol in syntax defined by the system
Fixed Value: evaluate-condition
....... condition 0..*BackboneElementWhether or not the action is applicable
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ kind 1..1codeapplicability | start | stop
Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.


Fixed Value: applicability
........ expression S1..1ExpressionBoolean-valued expression
......... language Σ1..1codetext/cql | text/fhirpath | application/x-fhir-query | etc.
Binding: ExpressionLanguage (extensible): The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding

Fixed Value: text/fhirpath
....... input S0..*DataRequirementInput data requirements
........ id S1..1stringUnique id for inter-element referencing
........ type Σ1..1codeThe 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..*BackboneElementRelationship to another action
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ actionId 1..1idWhat action is this related to
Fixed Value: create-resp-net-report
........ relationship 1..1codebefore-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 S1..1BackboneElementA sub-action
....... id S1..1stringUnique id for inter-element referencing
Fixed Value: is-inpatient-encounter-reportable
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... code 1..1CodeableConceptCode representing the meaning of the action or sub-actions

Required Pattern: At least the following
........ coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
......... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions
......... code1..1codeSymbol in syntax defined by the system
Fixed Value: evaluate-condition
....... condition 0..*BackboneElementWhether or not the action is applicable
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ kind 1..1codeapplicability | start | stop
Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.


Fixed Value: applicability
........ expression S1..1ExpressionBoolean-valued expression
......... language Σ1..1codetext/cql | text/fhirpath | application/x-fhir-query | etc.
Binding: ExpressionLanguage (extensible): The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding

Fixed Value: text/fhirpath
....... input S0..*DataRequirementInput data requirements
........ id S1..1stringUnique id for inter-element referencing
........ type Σ1..1codeThe 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..*BackboneElementRelationship to another action
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ actionId 1..1idWhat action is this related to
Fixed Value: create-resp-net-report
........ relationship 1..1codebefore-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 S1..1BackboneElementAll constraints on action are intended to apply to any nested constraints.
..... id S1..1stringUnique id for inter-element referencing
Fixed Value: create-resp-net-report
..... trustServiceEndpoint S0..1Reference(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..*ExtensionExtensions that cannot be ignored even if unrecognized
..... description S0..1stringBrief description of the action
Fixed Value: This action represents the creation, validation and submission of the RESP-NET report.
..... code S1..1CodeableConceptCode 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
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: create-report
..... trigger S0..*TriggerDefinitionWhen the action should be triggered
...... namedEventType S0..1CodeableConceptUS 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..1codenamed-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 S0..*BackboneElementWhether or not the action is applicable
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... kind S1..1codeapplicability | start | stop
Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.


Fixed Value: applicability
...... expression S0..1ExpressionBoolean-valued expression
....... language SΣ1..1codetext/cql | text/fhirpath | application/x-fhir-query | etc.
Binding: ExpressionLanguage (extensible): The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding

Fixed Value: text/fhirpath
..... input S0..*DataRequirementInput data requirements
...... id S1..1stringUnique id for inter-element referencing
...... defaultQuery S0..1stringUS Public Health FHIR Query Pattern Extension
URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension
...... relatedDataId S0..1stringUS Public Health Related Data Extension
URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-relateddata-extension
...... type SΣ1..1codeThe 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 S0..*DataRequirementOutput data definition
...... id S1..1stringUnique id for inter-element referencing
...... type SΣ1..1codeThe 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 S0..*BackboneElementRelationship to another action
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... actionId S1..1idWhat action is this related to
Fixed Value: validate-resp-net-report
...... relationship S1..1codebefore-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..1DurationTime offset for the relationship
Slice: Unordered, Closed by type:$this
....... offset[x]:offsetDuration S0..1DurationTime offset for the relationship
..... timing[x] S0..1DurationWhen the action should take place
..... action S0..*See action (PlanDefinition)A sub-action
.... action:validateReport S1..1BackboneElementAll constraints on action are intended to apply to any nested constraints.
..... id S1..1stringUnique id for inter-element referencing
Fixed Value: validate-resp-net-report
..... trustServiceEndpoint S0..1Reference(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..*ExtensionExtensions that cannot be ignored even if unrecognized
..... description S0..1stringBrief description of the action
Fixed Value: This action represents the validation of the RESP-NET Report
..... code S0..1CodeableConceptCode 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
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: validate-report
..... trigger S0..*TriggerDefinitionWhen the action should be triggered
...... namedEventType S0..1CodeableConceptUS 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..1codenamed-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 S0..*BackboneElementWhether or not the action is applicable
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... kind S1..1codeapplicability | start | stop
Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.


Fixed Value: applicability
...... expression S0..1ExpressionBoolean-valued expression
....... language SΣ1..1codetext/cql | text/fhirpath | application/x-fhir-query | etc.
Binding: ExpressionLanguage (extensible): The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding

Fixed Value: text/fhirpath
..... input S0..*DataRequirementInput data requirements
...... id S1..1stringUnique id for inter-element referencing
...... defaultQuery S0..1stringUS Public Health FHIR Query Pattern Extension
URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension
...... relatedDataId S0..1stringUS Public Health Related Data Extension
URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-relateddata-extension
...... type SΣ1..1codeThe 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 S0..*DataRequirementOutput data definition
...... id S1..1stringUnique id for inter-element referencing
...... type SΣ1..1codeThe 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 S0..*BackboneElementRelationship to another action
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... actionId S1..1idWhat action is this related to
Fixed Value: submit-resp-net-report
...... relationship S1..1codebefore-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..1DurationTime offset for the relationship
Slice: Unordered, Closed by type:$this
....... offset[x]:offsetDuration S0..1DurationTime offset for the relationship
..... timing[x] S0..1DurationWhen the action should take place
..... action S0..*See action (PlanDefinition)A sub-action
.... action:submitRespNetReport S1..1BackboneElementRoute and send RESP-NET Report
..... id S1..1stringUnique id for inter-element referencing
Fixed Value: submit-resp-net-report
..... trustServiceEndpoint S0..1Reference(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..*ExtensionExtensions that cannot be ignored even if unrecognized
..... description S1..1stringDescription of the route and send action.
Fixed Value: This action represents the routing and sending of the RESP-NET Report
..... textEquivalent S1..1stringStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
Fixed Value: Route and send RESP-NET Report
..... code S0..1CodeableConceptCode 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
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/medmorph/CodeSystem/us-ph-plandefinition-actions
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: submit-report
..... trigger S0..*TriggerDefinitionWhen the action should be triggered
...... namedEventType S0..1CodeableConceptUS 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..1codenamed-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 S0..*BackboneElementWhether or not the action is applicable
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... kind S1..1codeapplicability | start | stop
Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.


Fixed Value: applicability
...... expression S0..1ExpressionBoolean-valued expression
....... language SΣ1..1codetext/cql | text/fhirpath | application/x-fhir-query | etc.
Binding: ExpressionLanguage (extensible): The media type of the expression language.

Additional BindingsPurpose
http://www.rfc-editor.org/bcp/bcp13.txtMax Binding

Fixed Value: text/fhirpath
..... input S0..*DataRequirementInput data requirements
...... id S1..1stringUnique id for inter-element referencing
...... defaultQuery S0..1stringUS Public Health FHIR Query Pattern Extension
URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-fhirquerypattern-extension
...... relatedDataId S0..1stringUS Public Health Related Data Extension
URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-relateddata-extension
...... type SΣ1..1codeThe 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 S0..*DataRequirementOutput data definition
...... type SΣ1..1codeThe 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 S0..*BackboneElementRelationship to another action
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... actionId S1..1idWhat action is this related to
...... relationship S1..1codebefore-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..1DurationTime offset for the relationship
Slice: Unordered, Closed by type:$this
....... offset[x]:offsetDuration S0..1DurationTime offset for the relationship
..... timing[x] S0..1DurationWhen the action should take place
..... action S0..*See action (PlanDefinition)A sub-action

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
PlanDefinition.typeextensiblePattern: workflow-definition("Workflow Definition")
PlanDefinition.statusrequiredPublicationStatus
PlanDefinition.subject[x]extensibleSubjectType
PlanDefinition.jurisdictionextensibleJurisdiction ValueSet
PlanDefinition.action.codeextensibleUSPublicHealthPlanDefinitionAction
PlanDefinition.action.trigger.typerequiredFixed Value: named-event
PlanDefinition.action.condition.kindrequiredFixed Value: applicability
PlanDefinition.action.condition.expression.languageextensibleFixed Value: text/fhirpath
Additional Bindings Purpose
http://www.rfc-editor.org/bcp/bcp13.txt Max Binding
PlanDefinition.action.input.typerequiredFHIRAllTypes
PlanDefinition.action.output.typerequiredFHIRAllTypes
PlanDefinition.action.relatedAction.relationshiprequiredFixed Value: before-start
PlanDefinition.action:startWorkflow.codeextensiblePattern: initiate-reporting-workflow
PlanDefinition.action:startWorkflow.trigger.typerequiredFixed Value: named-event
PlanDefinition.action:startWorkflow.condition.kindrequiredFixed Value: applicability
PlanDefinition.action:startWorkflow.condition.expression.languageextensibleFixed Value: text/fhirpath
Additional Bindings Purpose
http://www.rfc-editor.org/bcp/bcp13.txt Max Binding
PlanDefinition.action:startWorkflow.input.typerequiredFHIRAllTypes
PlanDefinition.action:startWorkflow.output.typerequiredFHIRAllTypes
PlanDefinition.action:startWorkflow.relatedAction.relationshiprequiredFixed Value: before-start
PlanDefinition.action:positiveLabResultWorkflow.codeextensiblePattern: initiate-reporting-workflow
PlanDefinition.action:positiveLabResultWorkflow.trigger.typerequiredFixed Value: named-event
PlanDefinition.action:positiveLabResultWorkflow.condition.kindrequiredFixed Value: applicability
PlanDefinition.action:positiveLabResultWorkflow.condition.expression.languageextensibleFixed Value: text/fhirpath
Additional Bindings Purpose
http://www.rfc-editor.org/bcp/bcp13.txt Max Binding
PlanDefinition.action:positiveLabResultWorkflow.input.typerequiredFHIRAllTypes
PlanDefinition.action:positiveLabResultWorkflow.output.typerequiredFHIRAllTypes
PlanDefinition.action:positiveLabResultWorkflow.relatedAction.relationshiprequiredFixed Value: before-start
PlanDefinition.action:executeReportingWorkflow.codeextensiblePattern: execute-reporting-workflow
PlanDefinition.action:executeReportingWorkflow.trigger.typerequiredFixed Value: named-event
PlanDefinition.action:executeReportingWorkflow.condition.kindrequiredFixed Value: applicability
PlanDefinition.action:executeReportingWorkflow.condition.expression.languageextensibleFixed Value: text/fhirpath
Additional Bindings Purpose
http://www.rfc-editor.org/bcp/bcp13.txt Max Binding
PlanDefinition.action:executeReportingWorkflow.input.typerequiredFHIRAllTypes
PlanDefinition.action:executeReportingWorkflow.output.typerequiredFHIRAllTypes
PlanDefinition.action:executeReportingWorkflow.relatedAction.relationshiprequiredFixed Value: before-start
PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.condition.kindrequiredFixed Value: applicability
PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.condition.expression.languageextensibleFixed Value: text/fhirpath
Additional Bindings Purpose
http://www.rfc-editor.org/bcp/bcp13.txt Max Binding
PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.typerequiredFHIRAllTypes
PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.relatedAction.relationshiprequiredFixed Value: before-start
PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.condition.kindrequiredFixed Value: applicability
PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.condition.expression.languageextensibleFixed Value: text/fhirpath
Additional Bindings Purpose
http://www.rfc-editor.org/bcp/bcp13.txt Max Binding
PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.typerequiredFHIRAllTypes
PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.relatedAction.relationshiprequiredFixed Value: before-start
PlanDefinition.action:createReport.codeextensiblePattern: create-report
PlanDefinition.action:createReport.trigger.typerequiredFixed Value: named-event
PlanDefinition.action:createReport.condition.kindrequiredFixed Value: applicability
PlanDefinition.action:createReport.condition.expression.languageextensibleFixed Value: text/fhirpath
Additional Bindings Purpose
http://www.rfc-editor.org/bcp/bcp13.txt Max Binding
PlanDefinition.action:createReport.input.typerequiredFHIRAllTypes
PlanDefinition.action:createReport.output.typerequiredFHIRAllTypes
PlanDefinition.action:createReport.relatedAction.relationshiprequiredFixed Value: before-start
PlanDefinition.action:validateReport.codeextensiblePattern: validate-report
PlanDefinition.action:validateReport.trigger.typerequiredFixed Value: named-event
PlanDefinition.action:validateReport.condition.kindrequiredFixed Value: applicability
PlanDefinition.action:validateReport.condition.expression.languageextensibleFixed Value: text/fhirpath
Additional Bindings Purpose
http://www.rfc-editor.org/bcp/bcp13.txt Max Binding
PlanDefinition.action:validateReport.input.typerequiredFHIRAllTypes
PlanDefinition.action:validateReport.output.typerequiredFHIRAllTypes
PlanDefinition.action:validateReport.relatedAction.relationshiprequiredFixed Value: before-start
PlanDefinition.action:submitRespNetReport.codeextensiblePattern: submit-report
PlanDefinition.action:submitRespNetReport.trigger.typerequiredFixed Value: named-event
PlanDefinition.action:submitRespNetReport.condition.kindrequiredFixed Value: applicability
PlanDefinition.action:submitRespNetReport.condition.expression.languageextensibleFixed Value: text/fhirpath
Additional Bindings Purpose
http://www.rfc-editor.org/bcp/bcp13.txt Max Binding
PlanDefinition.action:submitRespNetReport.input.typerequiredFHIRAllTypes
PlanDefinition.action:submitRespNetReport.output.typerequiredFHIRAllTypes
PlanDefinition.action:submitRespNetReport.relatedAction.relationshiprequiredFixed Value: before-start

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPlanDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPlanDefinitionIf 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-4errorPlanDefinitionIf 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-5errorPlanDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePlanDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pdf-0warningPlanDefinitionName 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}')
NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition SC1..1USPublicHealthPlanDefinitionRESP-NET Knowledge Artifact
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... receiverEndpoint S0..1Reference(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 S0..1booleanUS Public Health Async Indicator Extension
URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-async-indicator
... contentEncrypted S0..1booleanUS Public Health Data Encrypted Extension
URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-data-encrypted-extension
... jwksForContentEncryption S0..1urlUS Public Health Receiver Jwks Url
URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-receiver-jwks-url
... contentEncryptionAlgorithm S0..1codeUS Public Health Receiver Jwks Url
URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-data-encryption-algorithm
... expectedResponseDuration S0..1DurationUS Public Health Expected Response Time Extension
URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-expected-responsetime
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ1..1uriCanonical identifier for this plan definition, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierAdditional identifier for the plan definition
... version Σ1..1stringBusiness version of the plan definition
... name ΣC1..1stringName for this plan definition (computer friendly)
... title SΣ0..1stringName for this plan definition (human friendly)
... subtitle 0..1stringSubordinate title of the plan definition
...