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

US Public Health Profiles Library, published by HL7 Public Health Work Group. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-us-ph-library/ 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 2024-11-18 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..1 Shareable PlanDefinition The definition of a plan for a series of actions, independent of any specific patient or context
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... receiverAddress S 0..1 Reference(Endpoint) Indicates the address where the report has to be sent.
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-receiver-address-extension
.... asyncIndicator S 0..1 boolean US Public Health Async Indicator Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-async-indicator-extension
.... contentEncrypted S 0..1 boolean US Public Health Data Encrypted Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encrypted-extension
.... jwksForContentEncryption S 0..1 url US Public Health Receiver Jwks Url
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-receiver-jwks-url-extension
.... contentEncryptionAlgorithm S 0..1 code US Public Health Data Encryption Algorithm
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encryption-algorithm-extension
.... expectedResponseDuration S 0..1 Duration US Public Health Expected Response Time Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-expected-response-time-extension
... version S 1..1 string Business version of the PlanDefinition
... name S 1..1 string Name for this PlanDefinition (computer friendly)
... type S 1..1 CodeableConcept Type of this PlanDefinition
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/plan-definition-type
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: workflow-definition
..... display 1..1 string Representation defined by the system
Fixed Value: Workflow Definition
... subject[x] S 0..1 CodeableConcept, Reference(Group) Type of individual the plan definition is focused on
... date 1..1 dateTime Date the PlanDefinition was last changed
... publisher S 1..1 string Name of the agency that published this PlanDefinition
... effectivePeriod S 0..1 Period When the PlanDefinition is valid
.... start 1..1 dateTime The start of the time period when this PlanDefinition goes into effect
... library S 0..* canonical(Library) Logic used by the plan definition
... action S 0..* BackboneElement All constraints on action are intended to apply to any nested constraints.
.... description S 0..1 string Brief description of the action
.... code S 0..1 CodeableConcept Code representing the meaning of the action or sub-actions
Binding: US Public Health VaueSet - PlanDefinition Action (extensible): The set of actions that can be used to create plan definition

.... trigger S 0..* TriggerDefinition When the action should be triggered
..... Slices for extension Content/Rules for all slices
...... namedEventType S 0..1 CodeableConcept US Public Health Named Event Type Extension
URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-named-eventtype-extension
Binding: US Public Health VaueSet - TriggerDefinition NamedEvent (extensible): US Public Health TriggerDefinition NamedEvents

..... type S 1..1 code named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Fixed Value: named-event
.... condition S 0..* BackboneElement Whether or not the action is applicable
..... kind S 1..1 code applicability | start | stop
..... expression S 0..1 Expression Boolean-valued expression
.... input S 0..* DataRequirement Input data requirements
..... type S 1..1 code The type of the required data
.... output S 0..* DataRequirement Output data definition
..... type S 1..1 code The type of the required data
.... relatedAction S 0..* BackboneElement Relationship to another action
..... actionId S 1..1 id What action is this related to
..... relationship S 1..1 code before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
..... Slices for offset[x] 0..1 Duration, Range Time offset for the relationship
Slice: Unordered, Open 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

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
PlanDefinition.action.codeextensibleUSPublicHealthValueSetPlanDefinitionAction (a valid code from US Public Health CodeSystem - PlanDefinition Actions)
http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-plandefinition-action
from this IG

 

Other representations of profile: CSV, Excel, Schematron