DSP FHIR

Terminology & canonical URLs

Every CodeSystem, ValueSet, extension, and profile used in the DSP-FHIR IG. One page, one copy-pasteable URL per row. The IG publishes these under https://dsp-fhir.org/... as its canonical base.

External code systems (re-used, not invented)

ConceptSystem URIWhere used
SNOMED CThttp://snomed.info/sctConditions, body sites, categories, routes.
LOINChttp://loinc.orgLab orders, document/section types, transcript type.
RxNormhttp://www.nlm.nih.gov/research/umls/rxnormMedication codes.
CPThttp://www.ama-assn.org/go/cptProcedures.
ICD-10-CMhttp://hl7.org/fhir/sid/icd-10-cmUS diagnosis coding (alternate to SNOMED on Condition).
DICOM Controlled Terminologyhttp://dicom.nema.org/resources/ontology/DCMImaging modality (imaging-modality).
UCUMhttp://unitsofmeasure.orgDose, duration, and other quantity units.
US NPIhttp://hl7.org/fhir/sid/us-npiPractitioner identifier.
HL7 v3 ActCodehttp://terminology.hl7.org/CodeSystem/v3-ActCodeEncounter.class (AMB, IMP, EMER, …).
FHIR request-intenthttp://hl7.org/fhir/request-intentorder / plan / proposal / reflex-order.
FHIR request-statushttp://hl7.org/fhir/request-statusactive / completed / cancelled / …
FHIR condition-ver-statushttp://terminology.hl7.org/CodeSystem/condition-ver-statusconfirmed / unconfirmed / differential / refuted / …

DSP-FHIR CodeSystems (minted by the IG)

CodeSystemCanonical URLPurpose
DSP doc-categoryhttps://dsp-fhir.org/CodeSystem/doc-categoryValues: note, transcript, recording, referral-letter.
DSP order-categoryhttps://dsp-fhir.org/CodeSystem/order-categoryValues: follow-up — for the non-SNOMED follow-up category.
DSP speaker-rolehttps://dsp-fhir.org/CodeSystem/speaker-roleValues: provider, patient, other, unknown.
DSP update-statushttps://dsp-fhir.org/CodeSystem/update-statusMirrors DSP's NEW / UPDATED / DELETED; preferred model is meta.versionId + Provenance.
DSP payload-qualityhttps://dsp-fhir.org/CodeSystem/payload-qualityValues: draft, preview, release.

DSP-FHIR ValueSets

ValueSetCanonical URLBinding
DSP condition codeshttps://dsp-fhir.org/ValueSet/condition-codesSNOMED CT + ICD-10-CM, extensible.
DSP medication codeshttps://dsp-fhir.org/ValueSet/medication-codesRxNorm SCD/SBD, extensible.
DSP lab codeshttps://dsp-fhir.org/ValueSet/lab-codesLOINC orderables, extensible.
DSP imaging modalityhttps://dsp-fhir.org/ValueSet/imaging-modalityDCM modality codes, required.
DSP imaging contrasthttps://dsp-fhir.org/ValueSet/imaging-contrastwith / without / with-and-without, required.
DSP lateralityhttps://dsp-fhir.org/ValueSet/lateralityleft / right / bilateral, required.
DSP procedure codeshttps://dsp-fhir.org/ValueSet/procedure-codesCPT + SNOMED procedures, extensible.
DSP specialtyhttps://dsp-fhir.org/ValueSet/specialtySNOMED specialty codes, extensible (referral subtype).
DSP duration unithttps://dsp-fhir.org/ValueSet/duration-unitUCUM subset: min / h / d / wk / mo / a, required.

DSP-FHIR extensions

ExtensionCanonical URLShapeApplies to
payload-version.../StructureDefinition/payload-versioncomplex (major/minor/revision/quality)Encounter, Bundle.meta
external-callback-url.../StructureDefinition/external-callback-urlvalueUrlEncounter
update-status.../StructureDefinition/update-statusvalueCodeAny resource (optional; prefer Provenance)
spoken-forms.../StructureDefinition/spoken-formscomplex (repeating form valueString)Condition, Composition.section, orders
transcript-turn-refs.../StructureDefinition/transcript-turn-refscomplex (repeating turn valueInteger)Any clinical resource
speaker-count.../StructureDefinition/speaker-countvaluePositiveIntDocumentReference (transcript)
confidence-score.../StructureDefinition/confidence-scorevalueDecimal (0–1)MedicationRequest, ServiceRequest (orders only in DSP 1.0)
legacy-id.../StructureDefinition/legacy-idvalueStringComposition.section (DSP legacy_id)
rendered-dosage-instruction.../StructureDefinition/rendered-dosage-instructionvalueStringMedicationRequest (back-port of R5 element)
abbreviation.../StructureDefinition/abbreviationvalueStringServiceRequest (lab)
bodysite-laterality.../StructureDefinition/bodysite-lateralityvalueCode (bound to laterality VS)ServiceRequest.bodySite
imaging-modality.../StructureDefinition/imaging-modalityvalueCoding (bound to DCM)ServiceRequest (imaging)
imaging-views.../StructureDefinition/imaging-viewsvalueStringServiceRequest (imaging)
imaging-contrast.../StructureDefinition/imaging-contrastvalueCode (contrast VS)ServiceRequest (imaging)
procedure-devices.../StructureDefinition/procedure-devicescomplex (repeating device valueString)ServiceRequest (procedure)
return-in.../StructureDefinition/return-invalueDurationServiceRequest (follow-up) — alt to occurrenceTiming.boundsDuration
approximation.../StructureDefinition/approximationvalueBooleanDuration (nested on boundsDuration)
prn.../StructureDefinition/prnvalueBooleanServiceRequest (follow-up)
tenant-organization.../StructureDefinition/tenant-organizationvalueReference(Organization)Encounter (for DSP organization_id)

DSP-FHIR profiles

ProfileCanonical URLBase
DspEncounter.../StructureDefinition/DspEncounterEncounter
DspPatient.../StructureDefinition/DspPatientUS Core Patient (where applicable) / Patient
DspPractitioner.../StructureDefinition/DspPractitionerUS Core Practitioner / Practitioner
DspCondition.../StructureDefinition/DspConditionCondition
DspMedicationRequest.../StructureDefinition/DspMedicationRequestMedicationRequest
DspLabOrder.../StructureDefinition/DspLabOrderServiceRequest
DspImagingOrder.../StructureDefinition/DspImagingOrderServiceRequest
DspProcedureOrder.../StructureDefinition/DspProcedureOrderServiceRequest
DspReferralOrder.../StructureDefinition/DspReferralOrderServiceRequest
DspFollowUpOrder.../StructureDefinition/DspFollowUpOrderServiceRequest
DspComposition.../StructureDefinition/DspCompositionComposition
DspTranscript.../StructureDefinition/DspTranscriptDocumentReference
DspRecording.../StructureDefinition/DspRecordingDocumentReference

Operations

OperationURLNotes
$graphql[fhir-base]/$graphqlSystem-level, read; canonical DSP query published by the IG.
$everything (Encounter)[fhir-base]/Encounter/{id}/$everythingOptional; coarse fallback where GraphQL isn't available.
SubscriptionTopic.../SubscriptionTopic/dsp-encounter-readyPush delivery trigger (R4B/R5 backport via IG).

Standard CodeSystems used

Every non-DSP CodeSystem that DSP-FHIR emits or binds against. Downstream canonical stores layering under any R4 repository can expect codings from these systems on the resources DSP-FHIR publishes; terminology servers should be provisioned to resolve all of them.

PurposeSystem URINotes
Clinical findings, problems, body sites, categories, routeshttp://snomed.info/sctCondition codes, procedure codes, many clinical codings. Dual-coded with ICD-10-CM where applicable.
US diagnosis codinghttp://hl7.org/fhir/sid/icd-10-cmCondition codes (US). Companion to SNOMED on Condition.code.
Lab, document, and section codeshttp://loinc.orgObservation / lab / document codes, Composition.type and section.code, transcript type.
Medicationshttp://www.nlm.nih.gov/research/umls/rxnormMedication codes on MedicationRequest.medicationCodeableConcept.
Procedure codes (US)http://www.ama-assn.org/go/cptCPT procedure coding; paired with SNOMED procedures where applicable.
Vaccine codeshttp://hl7.org/fhir/sid/cvxCVX codes on Immunization.vaccineCode (preferred over SNOMED where available).
Quantity units (UCUM)http://unitsofmeasure.orgDose, duration, and all other Quantity.system uses.
Practitioner identifierhttp://hl7.org/fhir/sid/us-npiNPI on Practitioner.identifier.system.
Imaging modalityhttp://dicom.nema.org/resources/ontology/DCMDICOM modality codes on the imaging-modality extension.
Condition.clinicalStatushttp://terminology.hl7.org/CodeSystem/condition-clinicalactive / recurrence / relapse / inactive / remission / resolved.
Condition.verificationStatushttp://terminology.hl7.org/CodeSystem/condition-ver-statusconfirmed / unconfirmed / differential / refuted / entered-in-error / provisional.
Condition.categoryhttp://terminology.hl7.org/CodeSystem/condition-categoryencounter-diagnosis, problem-list-item.
Observation.categoryhttp://terminology.hl7.org/CodeSystem/observation-categoryNoted for completeness; DSP-FHIR 1.0 does not emit Observation, but downstream stores materialising vitals/labs SHOULD use this system.
Encounter.classhttp://terminology.hl7.org/CodeSystem/v3-ActCodeAMB, IMP, EMER, …
Encounter.priorityhttp://terminology.hl7.org/CodeSystem/v3-ActPriorityUsed by the encounter view definition.
Encounter.participant.typehttp://terminology.hl7.org/CodeSystem/v3-ParticipationTypee.g. ESC (escort / accompanier).
Identifier type qualifiershttp://terminology.hl7.org/CodeSystem/v2-0203Identifier.type (MR, VN, …).
Practitioner qualificationhttp://terminology.hl7.org/CodeSystem/v2-0360Qualification value set on Practitioner.qualification.
Anatomical site qualifiershttp://terminology.hl7.org/CodeSystem/v3-ActSiteInjection site on Immunization.site (e.g. LD).
Route of administrationhttp://terminology.hl7.org/CodeSystem/v3-RouteOfAdministrationImmunization.route.
Role codeshttp://terminology.hl7.org/CodeSystem/v3-RoleCodeUsed by $match related-person relationships.
Data operations (Provenance)http://terminology.hl7.org/CodeSystem/v3-DataOperationProvenance.activity for CREATE / UPDATE / DELETE.
Provenance participant typehttp://terminology.hl7.org/CodeSystem/provenance-participant-typeProvenance.agent.type.
Media typehttp://terminology.hl7.org/CodeSystem/media-typeRecording / media classification.
Immunization recommendation statushttp://terminology.hl7.org/CodeSystem/immunization-recommendation-statusImmunizationRecommendation.recommendation.forecastStatus.
Immunization recommendation date criterionhttp://terminology.hl7.org/CodeSystem/immunization-recommendation-date-criterionImmunizationRecommendation.recommendation.dateCriterion.code.
ServiceRequest.category (procedural slices)http://snomed.info/sctImaging 363679005, procedure 387713003, referral 3457005 per view definitions in src/data/viewDefinitions.mjs.
ServiceRequest.category (lab slice)http://snomed.info/sctLaboratory procedure 108252007. The HL7 http://terminology.hl7.org/CodeSystem/service-category system is referenced in FML source bindings; downstream stores MAY dual-code.
FHIR request-intenthttp://hl7.org/fhir/request-intentorder / plan / proposal / reflex-order.
FHIR request-statushttp://hl7.org/fhir/request-statusactive / completed / cancelled / …
US Core pronouns / gender identityhttp://hl7.org/fhir/us/core/StructureDefinition/us-core-pronouns, .../us-core-genderIdentityExtensions re-used from US Core; value codings in LOINC.
FHIR translation extensionhttp://hl7.org/fhir/StructureDefinition/translationSecondary display text on codings / strings.
FHIR match-gradehttp://hl7.org/fhir/StructureDefinition/match-gradePatient $match grading.

DSP-FHIR URI namespace

DSP-FHIR reserves the following URI families. Downstream canonical stores SHOULD NOT publish artefacts under these namespaces; layering happens by referencing DSP-FHIR canonicals from the downstream R4 store, not by re-minting them.

FamilyURI patternUsed for
StructureDefinitionhttps://dsp-fhir.org/StructureDefinition/*Profiles and extensions.
CodeSystemhttps://dsp-fhir.org/CodeSystem/*DSP-specific code systems.
ValueSethttps://dsp-fhir.org/ValueSet/*DSP-specific value sets.
ConceptMaphttps://dsp-fhir.org/ConceptMap/*DSP ↔ FHIR concept maps.
StructureMaphttps://dsp-fhir.org/StructureMap/*FML maps.
Identifier systemshttps://dsp-fhir.org/identifier/*Stable business identifiers minted by DSP-FHIR.
OperationDefinition / SubscriptionTopichttps://dsp-fhir.org/OperationDefinition/*, .../SubscriptionTopic/*DSP-minted operations and topics.

Defined extensions

Inventory of every extension currently minted under https://dsp-fhir.org/StructureDefinition/ across the IG pages. Value types are taken from the mapping / GraphQL / example pages; where a value type cannot be determined from the published artefacts it is marked see extension definition.

Extension URLValue typePurpose
.../StructureDefinition/payload-versioncomplexPayload major/minor/revision/quality on Encounter and Bundle.meta.
.../StructureDefinition/dsp-payload-versionscomplex (repeating)Payload-version history reported by $document-style operations.
.../StructureDefinition/external-callback-urlvalueUrlAsync callback URL on Encounter.
.../StructureDefinition/dsp-external-callback-urlvalueUrlSource-side alias for external-callback-url used in FML.
.../StructureDefinition/dsp-tenant-organizationvalueReference(Organization)Tenant / organization scoping on Encounter.
.../StructureDefinition/tenant-organizationvalueReference(Organization)Published alias of dsp-tenant-organization.
.../StructureDefinition/dsp-timezonevalueStringIANA timezone on Encounter.
.../StructureDefinition/recording-localesee extension definitionBCP-47 locale of an audio/transcript recording.
.../StructureDefinition/update-statusvalueCodeNEW / UPDATED / DELETED mirror; Provenance is preferred.
.../StructureDefinition/spoken-formscomplex (repeating form valueString)Verbatim spoken forms attached to codings or sections.
.../StructureDefinition/search-termscomplex (repeating valueString)Additional search tokens for indexing.
.../StructureDefinition/transcript-turn-refscomplex (repeating turn valueInteger)Transcript turn indices that justify a clinical resource.
.../StructureDefinition/transcript-speaker-countvaluePositiveIntDistinct speaker count on the transcript DocumentReference.
.../StructureDefinition/speaker-countvaluePositiveIntPublished alias of transcript-speaker-count on transcript DocumentReference.
.../StructureDefinition/confidence-scorevalueDecimal (0–1)Per-element extraction confidence.
.../StructureDefinition/linkage-confidencevalueDecimal (0–1)Confidence of a link between resources.
.../StructureDefinition/legacy-idvalueStringLegacy / source identifier on Composition.section.
.../StructureDefinition/rendered-dosage-instructionvalueStringPre-rendered dosage string (R5 renderedDosageInstruction back-port).
.../StructureDefinition/abbreviationvalueStringShort/abbreviated label on lab ServiceRequest.
.../StructureDefinition/bodysite-lateralityvalueCode (bound to laterality VS)Laterality qualifier on ServiceRequest.bodySite.
.../StructureDefinition/imaging-modalityvalueCoding (bound to DCM)DICOM modality on imaging ServiceRequest.
.../StructureDefinition/imaging-viewsvalueStringRequested imaging views.
.../StructureDefinition/imaging-contrastvalueCode (contrast VS)Contrast indication on imaging ServiceRequest.
.../StructureDefinition/procedure-devicescomplex (repeating device valueString)Devices referenced by a procedure ServiceRequest.
.../StructureDefinition/return-invalueDurationFollow-up return-in duration (alt to occurrenceTiming.boundsDuration).
.../StructureDefinition/approximationvalueBooleanMarks a Duration as approximate (nested on boundsDuration).
.../StructureDefinition/prnvalueBooleanAs-needed flag on follow-up ServiceRequest.
.../StructureDefinition/weight-limitvalueQuantityWeight limit on a CarePlan activity.
.../StructureDefinition/approximate-matchvalueBooleanPatient $match approximate-match flag.

See also /interop#extensions for how downstream consumers should handle the DSP namespace.

The https://dsp-fhir.org base is illustrative. A real publication would mint these under an HL7-managed or vendor-owned canonical that commits to long-term resolution.