Central Cancer Registry Reporting Content IG
1.0.0 - STU 1 United States of America flag

Central Cancer Registry Reporting Content IG, published by HL7 International / Public Health. 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-central-cancer-registry-reporting-ig/ and changes regularly. See the Directory of published versions

Resource Profile: Central Cancer Registry Reporting PlanDefinition

Official URL: http://hl7.org/fhir/us/central-cancer-registry-reporting/StructureDefinition/ccrr-plandefinition Version: 1.0.0
Active as of 2024-05-31 Computable Name: CentralCancerRegistryReportingPlanDefinition
Other Identifiers: OID:2.16.840.1.113883.4.642.40.40.42.8

This PlanDefinition profile defines the logic and rules around determining: whether or not a condition is reportable to a cancer registry, which jurisdiction(s) is/are responsible, which jurisdiction(s) need to be notified, and if the cancer condition is reportable, gives timing information, next steps and condition information to the clinician. The rules for determining reportability described by the Central Cancer Registry Reporting specification involve the use of triggering codes to determine potentially reportable events, and optionally locally evaluated rules for determining suspected reportable events.

Introduction

This profile is used to represent the PlanDefinition instance which is an integral part of the Central Cancer Registry Reporting Knowledge Artifact.

Requirements of the Knowledge Artifact

  • The Central Cancer Registry Reporting PlanDefinition is triggered by an encounter-close event.

  • The PlanDefinition specifies a mechanism to run scheduled jobs at specified intervals when the reason for the encounter/visit is to diagnose, evaluate, and/or treat an active cancer and create a cancer report.

    • Encounter of ICD-10-CM or SNOMED CT Reportable Codes
  • The PlanDefinition specifies a mechanism to run scheduled jobs at least every 6 months for the patient and create a cancer report.

  • The PlanDefinition specifies a mechanism to run scheduled jobs once every 12 months until the patient is deceased or there is no updates to the record for 24 months and create a cancer report.

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 S 1..1 USPublicHealthPlanDefinition ccrr-Central Cancer Registry Reporting
... Slices for action S 2..* 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:encounterClose S 0..1 BackboneElement Encounter Close 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-reportable
...... 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:checkReportable 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: check-reportable
..... description 0..1 string Check if the Encounter qualifies as check-reportable
Fixed Value: This action represents the check for suspected reportability of the cancer data.
..... 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: execute-reporting-workflow
..... Slices for action 2..* A sub-action
Slice: Unordered, Open by value:id
...... action:isEncounterReportable S 1..1 BackboneElement A sub-action
....... id S 1..1 string Unique id for inter-element referencing
Fixed Value: is-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: check-trigger-codes
....... 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: report-cancer-data
........ 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:shouldContinueReporting S 1..1 BackboneElement A sub-action
....... id S 1..1 string Unique id for inter-element referencing
Fixed Value: should-continue-reporting
....... 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
....... relatedAction 0..* BackboneElement Relationship to another action
........ actionId 1..1 id What action is this related to
Fixed Value: check-reportable
........ 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 6 months before next action.: {"value":6,"unit":"mo"}
.... action:reportCancerData 0..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: report-cancer-data
..... description 0..1 string Brief description of the action
Fixed Value: This action represents the creation, validation and submission of the cancer 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: execute-reporting-workflow
..... Slices for action S 3..* A sub-action
Slice: Ordered, Open by value:id
...... action:createCancerReport 1..1 BackboneElement A sub-action
....... id S 1..1 string Unique id for inter-element referencing
Fixed Value: create-cancer-report
....... description 0..1 string Brief description of the action
Fixed Value: This action represents the creation of the cancer 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
...... action:validateCancerReport 1..1 BackboneElement A sub-action
....... id S 1..1 string Unique id for inter-element referencing
Fixed Value: validate-cancer-report
....... description 0..1 string Brief description of the action
Fixed Value: This action represents the validation of the cancer 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: validate-report
...... action:routeAndSendCancerReport 1..1 BackboneElement Route and send cancer report
....... id S 1..1 string Unique id for inter-element referencing
Fixed Value: route-and-send-cancer-report
....... description S 1..1 string Description of the route and send action.
Fixed Value: This action represents the routing and sending of the cancer 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 cancer 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: submit-report

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
PlanDefinition.action.codeextensibleUSPublicHealthPlanDefinitionAction
http://hl7.org/fhir/us/medmorph/ValueSet/us-ph-plandefinition-action
NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition SC 1..1 USPublicHealthPlanDefinition ccrr-Central Cancer Registry Reporting
pdf-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... 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
... 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 2..* 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
..... Slices for extension 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
...... 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/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.

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

Fixed Value: text/fhirpath
..... input S 0..* DataRequirement Input data requirements
...... Slices for extension Content/Rules for all slices
....... 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:encounterClose S 0..1 BackboneElement Encounter Close Action
..... id S 1..1 string Unique id for inter-element referencing
Fixed Value: start-workflow
..... Slices for extension 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 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.

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

Fixed Value: text/fhirpath
..... input S 0..* DataRequirement Input data requirements
...... Slices for extension Content/Rules for all slices
....... 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-reportable
...... 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:checkReportable 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: check-reportable
..... Slices for extension 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 Check if the Encounter qualifies as check-reportable
Fixed Value: This action represents the check for suspected reportability of the cancer data.
..... 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: execute-reporting-workflow
..... 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/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.

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

Fixed Value: text/fhirpath
..... input S 0..* DataRequirement Input data requirements
...... Slices for extension Content/Rules for all slices
....... 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:isEncounterReportable S 1..1 BackboneElement A sub-action
....... id S 1..1 string Unique id for inter-element referencing
Fixed Value: is-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: check-trigger-codes
....... 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.

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

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: report-cancer-data
........ 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:shouldContinueReporting S 1..1 BackboneElement A sub-action
....... id S 1..1 string Unique id for inter-element referencing
Fixed Value: should-continue-reporting
....... 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.

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

Fixed Value: text/fhirpath
....... 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: check-reportable
........ 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
........ Slices for offset[x] 0..1 Time offset for the relationship
Slice: Unordered, Open by type:$this
......... offsetDuration Duration
......... offsetRange Range
......... offset[x]:offsetDuration 0..1 Duration Time offset for the relationship
Example Wait 6 months before next action.: {"value":6,"unit":"mo"}
.... action:reportCancerData S 0..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: report-cancer-data
..... Slices for extension 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
Fixed Value: This action represents the creation, validation and submission of the cancer 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: execute-reporting-workflow
..... 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/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.

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

Fixed Value: text/fhirpath
..... input S 0..* DataRequirement Input data requirements
...... Slices for extension Content/Rules for all slices
....... 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 3..* See action (PlanDefinition) A sub-action
Slice: Ordered, Open by value:id
...... action:createCancerReport S 1..1 BackboneElement A sub-action
....... id S 1..1 string Unique id for inter-element referencing
Fixed Value: create-cancer-report
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... description 0..1 string Brief description of the action
Fixed Value: This action represents the creation of the cancer 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
...... action:validateCancerReport S 1..1 BackboneElement A sub-action
....... id S 1..1 string Unique id for inter-element referencing
Fixed Value: validate-cancer-report
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... description 0..1 string Brief description of the action
Fixed Value: This action represents the validation of the cancer 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: validate-report
...... action:routeAndSendCancerReport S 1..1 BackboneElement Route and send cancer report
....... id S 1..1 string Unique id for inter-element referencing
Fixed Value: route-and-send-cancer-report
....... 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 cancer 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 cancer 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: submit-report

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
PlanDefinition.typeextensiblePattern: workflow-definition("Workflow Definition")
http://hl7.org/fhir/ValueSet/plan-definition-type
from the FHIR Standard
PlanDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
PlanDefinition.subject[x]extensibleSubjectType
http://hl7.org/fhir/ValueSet/subject-type
from the FHIR Standard
PlanDefinition.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
PlanDefinition.action.codeextensibleUSPublicHealthPlanDefinitionAction
http://hl7.org/fhir/us/medmorph/ValueSet/us-ph-plandefinition-action
PlanDefinition.action.trigger.typerequiredFixed Value: named-event
http://hl7.org/fhir/ValueSet/trigger-type|4.0.1
from the FHIR Standard
PlanDefinition.action.condition.kindrequiredFixed Value: applicability
http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1
from the FHIR Standard
PlanDefinition.action.condition.expression.languageextensibleFixed Value: text/fhirpath
Additional Bindings Purpose
http://www.rfc-editor.org/bcp/bcp13.txt Max Binding
http://hl7.org/fhir/ValueSet/expression-language
from the FHIR Standard
PlanDefinition.action.input.typerequiredFHIRAllTypes
http://hl7.org/fhir/ValueSet/all-types|4.0.1
from the FHIR Standard
PlanDefinition.action.output.typerequiredFHIRAllTypes
http://hl7.org/fhir/ValueSet/all-types|4.0.1
from the FHIR Standard
PlanDefinition.action.relatedAction.relationshiprequiredFixed Value: before-start
http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1
from the FHIR Standard
PlanDefinition.action:encounterClose.codeextensiblePattern: initiate-reporting-workflow
http://hl7.org/fhir/us/medmorph/ValueSet/us-ph-plandefinition-action
PlanDefinition.action:encounterClose.trigger.typerequiredFixed Value: named-event
http://hl7.org/fhir/ValueSet/trigger-type|4.0.1
from the FHIR Standard
PlanDefinition.action:encounterClose.condition.kindrequiredFixed Value: applicability
http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1
from the FHIR Standard
PlanDefinition.action:encounterClose.condition.expression.languageextensibleFixed Value: text/fhirpath
Additional Bindings Purpose
http://www.rfc-editor.org/bcp/bcp13.txt Max Binding
http://hl7.org/fhir/ValueSet/expression-language
from the FHIR Standard
PlanDefinition.action:encounterClose.input.typerequiredFHIRAllTypes
http://hl7.org/fhir/ValueSet/all-types|4.0.1
from the FHIR Standard
PlanDefinition.action:encounterClose.output.typerequiredFHIRAllTypes
http://hl7.org/fhir/ValueSet/all-types|4.0.1
from the FHIR Standard
PlanDefinition.action:encounterClose.relatedAction.relationshiprequiredFixed Value: before-start
http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1
from the FHIR Standard
PlanDefinition.action:checkReportable.codeextensiblePattern: execute-reporting-workflow
http://hl7.org/fhir/us/medmorph/ValueSet/us-ph-plandefinition-action
PlanDefinition.action:checkReportable.trigger.typerequiredFixed Value: named-event
http://hl7.org/fhir/ValueSet/trigger-type|4.0.1
from the FHIR Standard
PlanDefinition.action:checkReportable.condition.kindrequiredFixed Value: applicability
http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1
from the FHIR Standard
PlanDefinition.action:checkReportable.condition.expression.languageextensibleFixed Value: text/fhirpath
Additional Bindings Purpose
http://www.rfc-editor.org/bcp/bcp13.txt Max Binding
http://hl7.org/fhir/ValueSet/expression-language
from the FHIR Standard
PlanDefinition.action:checkReportable.input.typerequiredFHIRAllTypes
http://hl7.org/fhir/ValueSet/all-types|4.0.1
from the FHIR Standard
PlanDefinition.action:checkReportable.output.typerequiredFHIRAllTypes
http://hl7.org/fhir/ValueSet/all-types|4.0.1
from the FHIR Standard
PlanDefinition.action:checkReportable.relatedAction.relationshiprequiredFixed Value: before-start
http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1
from the FHIR Standard
PlanDefinition.action:checkReportable.action:isEncounterReportable.condition.kindrequiredFixed Value: applicability
http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1
from the FHIR Standard
PlanDefinition.action:checkReportable.action:isEncounterReportable.condition.expression.languageextensibleFixed Value: text/fhirpath
Additional Bindings Purpose
http://www.rfc-editor.org/bcp/bcp13.txt Max Binding
http://hl7.org/fhir/ValueSet/expression-language
from the FHIR Standard
PlanDefinition.action:checkReportable.action:isEncounterReportable.input.typerequiredFHIRAllTypes
http://hl7.org/fhir/ValueSet/all-types|4.0.1
from the FHIR Standard
PlanDefinition.action:checkReportable.action:isEncounterReportable.relatedAction.relationshiprequiredFixed Value: before-start
http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1
from the FHIR Standard
PlanDefinition.action:checkReportable.action:shouldContinueReporting.condition.kindrequiredFixed Value: applicability
http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1
from the FHIR Standard
PlanDefinition.action:checkReportable.action:shouldContinueReporting.condition.expression.languageextensibleFixed Value: text/fhirpath
Additional Bindings Purpose
http://www.rfc-editor.org/bcp/bcp13.txt Max Binding
http://hl7.org/fhir/ValueSet/expression-language
from the FHIR Standard
PlanDefinition.action:checkReportable.action:shouldContinueReporting.relatedAction.relationshiprequiredFixed Value: before-start
http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1
from the FHIR Standard
PlanDefinition.action:reportCancerData.codeextensiblePattern: execute-reporting-workflow
http://hl7.org/fhir/us/medmorph/ValueSet/us-ph-plandefinition-action
PlanDefinition.action:reportCancerData.trigger.typerequiredFixed Value: named-event
http://hl7.org/fhir/ValueSet/trigger-type|4.0.1
from the FHIR Standard
PlanDefinition.action:reportCancerData.condition.kindrequiredFixed Value: applicability
http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1
from the FHIR Standard
PlanDefinition.action:reportCancerData.condition.expression.languageextensibleFixed Value: text/fhirpath
Additional Bindings Purpose
http://www.rfc-editor.org/bcp/bcp13.txt Max Binding
http://hl7.org/fhir/ValueSet/expression-language
from the FHIR Standard
PlanDefinition.action:reportCancerData.input.typerequiredFHIRAllTypes
http://hl7.org/fhir/ValueSet/all-types|4.0.1
from the FHIR Standard
PlanDefinition.action:reportCancerData.output.typerequiredFHIRAllTypes
http://hl7.org/fhir/ValueSet/all-types|4.0.1
from the FHIR Standard
PlanDefinition.action:reportCancerData.relatedAction.relationshiprequiredFixed Value: before-start
http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1
from the FHIR Standard

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 SC 1..1 USPublicHealthPlanDefinition ccrr-Central Cancer Registry Reporting
pdf-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... 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 2..* 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.

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

Fixed Value: text/fhirpath
....... expression Σ 0..1 string Expression in specified language
....... reference Σ 0..1 uri Where the expression is found