Clic Santé
1.0.0 - trial-use

This page is part of the Interoperability of Clic Santé (v1.0.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Extension: AppointmentResident - Detailed Descriptions

Active as of 2025-03-15

Definitions for the appointment-resident extension.

Guidance on how to interpret the contents of this table can be found here

0. Extension
Definition

An extension to represent the resident associated to an appointment.


Optional Extension Element - found in all resources.

ShortAppointment ResidentOptional Extensions Element
Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2. Extension.extension:firstnameInitial
Slice NamefirstnameInitial
Definition

An extension to represent the resident's firstname initial.

ShortThe resident's firstname initial
Control0..1
TypeExtension(Resident Firstname Initial) (Extension Type: string)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
4. Extension.extension:lastname
Slice Namelastname
Definition

An extension to represent the resident's lastname.

ShortThe resident's lastname
Control0..1
TypeExtension(Resident Lastname) (Extension Type: string)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
6. Extension.extension:room
Slice Nameroom
Definition

An extension to represent the resident's room number.

ShortThe resident's room number
Control0..1
TypeExtension(Resident Room Number) (Extension Type: string)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
8. Extension.extension:birthdayMonth
Slice NamebirthdayMonth
Definition

An extension to represent the resident's birthday month.

ShortThe resident's birthday month
Control0..1
TypeExtension(Resident Birthday Month) (Extension Type: string)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
10. Extension.extension:contactAlternative
Slice NamecontactAlternative
Definition

An extension to represent the alternative application to use to contact the resident.

ShortAlternative application to contact the resident
Control0..1
TypeExtension(Resident Contact Application Alternative) (Extension Type: string)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
12. Extension.extension:allowZoom
Slice NameallowZoom
Definition

An extension to represent whether the resident is allowed to be contacted via Zoom.

ShortWhether the resident allows to be contacted via Zoom
Control0..1
TypeExtension(Resident Contact Allow Zoom) (Extension Type: boolean)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
14. Extension.extension:multipleUser
Slice NamemultipleUser
Definition

An extension to represent whether there are multiple participant.

ShortWhether there is multiple participant
Control0..1
TypeExtension(Resident Multiple User) (Extension Type: boolean)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
16. Extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
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.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Valuehttp://documentation.clicsante.ca/fhir/base/StructureDefinition/appointment-resident
18. Extension.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortValue of extension
Control0..01
TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here

0. Extension
Definition

An extension to represent the resident associated to an appointment.

ShortAppointment Resident
2. Extension.extension:firstnameInitial
Slice NamefirstnameInitial
ShortThe resident's firstname initial
Control0..1
TypeExtension(Resident Firstname Initial) (Extension Type: string)
4. Extension.extension:lastname
Slice Namelastname
ShortThe resident's lastname
Control0..1
TypeExtension(Resident Lastname) (Extension Type: string)
6. Extension.extension:room
Slice Nameroom
ShortThe resident's room number
Control0..1
TypeExtension(Resident Room Number) (Extension Type: string)
8. Extension.extension:birthdayMonth
Slice NamebirthdayMonth
ShortThe resident's birthday month
Control0..1
TypeExtension(Resident Birthday Month) (Extension Type: string)
10. Extension.extension:contactAlternative
Slice NamecontactAlternative
ShortAlternative application to contact the resident
Control0..1
TypeExtension(Resident Contact Application Alternative) (Extension Type: string)
12. Extension.extension:allowZoom
Slice NameallowZoom
ShortWhether the resident allows to be contacted via Zoom
Control0..1
TypeExtension(Resident Contact Allow Zoom) (Extension Type: boolean)
14. Extension.extension:multipleUser
Slice NamemultipleUser
ShortWhether there is multiple participant
Control0..1
TypeExtension(Resident Multiple User) (Extension Type: boolean)
16. Extension.url
Fixed Valuehttp://documentation.clicsante.ca/fhir/base/StructureDefinition/appointment-resident
18. Extension.value[x]
Control0..0

Guidance on how to interpret the contents of this table can be found here

0. Extension
Definition

An extension to represent the resident associated to an appointment.

ShortAppointment Resident
Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2. Extension.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
4. Extension.extension
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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. Extension.extension:firstnameInitial
    Slice NamefirstnameInitial
    Definition

    An extension to represent the resident's firstname initial.

    ShortThe resident's firstname initial
    Control0..1
    TypeExtension(Resident Firstname Initial) (Extension Type: string)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    8. Extension.extension:lastname
    Slice Namelastname
    Definition

    An extension to represent the resident's lastname.

    ShortThe resident's lastname
    Control0..1
    TypeExtension(Resident Lastname) (Extension Type: string)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    10. Extension.extension:room
    Slice Nameroom
    Definition

    An extension to represent the resident's room number.

    ShortThe resident's room number
    Control0..1
    TypeExtension(Resident Room Number) (Extension Type: string)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    12. Extension.extension:birthdayMonth
    Slice NamebirthdayMonth
    Definition

    An extension to represent the resident's birthday month.

    ShortThe resident's birthday month
    Control0..1
    TypeExtension(Resident Birthday Month) (Extension Type: string)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    14. Extension.extension:contactAlternative
    Slice NamecontactAlternative
    Definition

    An extension to represent the alternative application to use to contact the resident.

    ShortAlternative application to contact the resident
    Control0..1
    TypeExtension(Resident Contact Application Alternative) (Extension Type: string)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    16. Extension.extension:allowZoom
    Slice NameallowZoom
    Definition

    An extension to represent whether the resident is allowed to be contacted via Zoom.

    ShortWhether the resident allows to be contacted via Zoom
    Control0..1
    TypeExtension(Resident Contact Allow Zoom) (Extension Type: boolean)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    18. Extension.extension:multipleUser
    Slice NamemultipleUser
    Definition

    An extension to represent whether there are multiple participant.

    ShortWhether there is multiple participant
    Control0..1
    TypeExtension(Resident Multiple User) (Extension Type: boolean)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    20. Extension.url
    Definition

    Source of the definition for the extension code - a logical name or a URL.

    Shortidentifies the meaning of the extension
    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.

    Control1..1
    Typeuri
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    Fixed Valuehttp://documentation.clicsante.ca/fhir/base/StructureDefinition/appointment-resident
    22. Extension.value[x]
    Definition

    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

    ShortValue of extension
    Control0..0
    TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))