Representative Code Extension¶
| Canonical | https://fhir.apps.health/StructureDefinition/nexus-representative-code |
|---|---|
| Status | draft · 1.33.0 |
| Base | Extension (constraint) |
| Context | Coding (element) |
| Source | FSH · JSON |
This coding was chosen by the system to represent a concept that was chosen at a more general level -- a DIN standing in for the clinical drug a prescriber chose. The specific product or code is not what was chosen: a reader interprets only what the chosen concept states (for a drug, its ingredients, strength and form as the chosen concept gives them) and does not treat this code as the selection.
FSH
The authored source of truth: extensions/RepresentativeCodeExtension.fsh (edit on GitHub). One FSH file may define several related artifacts.
// RepresentativeCodeExtension.fsh
// A code the SYSTEM chose to stand in for a concept that was chosen at a more general level.
//
// WHY. A prescriber chooses a clinical drug -- ramipril 5 mg oral capsule -- and an exchange wants a
// DIN, which names one manufacturer's product. The EMR picks a DIN to carry. That DIN is not what was
// prescribed, and a reader that treats it as the choice will dispense, substitute or reconcile
// against the wrong thing. PrescribeIT defines exactly this flag
// (`http://prescribeit.ca/fhir/StructureDefinition/ext-medication-code-representative`, republished
// by CA Baseline), but declares it on `Medication.code.coding` only, so it cannot appear on
// `MedicationRequest.medicationCodeableConcept` -- where this guide's DIN slice usually sits. This
// extension carries the same meaning on any coding.
//
// SAME MEANING, NOT A REPLACEMENT. Where a Medication resource is exchanged under PrescribeIT, carry
// PrescribeIT's own extension on `Medication.code.coding` as well: its interpretation rules are
// PrescribeIT's to state. This one says the fact wherever the coding happens to be.
//
// HOW IT SITS WITH THE OTHER CODING FACTS. A representative code is not user-selected, is present for
// `conformance` (HL7 `coding-purpose`), and relates to the chosen concept as `specializes`
// (`nexus-coding-mapping`): a marketed product is a kind of the clinical drug. None of those says
// "do not treat this as the choice"; this does. See the Translated codes pattern.
Alias: $NexusRepresentativeCode = https://fhir.apps.health/StructureDefinition/nexus-representative-code
Extension: NexusRepresentativeCode
Id: nexus-representative-code
Title: "Representative Code"
Description: """
This coding was chosen by the system to represent a concept that was chosen at a more general level
-- a DIN standing in for the clinical drug a prescriber chose. The specific product or code is not
what was chosen: a reader interprets only what the chosen concept states (for a drug, its
ingredients, strength and form as the chosen concept gives them) and does not treat this code as
the selection.
Carries the meaning of PrescribeIT's representative-code extension, which is declared on
`Medication.code.coding` only, on any coding. On a Medication exchanged under PrescribeIT, carry
PrescribeIT's extension as well. A representative code SHOULD NOT be marked `userSelected = true`.
"""
* ^url = $NexusRepresentativeCode
* ^status = #draft
* ^experimental = false
* ^publisher = "WELLSTAR Technologies Corp."
* ^contact.name = "Nexus EMR FHIR Implementation Guide"
* ^contact.telecom.system = #url
* ^contact.telecom.value = "https://fhir.apps.health"
* ^jurisdiction = urn:iso:std:iso:3166#CA "Canada"
* ^context[0].type = #element
* ^context[0].expression = "Coding"
* . ^short = "This code was chosen by the system to represent a more general choice"
* value[x] only boolean
* value[x] 1..1
* valueBoolean ^short = "true: a representative code, not the choice"
* valueBoolean ^definition = "`true` says this code is a representative chosen by the system, not the concept that was chosen. `false` says it is not, and is equivalent to the extension's absence."