Projo FHIR Documentation
0.1.0 - ci-build
Projo FHIR Documentation
0.1.0 - ci-build
Projo FHIR Documentation - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://projo.evoleen.com/fhir/StructureDefinition/opted-out | Version: 0.1.0 | |||
| Draft as of 2024-01-01 | Computable Name: OptedOut | |||
Copyright/Legal: Copyright (c) Projo. Licensed under CC0-1.0 (public domain dedication). FHIR(R) is the registered trademark of HL7 and is used with permission. This IG references WhatsApp(R), a trademark of Meta Platforms, Inc., for descriptive purposes only. |
||||
Timestamp marking that the patient opted out of messaging by sending a STOP command. Set by handleStopCommand (via setOptedOut) — idempotent, skipped when already present. Read by the opt-out guards in handleIdentityResolutionRequired and applyTriggeredPlanIfNeeded to suppress plan application / re-engagement so the patient is not re-enrolled despite the STOP confirmation promising no further messages. The sweeper's Phase 3 re-engagement also checks this. Previously written inline as a literal URL in identityResolution.ts; centralized in the PatientExtensions constant + IG (ADR 0012 housekeeping).
Documentation-only artifact. Projo's runtime extensions, code systems, identifier systems and search parameter are TypeScript constants and bootstrap-time resources, NOT deployed StructureDefinitions. This StructureDefinition exists to document the contract; the source of truth is src/functions/src/lib/fhir/types.ts and docs/FHIR_EXTENSIONS.md.
Context of Use
This extension may be used on the following element(s)
Patient
Usage info
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Extension |
0..* | Extension | Opted Out | |
  id |
0..1 | string | Unique id for inter-element referencing | |
 extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "https://projo.evoleen.com/fhir/StructureDefinition/opted-out" | |
 value[x] |
1..1 | dateTime | Value of extension | |
| Documentation for this format | ||||
This structure is derived from Extension
Summary
Simple Extension with the type dateTime: Timestamp marking that the patient opted out of messaging by sending a STOP command. Set by handleStopCommand (via setOptedOut) — idempotent, skipped when already present. Read by the opt-out guards in handleIdentityResolutionRequired and applyTriggeredPlanIfNeeded to suppress plan application / re-engagement so the patient is not re-enrolled despite the STOP confirmation promising no further messages. The sweeper's Phase 3 re-engagement also checks this. Previously written inline as a literal URL in identityResolution.ts; centralized in the PatientExtensions constant + IG (ADR 0012 housekeeping).
Differential View
This structure is derived from Extension
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | Opted Out | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "https://projo.evoleen.com/fhir/StructureDefinition/opted-out" | |
| value[x] |
1..1 | dateTime | Value of extension | |
| Documentation for this format | ||||
This structure is derived from Extension
Summary
Simple Extension with the type dateTime: Timestamp marking that the patient opted out of messaging by sending a STOP command. Set by handleStopCommand (via setOptedOut) — idempotent, skipped when already present. Read by the opt-out guards in handleIdentityResolutionRequired and applyTriggeredPlanIfNeeded to suppress plan application / re-engagement so the patient is not re-enrolled despite the STOP confirmation promising no further messages. The sweeper's Phase 3 re-engagement also checks this. Previously written inline as a literal URL in identityResolution.ts; centralized in the PatientExtensions constant + IG (ADR 0012 housekeeping).
Other representations of profile: CSV, Excel, Schematron
| Id | Grade | Path(s) | Description | Expression |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|