Skip to content

Contact by Email Tag CodeSystem Code system

Canonical../CodeSystem/contact-by-email
Statusdraft · 1.26.0
Contentcomplete
SourceFSH · JSON

Records whether outbound correspondence to a practitioner should be sent by email. Carried as a tag on Practitioner.meta.tag, where this is the tag's system.

A tag, not an extension. The address identifies the system of a Coding in meta.tag, which is why it is declared as a code system. The vocabulary is the unusual part: the codes are the literal strings true and false.

Absent means not enabled. A missing tag and the code false mean the same thing; false exists so a writer can clear the preference in place rather than remove the coding. Compare case-insensitively, and treat anything that is not true as not enabled rather than as an error.

One of five sibling systems, one per contact method. The other four are ../CodeSystem/contact-by-fax, ../CodeSystem/contact-by-hrm, ../CodeSystem/contact-by-mail and ../CodeSystem/contact-by-phone, each carrying this same true / false vocabulary under its own address. They are independent: any combination may be enabled, the set does not rank them, and the state of one says nothing about the others. They are separate systems because a writer keeps a single tag per system, replacing rather than adding, so five methods sharing one system would clear each other.

A routing preference, not a ContactPoint. Practitioner.telecom says what a practitioner's addresses are; this says which of them outbound correspondence should use. It does not assert that an email address is recorded, and it is not a consent.

This system's pre-migration address is http://services.well.com/fhir/CodeSystem/contact-by-email (FHIR-376), and it is under migration to the canonical declared here. It is named in application code but is not written onto stored Practitioner.meta.tag codings today; of the five methods, fax and Health Report Manager are the two Nexus EMR writes. Write the canonical; expect both until the migration completes. The two addresses share their final segment, but the scheme, the host and the /fhir path prefix differ, so match each exactly rather than deriving one from the other.

Code Display Definition
true Enabled Outbound correspondence to this practitioner should be sent by email.
false Not enabled Outbound correspondence to this practitioner should not be sent by email. Carries nothing an absent tag does not -- it exists so the preference can be cleared in place.