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
Projo defines code systems and identifier systems under the same two namespaces as its extensions:
| Namespace | Used for |
|---|---|
https://projo.evoleen.com/fhir/... |
Projo-owned code systems and identifier systems |
https://firearrow.io/fhir/... |
Transport-shared code systems (configurable via EXTENSION_BASE_URL) |
| System URL | Codes | Description |
|---|---|---|
https://projo.evoleen.com/fhir/CodeSystem/task-business-status |
waiting-for-delivery, invited, reminder-sent, collecting-responses, responses-collected, delivery-failed, expired |
Task business status lifecycle. Bound to Task.businessStatus. |
https://projo.evoleen.com/fhir/CodeSystem/task-output |
communication-request, questionnaire-response |
Discriminator codes for Task.output entries, indicating which referenced resource was produced. |
https://projo.evoleen.com/fhir/CodeSystem/plan-slot-kind |
onboarding, default, re-engagement, onboarding-routing |
Kind of plan slot declared via the plan-slot Organization extension. Drives which PlanDefinition is applied at which lifecycle stage. ADR 0002, ADR 0007. |
https://projo.evoleen.com/fhir/CodeSystem/extraction-provenance |
sdc-extraction |
Provenance activity code marking resources produced by SDC $extract. |
https://projo.evoleen.com/fhir/CodeSystem/routing-provenance |
clinical-routing |
Provenance activity code marking resources produced by clinical routing (e.g. Flags created from extraction). |
https://projo.evoleen.com/fhir/CodeSystem/bounded-action |
enroll-plan, supersede-plan, route-to-review (implemented); notify-practitioner, raise-flag, send-message, create-task, assign-careteam (designed, not implemented) |
Action codes for bounded PlanDefinition outputs. The implemented codes are produced by $apply; the designed-only codes are reserved for future knowledge artifacts. |
https://projo.evoleen.com/fhir/CodeSystem/extraction-writeback-target |
subject |
Target of extraction writeback. Used by the extraction-writeback Questionnaire extension. ADR 0010. |
https://projo.evoleen.com/fhir/CodeSystem/extraction-writeback-mode |
fill-if-empty |
Writeback mode. Currently only fill-if-empty is defined. Used by the extraction-writeback Questionnaire extension. ADR 0010. |
https://projo.evoleen.com/fhir/CodeSystem/identity-resolution-reason |
no-match, multiple-matches, non-conversational-only, no-active-cr, unresolved-receiver |
Reason code recorded on a reverse CommunicationRequest when identity resolution could not be completed. Bound to the identity-resolution-reason extension. |
| System URL | Codes | Description |
|---|---|---|
https://firearrow.io/fhir/CodeSystem/communication-medium |
whatsapp, rcs, web |
Channel used to send or receive a CommunicationRequest / Communication. rcs added by ADR 0012; web by ADR 0011. |
https://firearrow.io/fhir/CodeSystem/communication-category |
invitation, question, answer, reminder, abandoned, completion |
Category codes classifying Communication / CommunicationRequest resources by purpose in the conversation. |
https://firearrow.io/fhir/CodeSystem/cr-category |
identity-resolution-required, reminder |
Specialized category for reverse CommunicationRequests (inbound-driven). identity-resolution-required marks a CR that needs server-side identity resolution; reminder marks an outbound reminder. |
https://firearrow.io/fhir/CodeSystem/managed-subscription |
sidecar-cr-events, projo-cr-status-events, projo-identity-resolution-events, projo-careplan-bootstrap |
Discriminator codes for managed FHIR Subscriptions. Each code names a subscription topic that one of the three apps owns. See Subscriptions. |
https://firearrow.io/fhir/CodeSystem/careplan-scheduling |
scheduled |
Server-owned flag written by Fire Arrow's $subscribe-due-events operation to mark a CarePlan activity as scheduled for due-event evaluation. |
| System URL | Used on | Value format | Description |
|---|---|---|---|
https://firearrow.io/fhir/identifier/whatsapp-bsuid |
Patient.identifier (and related resources) |
Meta business-scoped user id (string) | WhatsApp user-scoped id. Used to match inbound messages to a patient. |
https://firearrow.io/fhir/identifier/wamid |
Communication.identifier |
WhatsApp message id | WhatsApp message id (wamid). Round-tripped from the WhatsApp API. |
https://firearrow.io/fhir/identifier/inbound-sender-phone |
CommunicationRequest.identifier (reverse CR) |
E.164 phone number | Sender phone number for a reverse (inbound-driven) CommunicationRequest. |
https://firearrow.io/fhir/identifier/inbound-business-phone |
CommunicationRequest.recipient[].identifier |
E.164 phone number | Receiving business phone number for a reverse CommunicationRequest. |
https://projo.evoleen.com/fhir/identifier/extracted-resource |
Observation.identifier, Condition.identifier (and other extracted resources) |
<qrId>#<ResourceType>#<codeSystem>#<code>#<contentHash> |
Stable identifier minted by SDC extraction writeback. Enables idempotent re-extraction: the same QuestionnaireResponse yields the same identifier, so re-running $extract updates rather than duplicates. ADR 0010. |
https://projo.evoleen.com/fhir/identifier/routing-resource |
Flag.identifier |
<qrId>:review |
Identifier on Flags created by clinical routing, linking the Flag back to the source QuestionnaireResponse review task. |
https://projo.evoleen.com/fhir/identifier/organization |
Organization.identifier |
Tenant-defined | External identifier for the organization. |
https://projo.evoleen.com/fhir/identifier/projo-azure-identity |
(server-side only) | Azure-resolved identity reference | Server-side identity resolution marker. Written by the orchestrator when an Azure-backed identity lookup resolves a patient. |
https://projo.evoleen.com/fhir/identifier/ciam-unique-client-id |
(server-side only) | CIAM client id | Server-side CIAM identity resolution marker. Written by the orchestrator when a CIAM unique client id resolves a patient. |