Skip to content

Appointment Modality Extension

Canonical../StructureDefinition/nexus-emr-appointment-modality-extension
Statusdraft (experimental) · 1.26.0
BaseExtension (constraint)
ContextAppointment (element)
SourceFSH · JSON

Delivery channel of an appointment/encounter (in-person | video | telephone | secure message). A distinct axis from appointmentType (booking style); R5 models this as Appointment.virtualService. Value is CodeableConcept so a source/raw code and a normalized Nexus code co-exist; the binding is extensible so a future pan-Canadian/Ontario code can be added as a parallel coding.

Elements / Details

Every element this profile touches, with its full definition. Element names in the tables link here.

Extension

Short Appointment/encounter delivery channel (modality)
Definition The delivery channel of the appointment or encounter: how the patient and provider meet, as distinct from what service is delivered (serviceType) or how the slot was booked (appointmentType). Mapping onto an Encounter. Where the encounter is recorded, in-person becomes Encounter.class AMB; video, telephone and secure-message all become VR (http://terminology.hl7.org/CodeSystem/v3-ActCode). Encounter.class is bound, not fixed, precisely so this mapping can be honoured: writing AMB for a video consult asserts the visit happened in the room. Populate the normalized coding from NexusEmrAppointmentModalityVS. When the source EMR carries its own raw modality code (e.g. Oscar appointment.type = 'Telephone'), converters SHOULD ALSO carry that raw code as an additional coding on the same CodeableConcept, using the raw-code NamingSystem fallback ../NamingSystem/<instance-id>-appointment-modality-raw-code.
Cardinality 0..*
Invariants ele-1, ext-1

Extension.id

Short Unique id for inter-element referencing
Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality 0..1
Type http://hl7.org/fhirpath/System.String

Extension.extension

Short Additional content defined by implementations
Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Cardinality 0..0
Type Extension
Invariants ele-1, ext-1
Also called extensions, user content

Extension.url

Short identifies the meaning of the extension
Definition Source of the definition for the extension code - a logical name or a URL.
Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Cardinality 1..1
Type http://hl7.org/fhirpath/System.String
Fixed value ../StructureDefinition/nexus-emr-appointment-modality-extension

Extension.value[x]

Short Modality: normalized Nexus coding; source/raw coding MAY accompany it
Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Cardinality 1..1
Type CodeableConcept
Must Support yes
Binding Appointment Modality Value Set (extensible)
Invariants ele-1