Codes Reference
FHIR code systems, statuses, extensions, and identifiers Palamond uses.
Every Palamond FHIR coordinate (code-system URL, code, extension URL, identifier system) is exported from @palamond/sdk/codes, published with the SDK from the same source the platform uses. Import the constant; never hardcode these strings in application code. The tables below are grouped by domain and name the export each value comes from.
Import the constant, not the literal:
import { LOINC_SYSTEM, TASK_CODES, ENCOUNTER_MODALITY_CODES } from '@palamond/sdk/codes';Code system URLs
Palamond code systems are hosted under https://palamond.dev/fhir/CodeSystem/.
| Export | Purpose |
|---|---|
PROGRAM_ACTION_SYSTEM | Codes for a protocol action's kind (intake, refill, lab order). |
LAB_PANEL_SYSTEM | Clinical lab panels authored in protocols. |
MEDICATION_SYSTEM | Palamond medication codes. |
OBSERVATION_PANEL_SYSTEM | Opaque handle for a set of observations captured together. |
STATUS_REASON_SYSTEM | Why a resource was cancelled or superseded. |
ENCOUNTER_MODALITY_SYSTEM | Sync versus async visit modality. |
VISIT_FORMAT_SYSTEM | Format of a sync visit: voice, video, or in-person. |
PLAN_DEFINITION_TYPE_SYSTEM | Discriminates assessment / protocol / program. |
TASK_CODE_SYSTEM | The kind of work a practitioner or patient Task represents. |
QUESTIONNAIRE_PURPOSE_SYSTEM | Intake / check-in / monitoring form purpose. |
Standard external systems
Standard terminologies Palamond references, re-exported so app code has one import site.
| Export | System |
|---|---|
LOINC_SYSTEM | http://loinc.org |
SNOMED_CT_SYSTEM | http://snomed.info/sct |
RXNORM_SYSTEM | http://www.nlm.nih.gov/research/umls/rxnorm |
ICD10CM_SYSTEM | http://hl7.org/fhir/sid/icd-10-cm |
VITAL_SIGNS_CATEGORY | HL7 observation-category vital-signs coding. |
Search tokens
Helpers that build system|code FHIR search tokens, so searches never concatenate strings:
| Export | Builds |
|---|---|
loinc(code) | A LOINC token: loinc('8867-4') is http://loinc.org|8867-4. |
snomed(code) | A SNOMED CT token. |
rxnorm(code) | An RxNorm token. |
icd10cm(code) | An ICD-10-CM token. |
searchToken(coding) | A token from any coding constant: searchToken(PATIENT_TASK_TAG), searchToken(VITAL_SIGNS_CATEGORY). |
import { loinc, searchToken, PATIENT_TASK_TAG } from '@palamond/sdk/codes';
await palamond.searchResources('Observation', { code: loinc('8867-4') });
await palamond.searchResources('Task', { _tag: searchToken(PATIENT_TASK_TAG) });Categories and kinds
| Export | Codes |
|---|---|
ENCOUNTER_MODALITY_CODES | sync, async |
VISIT_FORMAT_CODES | voice, video, in-person |
PLAN_DEFINITION_TYPE_CODES | assessment, clinical-protocol, program |
PROGRAM_ACTION_CODES | intake-questionnaire, visit-review, prescription-refill, lab-order, refill-checkin, observation-capture, medication-suggestion, service-suggestion |
QUESTIONNAIRE_PURPOSE_CODES | intake, check-in, monitoring |
INTAKE_COMPONENT_KINDS | questionnaire, lab, observation, medication, service |
TREATMENT_OPTION_KINDS | medication, non-clinical, procedure, lab |
OBSERVATION_PANEL_CODES | blood-pressure |
LAB_PANEL_CODES | thyroid-panel |
MEDICATION_CODES | acne-medication, thyroid-medication |
Task codes and decisions
| Export | Codes |
|---|---|
TASK_CODES | review, order-fulfillment, request-review |
SPINE_STEP_CODES | spine-intake, spine-review, spine-selection, spine-consent |
SPINE_CONSENT_DECISIONS | accept, decline, counter |
ORDER_FULFILLMENT_DECISIONS | accept, decline |
ORDER_FULFILLMENT_METHODS | lab: home-kit, in-person-draw; medication: mail-order, retail-pickup |
ORDER_FULFILLMENT_OUTPUT_CODES | decision, method, performer, location |
ORDER_DESTINATION_SUB | kind, recipient, address, method, location |
Statuses and reasons
| Export | Codes |
|---|---|
STATUS_REASON_CODES | superseded, cancelled, rescheduled |
ALLERGY_CLINICAL_STATUS_CODES | active, inactive, resolved |
ALLERGY_VERIFICATION_STATUS_CODES | unconfirmed, confirmed, refuted, entered-in-error |
ALLERGY_CRITICALITY_CODES | low, high, unable-to-assess |
ALLERGY_CATEGORY_CODES | food, medication, environment, biologic |
Meta tags
meta.tag markers used to scope visibility and audience. Patients hold read-only access policies filtered by several of these.
| Export | Tag |
|---|---|
PUBLIC_CATALOG_TAG | Marks a HealthcareService visible to patients (code: public). |
PATIENT_TASK_TAG | Marks a Task the patient acts on (code: patient). |
REQUEST_SOURCE_TAG | Marks a request a patient originated (code: patient). |
LATEST_VERSION_TAG | Marks the highest published version of a canonical url (code: latest). |
Extensions
Palamond extensions are hosted under https://palamond.dev/fhir/StructureDefinition/.
| Export | Carried on | Meaning |
|---|---|---|
APPOINTMENT_PATIENT_QUESTIONNAIRE_EXTENSION_URL | Appointment | Patient should complete a questionnaire for this visit. |
APPOINTMENT_PATIENT_OBSERVATION_EXTENSION_URL | Appointment | Patient should capture an observation panel for this visit. |
APPOINTMENT_CARE_PLAN_EXTENSION_URL | Appointment | The CarePlan the appointment was scheduled for. |
APPOINTMENT_VISIT_FORMAT_EXTENSION_URL | Appointment | Format chosen for a sync visit (voice, video, in-person). |
APPOINTMENT_RESCHEDULED_TO_EXTENSION_URL | Appointment | On a cancelled original, points to its replacement. |
APPOINTMENT_RESCHEDULED_FROM_EXTENSION_URL | Appointment | On a replacement, points back to the original. |
ORDER_DESTINATION_EXTENSION | RequestGroup / order children | Where an order ships and how it is fulfilled. |
HEALTHCARE_SERVICE_PLAN_DEFINITION_EXTENSION_URL | HealthcareService | The PlanDefinition canonical a public offering exposes. |
HEALTHCARE_SERVICE_INTAKE_EXTENSION_URL | HealthcareService | The scoped intake questionnaire an assessment entry fronts. |
ACTIVITY_OWNER_CARE_TEAM_EXTENSION_URL | ActivityDefinition | Which CareTeam queue owns the generated Task. |
TASK_CARE_TEAM_EXTENSION_URL | Task | The queue a Task originated in (never rewritten). |
PRACTITIONER_ROLE_TIMEZONE_EXTENSION_URL | PractitionerRole | IANA timezone for availableTime. |
Identifier systems
Business identifiers under https://palamond.dev/fhir/Identifier/. Most exist so the platform can upsert idempotently by a stable key.
| Export | Keyed by |
|---|---|
ORGANIZATION_IDENTIFIER_SYSTEM | Tenant Organization business key. |
CARE_TEAM_IDENTIFIER_SYSTEM | Seeded CareTeam queue slug. |
EPISODE_OF_CARE_IDENTIFIER_SYSTEM | Per-patient, per-entry episode ({patientId}:{entry}). |
APPOINTMENT_FOR_OCCURRENCE_IDENTIFIER_SYSTEM | One appointment per care-plan action occurrence. |
APPOINTMENT_FOR_ASSESSMENT_IDENTIFIER_SYSTEM | One appointment per patient + assessment entry. |
ENCOUNTER_FOR_APPOINTMENT_IDENTIFIER_SYSTEM | The encounter materialized when an appointment is picked up. |
PATIENT_TASK_FOR_APPOINTMENT_IDENTIFIER_SYSTEM | One managed patient task per appointment + intent. |
ORDER_FULFILLMENT_TASK_IDENTIFIER_SYSTEM | The fulfillment task for a proposal RequestGroup. |
SCHEDULE_FOR_ACTOR_IDENTIFIER_SYSTEM | One Schedule per actor (Practitioner or CareTeam). |
Canonical URL bases
The deploy pipeline mints authored canonicals under these bases; apps detect "one of ours" with url.startsWith(base).
| Export | Example |
|---|---|
PLAN_DEFINITION_URL_BASE | .../PlanDefinition/acne-care |
QUESTIONNAIRE_URL_BASE | .../Questionnaire/acne-intake |
ACTIVITY_DEFINITION_URL_BASE | .../ActivityDefinition/acne-treatment-refill |
CONDITION_TEMPLATE_URL_BASE | .../ConditionTemplate/acne-vulgaris |
Do not treat this page as the source of truth. The module is. If a value here disagrees with @palamond/sdk/codes, the module wins.