Appointment Ocean Sent Tag CodeSystem Code system¶
| Canonical | ../CodeSystem/appointment-ocean-sent |
|---|---|
| Status | draft · 1.26.0 |
| Content | complete |
| Source | FSH · JSON |
Records that an appointment has been sent to the Ocean eReferral integration. Carried as a tag on
Appointment.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 sent. A missing tag and the code false mean the same thing to a reader. The
marker is written only after a send returns successfully; a refused or failed send leaves the
appointment untagged so it can be retried.
Match the code exactly, in lower case. The reader compares the code to true character for
character, so True is not read as sent. This is stricter than the sibling system below, whose
reader parses the code as a boolean and tolerates any casing -- a writer that emits lower case
satisfies both.
It selects the outbound event shape. An appointment not yet marked is sent as a new appointment; one already marked is sent as an update to the appointment the receiving system already knows. It is also read to drop a duplicate send for the same appointment.
It is a send marker, not a delivery receipt. It records that the send was made and was not refused. It does not say the receiving system processed or accepted the record, and it carries no time.
It says nothing about the appointment. No clinical or scheduling fact follows from it, and the appointment's own status is unaffected by whether a send has happened.
One of two sibling systems, one per outbound integration. The other is
../CodeSystem/appointment-acdr-arrived, which carries this same true /
false vocabulary under its own address; a third integration would be a third system. They are
separate because a writer keeps a single tag per system, replacing rather than adding, so two send
markers sharing one system would erase each other. Read one for the state of one integration only:
neither implies anything about the other.
Nexus EMR writes this today at
http://services.well.com/fhir/tags/appointment/ocean-sent (FHIR-378): it is live in stored
Appointment.meta.tag codings and in code, and is under migration to the canonical declared here.
Write the canonical; expect both until the migration completes, and match both addresses exactly
rather than deriving one from the other -- the final segment differs between them, not only the
host.
| Code | Display | Definition |
|---|---|---|
true |
Sent | The appointment has been sent to the Ocean eReferral integration and the send was not refused. A later change to the appointment is sent as an update to the appointment already kn… |
false |
Not sent | The appointment has not been sent. Carries nothing an absent tag does not -- a reader should treat it exactly as an absent tag. |