US Public Health Profiles Library
1.0.0 - STU1 United States of America flag

US Public Health Profiles Library, published by HL7 Public Health Working Group. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/HL7/fhir-us-ph-common-library-ig/ and changes regularly. See the Directory of published versions

Resource Profile: US Public Health PlanDefinition

Official URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-plandefinition Version: 1.0.0
Active as of 2023-10-04 Computable Name: USPublicHealthPlanDefinition

This PlanDefinition profile describes the US Public Health PlanDefinition.

This profile is used to represent Knowledge Artifacts in US Public Health use cases.

Usage:

Formal Views of Profile Content

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

This structure is derived from Shareable PlanDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition 1..1Shareable PlanDefinitionThe definition of a plan for a series of actions, independent of any specific patient or context
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... receiverAddress S0..1Reference(Endpoint)Indicates the address where the report has to be sent.
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-receiver-address-extension
... asyncIndicator S0..1booleanUS Public Health Async Indicator Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-async-indicator-extension
... jwksForContentEncryption S0..1urlUS Public Health Receiver Jwks Url
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-receiver-jwks-url-extension
... contentEncryptionAlgorithm S0..1codeUS Public Health Data Encryption Algorithm
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encryption-algorithm-extension
... expectedResponseDuration S0..1DurationUS Public Health Expected Response Time Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-expected-response-time-extension
... version S1..1stringBusiness version of the PlanDefinition
... name S1..1stringName for this PlanDefinition (computer friendly)
... title 1..1stringTitle for this PlanDefinition
... type S1..1CodeableConceptType of this 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
... subject[x] S0..1CodeableConcept, Reference(Group)Type of individual the plan definition is focused on
... date 1..1dateTimeDate the PlanDefinition was last changed
... publisher S1..1stringName of the agency that published this PlanDefinition
... effectivePeriod S0..1PeriodWhen the PlanDefinition is valid
.... start 1..1dateTimeThe start of the time period when this PlanDefinition goes into effect
... library S0..*canonical(Library)Logic used by the plan definition
... action S0..*BackboneElementAll constraints on action are intended to apply to any nested constraints.
.... description S0..1stringBrief description of the action
.... code S0..1CodeableConceptCode representing the meaning of the action or sub-actions
Binding: US Public Health VaueSet - 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/ph-library/StructureDefinition/us-ph-named-eventtype-extension
Binding: US Public Health VaueSet - TriggerDefinition NamedEvent (extensible): US Public Health TriggerDefinition NamedEvents

..... type S1..1codenamed-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Fixed Value: named-event
.... condition S0..*BackboneElementWhether or not the action is applicable
..... kind S1..1codeapplicability | start | stop
..... expression S0..1ExpressionBoolean-valued expression
.... input S0..*DataRequirementInput data requirements
..... type S1..1codeThe type of the required data
.... output S0..*DataRequirementOutput data definition
..... type S1..1codeThe type of the required data
.... relatedAction S0..*BackboneElementRelationship to another action
..... 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
..... Slices for offset[x] 0..1Duration, RangeTime offset for the relationship
Slice: Unordered, Open by type:$this
...... offset[x]:offsetDuration S0..1DurationTime offset for the relationship
.... timing[x] S0..1DurationWhen the action should take place

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
PlanDefinition.action.codeextensibleUSPublicHealthValueSetPlanDefinitionAction (a valid code from US Public Health CodeSystem - PlanDefinition Actions)

 

Other representations of profile: CSV, Excel, Schematron