Palamond Docs
Reference

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/.

ExportPurpose
PROGRAM_ACTION_SYSTEMCodes for a protocol action's kind (intake, refill, lab order).
LAB_PANEL_SYSTEMClinical lab panels authored in protocols.
MEDICATION_SYSTEMPalamond medication codes.
OBSERVATION_PANEL_SYSTEMOpaque handle for a set of observations captured together.
STATUS_REASON_SYSTEMWhy a resource was cancelled or superseded.
ENCOUNTER_MODALITY_SYSTEMSync versus async visit modality.
VISIT_FORMAT_SYSTEMFormat of a sync visit: voice, video, or in-person.
PLAN_DEFINITION_TYPE_SYSTEMDiscriminates assessment / protocol / program.
TASK_CODE_SYSTEMThe kind of work a practitioner or patient Task represents.
QUESTIONNAIRE_PURPOSE_SYSTEMIntake / check-in / monitoring form purpose.

Standard external systems

Standard terminologies Palamond references, re-exported so app code has one import site.

ExportSystem
LOINC_SYSTEMhttp://loinc.org
SNOMED_CT_SYSTEMhttp://snomed.info/sct
RXNORM_SYSTEMhttp://www.nlm.nih.gov/research/umls/rxnorm
ICD10CM_SYSTEMhttp://hl7.org/fhir/sid/icd-10-cm
VITAL_SIGNS_CATEGORYHL7 observation-category vital-signs coding.

Search tokens

Helpers that build system|code FHIR search tokens, so searches never concatenate strings:

ExportBuilds
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

ExportCodes
ENCOUNTER_MODALITY_CODESsync, async
VISIT_FORMAT_CODESvoice, video, in-person
PLAN_DEFINITION_TYPE_CODESassessment, clinical-protocol, program
PROGRAM_ACTION_CODESintake-questionnaire, visit-review, prescription-refill, lab-order, refill-checkin, observation-capture, medication-suggestion, service-suggestion
QUESTIONNAIRE_PURPOSE_CODESintake, check-in, monitoring
INTAKE_COMPONENT_KINDSquestionnaire, lab, observation, medication, service
TREATMENT_OPTION_KINDSmedication, non-clinical, procedure, lab
OBSERVATION_PANEL_CODESblood-pressure
LAB_PANEL_CODESthyroid-panel
MEDICATION_CODESacne-medication, thyroid-medication

Task codes and decisions

ExportCodes
TASK_CODESreview, order-fulfillment, request-review
SPINE_STEP_CODESspine-intake, spine-review, spine-selection, spine-consent
SPINE_CONSENT_DECISIONSaccept, decline, counter
ORDER_FULFILLMENT_DECISIONSaccept, decline
ORDER_FULFILLMENT_METHODSlab: home-kit, in-person-draw; medication: mail-order, retail-pickup
ORDER_FULFILLMENT_OUTPUT_CODESdecision, method, performer, location
ORDER_DESTINATION_SUBkind, recipient, address, method, location

Statuses and reasons

ExportCodes
STATUS_REASON_CODESsuperseded, cancelled, rescheduled
ALLERGY_CLINICAL_STATUS_CODESactive, inactive, resolved
ALLERGY_VERIFICATION_STATUS_CODESunconfirmed, confirmed, refuted, entered-in-error
ALLERGY_CRITICALITY_CODESlow, high, unable-to-assess
ALLERGY_CATEGORY_CODESfood, 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.

ExportTag
PUBLIC_CATALOG_TAGMarks a HealthcareService visible to patients (code: public).
PATIENT_TASK_TAGMarks a Task the patient acts on (code: patient).
REQUEST_SOURCE_TAGMarks a request a patient originated (code: patient).
LATEST_VERSION_TAGMarks the highest published version of a canonical url (code: latest).

Extensions

Palamond extensions are hosted under https://palamond.dev/fhir/StructureDefinition/.

ExportCarried onMeaning
APPOINTMENT_PATIENT_QUESTIONNAIRE_EXTENSION_URLAppointmentPatient should complete a questionnaire for this visit.
APPOINTMENT_PATIENT_OBSERVATION_EXTENSION_URLAppointmentPatient should capture an observation panel for this visit.
APPOINTMENT_CARE_PLAN_EXTENSION_URLAppointmentThe CarePlan the appointment was scheduled for.
APPOINTMENT_VISIT_FORMAT_EXTENSION_URLAppointmentFormat chosen for a sync visit (voice, video, in-person).
APPOINTMENT_RESCHEDULED_TO_EXTENSION_URLAppointmentOn a cancelled original, points to its replacement.
APPOINTMENT_RESCHEDULED_FROM_EXTENSION_URLAppointmentOn a replacement, points back to the original.
ORDER_DESTINATION_EXTENSIONRequestGroup / order childrenWhere an order ships and how it is fulfilled.
HEALTHCARE_SERVICE_PLAN_DEFINITION_EXTENSION_URLHealthcareServiceThe PlanDefinition canonical a public offering exposes.
HEALTHCARE_SERVICE_INTAKE_EXTENSION_URLHealthcareServiceThe scoped intake questionnaire an assessment entry fronts.
ACTIVITY_OWNER_CARE_TEAM_EXTENSION_URLActivityDefinitionWhich CareTeam queue owns the generated Task.
TASK_CARE_TEAM_EXTENSION_URLTaskThe queue a Task originated in (never rewritten).
PRACTITIONER_ROLE_TIMEZONE_EXTENSION_URLPractitionerRoleIANA 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.

ExportKeyed by
ORGANIZATION_IDENTIFIER_SYSTEMTenant Organization business key.
CARE_TEAM_IDENTIFIER_SYSTEMSeeded CareTeam queue slug.
EPISODE_OF_CARE_IDENTIFIER_SYSTEMPer-patient, per-entry episode ({patientId}:{entry}).
APPOINTMENT_FOR_OCCURRENCE_IDENTIFIER_SYSTEMOne appointment per care-plan action occurrence.
APPOINTMENT_FOR_ASSESSMENT_IDENTIFIER_SYSTEMOne appointment per patient + assessment entry.
ENCOUNTER_FOR_APPOINTMENT_IDENTIFIER_SYSTEMThe encounter materialized when an appointment is picked up.
PATIENT_TASK_FOR_APPOINTMENT_IDENTIFIER_SYSTEMOne managed patient task per appointment + intent.
ORDER_FULFILLMENT_TASK_IDENTIFIER_SYSTEMThe fulfillment task for a proposal RequestGroup.
SCHEDULE_FOR_ACTOR_IDENTIFIER_SYSTEMOne 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).

ExportExample
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.

On this page