eHealth Infrastructure
3.2.0 - release

This page is part of the FUT Infrastructure (v3.2.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: ehealth-group-videoappointment - Detailed Descriptions

Active as of 2024-09-02

Definitions for the ehealth-group-videoappointment resource profile.

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

0. Appointment
Invariantsresponsible-1: Ensuring that responsible entity is a participating party ((extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible').value.reference in participant.extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam').value.reference) or (extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible').value.reference in participant.actor.reference))
max-participants: Too many intended participants (extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants').exists() implies participant.actor.where(reference.startsWith('#').not()).count() <= extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants').valueInteger)
min-participants: Too few intended participants (extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-min-participants').exists() implies participant.actor.where(reference.startsWith('#').not()).count() >= extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-min-participants').valueInteger)
2. Appointment.extension
Control1..?
SlicingThis element introduces a set of slices on Appointment.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 4. Appointment.extension:endMeetingOnEndTime
    Slice NameendMeetingOnEndTime
    Control0..1
    TypeExtension(End meeting on end time) (Extension Type: boolean)
    6. Appointment.extension:maxParticipants
    Slice NamemaxParticipants
    Control0..1
    TypeExtension(Max participants) (Extension Type: integer)
    8. Appointment.extension:meetingUrl
    Slice NamemeetingUrl
    Control0..1
    TypeExtension(Meeting URL) (Extension Type: uri)
    10. Appointment.extension:vmrUri
    Slice NamevmrUri
    Control0..1
    TypeExtension(VMR URI) (Extension Type: uri)
    12. Appointment.extension:guestPinCode
    Slice NameguestPinCode
    Control0..1
    TypeExtension(Guest PIN code) (Extension Type: string)
    14. Appointment.extension:hostPinCode
    Slice NamehostPinCode
    Control0..1
    TypeExtension(Guest PIN code) (Extension Type: string)
    16. Appointment.extension:responsible
    Slice Nameresponsible
    Control1..1
    TypeExtension(Responsible) (Extension Type: Reference(ehealth-careteam, ehealth-practitioner)referenced)
    18. Appointment.extension:groupId
    Slice NamegroupId
    Control0..1
    TypeExtension(Group id) (Extension Type: string)
    20. Appointment.extension:legalBasis
    Slice NamelegalBasis
    Control0..1
    TypeExtension(Legal basis) (Extension Type: CodeableConcept)
    Invariantsgovernance-1: When extension is used a Episode of Care MUST be referenced (%resource.supportingInformation.reference.contains('EpisodeOfCare/'))
    responsible-2: Both performing organization and responsible organization must be populated when legal basis is used (%resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization').exists() and %resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization').exists())
    22. Appointment.extension:releasableResource
    Slice NamereleasableResource
    Control0..1
    TypeExtension(Releasable resource) (Extension Type: boolean)
    24. Appointment.extension:responsibleOrganization
    Slice NameresponsibleOrganization
    Control0..1
    TypeExtension(Responsible organization) (Extension Type: Reference(ehealth-organization)referenced)
    26. Appointment.extension:performer
    Slice Nameperformer
    Control0..1
    TypeExtension(Performer) (Extension Type: Reference(ehealth-careteam, ehealth-practitioner)referenced)
    28. Appointment.extension:creator
    Slice Namecreator
    Control0..1
    TypeExtension(Creator) (Extension Type: Reference(ehealth-careteam)referenced)
    30. Appointment.extension:intendedAudience
    Slice NameintendedAudience
    Control0..*
    TypeExtension(Intended audience) (Extension Type: Reference(ehealth-organization)referenced)
    32. Appointment.extension:registrationDeadline
    Slice NameregistrationDeadline
    Control0..1
    TypeExtension(Registration deadline) (Extension Type: dateTime)
    34. Appointment.extension:performingOrganization
    Slice NameperformingOrganization
    Control0..1
    TypeExtension(Performing organization) (Extension Type: Reference(ehealth-organization)referenced)
    36. Appointment.serviceType
    Control1..?
    SlicingThis element introduces a set of slices on Appointment.serviceType. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ coding.code
    • 38. Appointment.serviceType:appointmentType
      Slice NameappointmentType
      Control1..1
      40. Appointment.serviceType:appointmentType.coding
      BindingThe codes SHALL be taken from Appointment Service Type
      (required to http://ehealth.sundhed.dk/vs/appointment-servicetype)
      42. Appointment.serviceType:appointmentType.coding.code
      Control1..?
      Fixed Valuegroup-video
      44. Appointment.appointmentType
      Control1..?
      BindingThe codes SHALL be taken from Appointment Type Codes
      (required to http://ehealth.sundhed.dk/vs/appointmenttype-codes)
      46. Appointment.reasonCode
      Control0..1
      BindingThe codes SHALL be taken from Appointment Reason
      (required to http://ehealth.sundhed.dk/vs/appointment-reason)
      48. Appointment.description
      Control1..?
      50. Appointment.supportingInformation
      Control0..1
      TypeReference(ehealth-episodeofcare, ehealth-careplan)referenced
      52. Appointment.start
      Control1..?
      54. Appointment.end
      Control1..?
      56. Appointment.participant
      58. Appointment.participant.extension
      SlicingThis element introduces a set of slices on Appointment.participant.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 60. Appointment.participant.extension:careteam
        Slice Namecareteam
        Control0..1
        TypeExtension(Careteam) (Extension Type: Reference(ehealth-careteam)referenced)
        62. Appointment.participant.extension:assigningCareteam
        Slice NameassigningCareteam
        Control0..1
        TypeExtension(Assigning careteam) (Extension Type: Reference(ehealth-careteam))
        64. Appointment.participant.actor
        TypeReference(ehealth-patient, ehealth-practitioner, ehealth-relatedperson, Location)referenced, contained

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

        0. Appointment
        Definition

        A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).

        ShortA booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
        Control0..*
        Is Modifierfalse
        Summaryfalse
        Invariantsapp-2: Either start and end are specified, or neither (start.exists() = end.exists())
        app-3: Only proposed or cancelled appointments can be missing start/end dates ((start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist')))
        app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show (Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled'))
        dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
        dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
        dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
        dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
        dom-6: A resource should have narrative for robust management (text.`div`.exists())
        responsible-1: Ensuring that responsible entity is a participating party ((extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible').value.reference in participant.extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam').value.reference) or (extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible').value.reference in participant.actor.reference))
        max-participants: Too many intended participants (extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants').exists() implies participant.actor.where(reference.startsWith('#').not()).count() <= extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants').valueInteger)
        min-participants: Too few intended participants (extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-min-participants').exists() implies participant.actor.where(reference.startsWith('#').not()).count() >= extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-min-participants').valueInteger)
        app-2: Either start and end are specified, or neither (start.exists() = end.exists())
        app-3: Only proposed or cancelled appointments can be missing start/end dates ((start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist')))
        app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show (Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled'))
        2. Appointment.implicitRules
        Definition

        A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

        ShortA set of rules under which this content was created
        Comments

        Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

        Control0..1
        Typeuri
        Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        4. Appointment.extension
        Definition

        An Extension


        May be used to represent additional information that is not part of the basic definition of the resource. 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.

        ShortExtensionAdditional 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.

        Control10..*
        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 Appointment.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 6. Appointment.extension:endMeetingOnEndTime
          Slice NameendMeetingOnEndTime
          Definition

          Indicates if a video meeting must end on end time

          ShortIndicates if a video meeting must end on end time
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(End meeting on end time) (Extension Type: boolean)
          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())
          8. Appointment.extension:maxParticipants
          Slice NamemaxParticipants
          Definition

          The maximum number of participants allowed to participate in a video meeting

          ShortThe maximum number of participants allowed to participate in a video meeting
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(Max participants) (Extension Type: integer)
          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())
          10. Appointment.extension:meetingUrl
          Slice NamemeetingUrl
          Definition

          The URL at which a video meeting will take place. Is provided by the service, not the client, and may not be updated

          ShortMeeting URL
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(Meeting URL) (Extension Type: uri)
          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())
          12. Appointment.extension:vmrUri
          Slice NamevmrUri
          Definition

          Virtual Meeting Room URI that can be used in eg. webRTC clients. Is provided by the service, not the client, and may not be updated.

          ShortVideo meeting URL
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(VMR URI) (Extension Type: uri)
          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())
          14. Appointment.extension:guestPinCode
          Slice NameguestPinCode
          Definition

          The PIN code to be used to gain access to a video meeting. Is provided by the service, not the client, and is not updateable.

          ShortGuest PIN code
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(Guest PIN code) (Extension Type: string)
          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())
          16. Appointment.extension:hostPinCode
          Slice NamehostPinCode
          Definition

          The PIN code to be used to gain access to a video meeting. Is provided by the service, not the client, and is not updateable. Host PIN must be used in order to start the meeting

          ShortHost PIN code
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(Guest PIN code) (Extension Type: string)
          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())
          18. Appointment.extension:responsible
          Slice Nameresponsible
          Definition

          Individuals, careteam and/or organization who are responsible in the given context

          ShortResponsible careteam/practitioner
          Control1..1
          This element is affected by the following invariants: ele-1
          TypeExtension(Responsible) (Extension Type: Reference(ehealth-careteam, ehealth-practitioner)referenced)
          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())
          20. Appointment.extension:groupId
          Slice NamegroupId
          Definition

          A logical id identifying a set of messages, which have the same recipient (considered a 'group message'). Must be supplied by the client, eg. as a UUID

          ShortLogical id identifying a set of messages with the same recipient
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(Group id) (Extension Type: string)
          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())
          22. Appointment.extension:legalBasis
          Slice NamelegalBasis
          Definition

          Legal basis

          ShortLegal basis
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(Legal basis) (Extension Type: CodeableConcept)
          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())
          governance-1: When extension is used a Episode of Care MUST be referenced (%resource.supportingInformation.reference.contains('EpisodeOfCare/'))
          responsible-2: Both performing organization and responsible organization must be populated when legal basis is used (%resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization').exists() and %resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization').exists())
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          24. Appointment.extension:releasableResource
          Slice NamereleasableResource
          Definition

          Indicates if the resource may be shared through national document repositories

          ShortIndicates if the resource may be shared through national document repositories
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(Releasable resource) (Extension Type: boolean)
          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())
          26. Appointment.extension:responsibleOrganization
          Slice NameresponsibleOrganization
          Definition

          Organization responsible in a given context

          ShortResponsible organization
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(Responsible organization) (Extension Type: Reference(ehealth-organization)referenced)
          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())
          28. Appointment.extension:performer
          Slice Nameperformer
          Definition

          The actual performer in an appointment, eg. teacher in a group class

          ShortPerformer
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(Performer) (Extension Type: Reference(ehealth-careteam, ehealth-practitioner)referenced)
          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())
          30. Appointment.extension:creator
          Slice Namecreator
          Definition

          Creator Careteam

          ShortCreator Careteam
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(Creator) (Extension Type: Reference(ehealth-careteam)referenced)
          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())
          32. Appointment.extension:intendedAudience
          Slice NameintendedAudience
          Definition

          Specifies that the resource is only intended for use in the specified organisations. Leave blank if the resource is intended for global use.

          ShortThe intended audience of the resource
          Control0..*
          This element is affected by the following invariants: ele-1
          TypeExtension(Intended audience) (Extension Type: Reference(ehealth-organization)referenced)
          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())
          34. Appointment.extension:registrationDeadline
          Slice NameregistrationDeadline
          Definition

          Registration deadline

          ShortRegistration deadline
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(Registration deadline) (Extension Type: dateTime)
          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())
          36. Appointment.extension:performingOrganization
          Slice NameperformingOrganization
          Definition

          Organization who is performing in the given context

          ShortOrganization who is performing in the given context
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(Performing organization) (Extension Type: Reference(ehealth-organization)referenced)
          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())
          38. Appointment.modifierExtension
          Definition

          May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

          Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

          ShortExtensions that cannot be ignored
          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 Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
          Summaryfalse
          Requirements

          Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

          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())
          40. Appointment.status
          Definition

          The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.

          Shortproposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
          Comments

          If the Appointment's status is "cancelled" then all participants are expected to have their calendars released for the appointment period, and as such any Slots that were marked as BUSY can be re-set to FREE.

          This element is labeled as a modifier because the status contains the code entered-in-error that mark the Appointment as not currently valid.

          Control1..1
          BindingThe codes SHALL be taken from AppointmentStatushttp://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1
          (required to http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1)

          The free/busy status of an appointment.

          Typecode
          Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          42. Appointment.serviceType
          Definition

          The specific service that is to be performed during this appointment.

          ShortThe specific service that is to be performed during this appointment
          Comments

          For a provider to provider appointment the code "FOLLOWUP" may be appropriate, as this is expected to be discussing some patient that was seen in the past.

          Control10..*
          BindingFor example codes, see ServiceTypehttp://hl7.org/fhir/ValueSet/service-type
          (example to http://hl7.org/fhir/ValueSet/service-type)
          TypeCodeableConcept
          Is Modifierfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          SlicingThis element introduces a set of slices on Appointment.serviceType. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ coding.code
          • 44. Appointment.serviceType:appointmentType
            Slice NameappointmentType
            Definition

            The specific service that is to be performed during this appointment.

            ShortThe specific service that is to be performed during this appointment
            Comments

            For a provider to provider appointment the code "FOLLOWUP" may be appropriate, as this is expected to be discussing some patient that was seen in the past.

            Control10..1*
            BindingFor example codes, see ServiceTypehttp://hl7.org/fhir/ValueSet/service-type
            (example to http://hl7.org/fhir/ValueSet/service-type)
            TypeCodeableConcept
            Is Modifierfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            46. Appointment.serviceType:appointmentType.coding
            Definition

            A reference to a code defined by a terminology system.

            ShortCode defined by a terminology system
            Comments

            Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

            Control0..*
            BindingThe codes SHALL be taken from For codes, see Appointment Service Type
            (required to http://ehealth.sundhed.dk/vs/appointment-servicetype)
            TypeCoding
            Is Modifierfalse
            Summarytrue
            Requirements

            Allows for alternative encodings within a code system, and translations to other code systems.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            48. Appointment.serviceType:appointmentType.coding.code
            Definition

            A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

            ShortSymbol in syntax defined by the system
            Control10..1
            Typecode
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            Need to refer to a particular code in the system.

            Fixed Valuegroup-video
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            50. Appointment.appointmentType
            Definition

            The style of appointment or patient that has been booked in the slot (not service type).

            ShortThe style of appointment or patient that has been booked in the slot (not service type)
            Control10..1
            BindingThe codes SHALL be taken from The codes SHOULD be taken from Appointment Type Codeshttp://terminology.hl7.org/ValueSet/v2-0276
            (required to http://ehealth.sundhed.dk/vs/appointmenttype-codes)
            TypeCodeableConcept
            Is Modifierfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            52. Appointment.reasonCode
            Definition

            The coded reason that this appointment is being scheduled. This is more clinical than administrative.

            ShortCoded reason this appointment is scheduled
            Control0..1*
            BindingThe codes SHALL be taken from The codes SHOULD be taken from Appointment Reasonhttp://hl7.org/fhir/ValueSet/encounter-reason
            (required to http://ehealth.sundhed.dk/vs/appointment-reason)
            TypeCodeableConcept
            Is Modifierfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            54. Appointment.description
            Definition

            The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field.

            ShortShown on a subject line in a meeting request, or appointment list
            Control10..1
            Typestring
            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()))
            56. Appointment.supportingInformation
            Definition

            Additional information to support the appointment provided when making the appointment.

            ShortAdditional information to support the appointment
            Control0..1*
            TypeReference(ehealth-episodeofcare, ehealth-careplan, Resource)referenced
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            58. Appointment.start
            Definition

            Date/Time that the appointment is to take place.

            ShortWhen appointment is to take place
            Control10..1
            Typeinstant
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            60. Appointment.end
            Definition

            Date/Time that the appointment is to conclude.

            ShortWhen appointment is to conclude
            Control10..1
            Typeinstant
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            62. Appointment.participant
            Definition

            List of participants involved in the appointment.

            ShortParticipants involved in appointment
            Control1..*
            TypeBackboneElement
            Is Modifierfalse
            Summaryfalse
            Invariantsapp-1: Either the type or actor on the participant SHALL be specified (type.exists() or actor.exists())
            ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            app-1: Either the type or actor on the participant SHALL be specified (type.exists() or actor.exists())
            64. Appointment.participant.extension
            Definition

            An Extension


            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.

            ShortExtensionAdditional 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 Appointment.participant.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 66. Appointment.participant.extension:careteam
              Slice Namecareteam
              Definition

              Careteam

              ShortCareteam
              Control0..1
              This element is affected by the following invariants: ele-1
              TypeExtension(Careteam) (Extension Type: Reference(ehealth-careteam)referenced)
              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())
              68. Appointment.participant.extension:assigningCareteam
              Slice NameassigningCareteam
              Definition

              An Extension

              ShortAssigning careteam
              Control0..1
              This element is affected by the following invariants: ele-1
              TypeExtension(Assigning careteam) (Extension Type: Reference(ehealth-careteam))
              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())
              70. Appointment.participant.modifierExtension
              Definition

              May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.

              Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

              ShortExtensions that cannot be ignored even if unrecognized
              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 Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
              Summarytrue
              Requirements

              Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

              Alternate Namesextensions, user content, modifiers
              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())
              72. Appointment.participant.actor
              Definition

              A Person, Location/HealthcareService or Device that is participating in the appointment.

              ShortPerson, Location/HealthcareService or Device
              Control0..1
              TypeReference(ehealth-patient, ehealth-practitioner, ehealth-relatedperson, Location, Patient, Practitioner, PractitionerRole, RelatedPerson, Device, HealthcareService)referenced, contained
              Is Modifierfalse
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              74. Appointment.participant.status
              Definition

              Participation status of the actor.

              Shortaccepted | declined | tentative | needs-action
              Control1..1
              BindingThe codes SHALL be taken from ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1
              (required to http://hl7.org/fhir/ValueSet/participationstatus|4.0.1)

              The Participation status of an appointment.

              Typecode
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              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. Appointment
              Definition

              A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).

              ShortA booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
              Control0..*
              Is Modifierfalse
              Summaryfalse
              Invariantsapp-2: Either start and end are specified, or neither (start.exists() = end.exists())
              app-3: Only proposed or cancelled appointments can be missing start/end dates ((start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist')))
              app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show (Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled'))
              dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
              dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
              dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
              dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
              dom-6: A resource should have narrative for robust management (text.`div`.exists())
              responsible-1: Ensuring that responsible entity is a participating party ((extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible').value.reference in participant.extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam').value.reference) or (extension('http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible').value.reference in participant.actor.reference))
              max-participants: Too many intended participants (extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants').exists() implies participant.actor.where(reference.startsWith('#').not()).count() <= extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-max-participants').valueInteger)
              min-participants: Too few intended participants (extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-min-participants').exists() implies participant.actor.where(reference.startsWith('#').not()).count() >= extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-min-participants').valueInteger)
              2. Appointment.id
              Definition

              The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

              ShortLogical id of this artifact
              Comments

              The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

              Control0..1
              Typeid
              Is Modifierfalse
              Summarytrue
              4. Appointment.meta
              Definition

              The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

              ShortMetadata about the resource
              Control0..1
              TypeMeta
              Is Modifierfalse
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              6. Appointment.implicitRules
              Definition

              A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

              ShortA set of rules under which this content was created
              Comments

              Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

              Control0..1
              Typeuri
              Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              8. Appointment.language
              Definition

              The base language in which the resource is written.

              ShortLanguage of the resource content
              Comments

              Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

              Control0..1
              BindingThe codes SHOULD be taken from CommonLanguages
              (preferred to http://hl7.org/fhir/ValueSet/languages)

              A human language.

              Additional BindingsPurpose
              AllLanguagesMax Binding
              Typecode
              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()))
              10. Appointment.text
              Definition

              A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

              ShortText summary of the resource, for human interpretation
              Comments

              Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

              Control0..1
              TypeNarrative
              Is Modifierfalse
              Summaryfalse
              Alternate Namesnarrative, html, xhtml, display
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              12. Appointment.contained
              Definition

              These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

              ShortContained, inline Resources
              Comments

              This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

              Control0..*
              TypeResource
              Is Modifierfalse
              Summaryfalse
              Alternate Namesinline resources, anonymous resources, contained resources
              14. Appointment.extension
              Definition

              An Extension

              ShortExtension
              Control1..*
              TypeExtension
              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())
              SlicingThis element introduces a set of slices on Appointment.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 16. Appointment.extension:endMeetingOnEndTime
                Slice NameendMeetingOnEndTime
                Definition

                Indicates if a video meeting must end on end time

                ShortIndicates if a video meeting must end on end time
                Control0..1
                This element is affected by the following invariants: ele-1
                TypeExtension(End meeting on end time) (Extension Type: boolean)
                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())
                18. Appointment.extension:maxParticipants
                Slice NamemaxParticipants
                Definition

                The maximum number of participants allowed to participate in a video meeting

                ShortThe maximum number of participants allowed to participate in a video meeting
                Control0..1
                This element is affected by the following invariants: ele-1
                TypeExtension(Max participants) (Extension Type: integer)
                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())
                20. Appointment.extension:meetingUrl
                Slice NamemeetingUrl
                Definition

                The URL at which a video meeting will take place. Is provided by the service, not the client, and may not be updated

                ShortMeeting URL
                Control0..1
                This element is affected by the following invariants: ele-1
                TypeExtension(Meeting URL) (Extension Type: uri)
                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())
                22. Appointment.extension:vmrUri
                Slice NamevmrUri
                Definition

                Virtual Meeting Room URI that can be used in eg. webRTC clients. Is provided by the service, not the client, and may not be updated.

                ShortVideo meeting URL
                Control0..1
                This element is affected by the following invariants: ele-1
                TypeExtension(VMR URI) (Extension Type: uri)
                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())
                24. Appointment.extension:guestPinCode
                Slice NameguestPinCode
                Definition

                The PIN code to be used to gain access to a video meeting. Is provided by the service, not the client, and is not updateable.

                ShortGuest PIN code
                Control0..1
                This element is affected by the following invariants: ele-1
                TypeExtension(Guest PIN code) (Extension Type: string)
                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())
                26. Appointment.extension:hostPinCode
                Slice NamehostPinCode
                Definition

                The PIN code to be used to gain access to a video meeting. Is provided by the service, not the client, and is not updateable. Host PIN must be used in order to start the meeting

                ShortHost PIN code
                Control0..1
                This element is affected by the following invariants: ele-1
                TypeExtension(Guest PIN code) (Extension Type: string)
                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())
                28. Appointment.extension:responsible
                Slice Nameresponsible
                Definition

                Individuals, careteam and/or organization who are responsible in the given context

                ShortResponsible careteam/practitioner
                Control1..1
                This element is affected by the following invariants: ele-1
                TypeExtension(Responsible) (Extension Type: Reference(ehealth-careteam, ehealth-practitioner)referenced)
                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())
                30. Appointment.extension:groupId
                Slice NamegroupId
                Definition

                A logical id identifying a set of messages, which have the same recipient (considered a 'group message'). Must be supplied by the client, eg. as a UUID

                ShortLogical id identifying a set of messages with the same recipient
                Control0..1
                This element is affected by the following invariants: ele-1
                TypeExtension(Group id) (Extension Type: string)
                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())
                32. Appointment.extension:legalBasis
                Slice NamelegalBasis
                Definition

                Legal basis

                ShortLegal basis
                Control0..1
                This element is affected by the following invariants: ele-1
                TypeExtension(Legal basis) (Extension Type: CodeableConcept)
                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())
                governance-1: When extension is used a Episode of Care MUST be referenced (%resource.supportingInformation.reference.contains('EpisodeOfCare/'))
                responsible-2: Both performing organization and responsible organization must be populated when legal basis is used (%resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-performing-organization').exists() and %resource.extension.where(url = 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible-organization').exists())
                34. Appointment.extension:releasableResource
                Slice NamereleasableResource
                Definition

                Indicates if the resource may be shared through national document repositories

                ShortIndicates if the resource may be shared through national document repositories
                Control0..1
                This element is affected by the following invariants: ele-1
                TypeExtension(Releasable resource) (Extension Type: boolean)
                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())
                36. Appointment.extension:responsibleOrganization
                Slice NameresponsibleOrganization
                Definition

                Organization responsible in a given context

                ShortResponsible organization
                Control0..1
                This element is affected by the following invariants: ele-1
                TypeExtension(Responsible organization) (Extension Type: Reference(ehealth-organization)referenced)
                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())
                38. Appointment.extension:performer
                Slice Nameperformer
                Definition

                The actual performer in an appointment, eg. teacher in a group class

                ShortPerformer
                Control0..1
                This element is affected by the following invariants: ele-1
                TypeExtension(Performer) (Extension Type: Reference(ehealth-careteam, ehealth-practitioner)referenced)
                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())
                40. Appointment.extension:creator
                Slice Namecreator
                Definition

                Creator Careteam

                ShortCreator Careteam
                Control0..1
                This element is affected by the following invariants: ele-1
                TypeExtension(Creator) (Extension Type: Reference(ehealth-careteam)referenced)
                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())
                42. Appointment.extension:intendedAudience
                Slice NameintendedAudience
                Definition

                Specifies that the resource is only intended for use in the specified organisations. Leave blank if the resource is intended for global use.

                ShortThe intended audience of the resource
                Control0..*
                This element is affected by the following invariants: ele-1
                TypeExtension(Intended audience) (Extension Type: Reference(ehealth-organization)referenced)
                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())
                44. Appointment.extension:registrationDeadline
                Slice NameregistrationDeadline
                Definition

                Registration deadline

                ShortRegistration deadline
                Control0..1
                This element is affected by the following invariants: ele-1
                TypeExtension(Registration deadline) (Extension Type: dateTime)
                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())
                46. Appointment.extension:performingOrganization
                Slice NameperformingOrganization
                Definition

                Organization who is performing in the given context

                ShortOrganization who is performing in the given context
                Control0..1
                This element is affected by the following invariants: ele-1
                TypeExtension(Performing organization) (Extension Type: Reference(ehealth-organization)referenced)
                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())
                48. Appointment.modifierExtension
                Definition

                May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                ShortExtensions that cannot be ignored
                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 Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
                Summaryfalse
                Requirements

                Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                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())
                50. Appointment.identifier
                Definition

                This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).

                ShortExternal Ids for this item
                NoteThis is a business identifier, not a resource identifier (see discussion)
                Control0..*
                TypeIdentifier
                Is Modifierfalse
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                52. Appointment.status
                Definition

                The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.

                Shortproposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
                Comments

                If the Appointment's status is "cancelled" then all participants are expected to have their calendars released for the appointment period, and as such any Slots that were marked as BUSY can be re-set to FREE.

                This element is labeled as a modifier because the status contains the code entered-in-error that mark the Appointment as not currently valid.

                Control1..1
                BindingThe codes SHALL be taken from AppointmentStatus
                (required to http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1)

                The free/busy status of an appointment.

                Typecode
                Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                54. Appointment.cancelationReason
                Definition

                The coded reason for the appointment being cancelled. This is often used in reporting/billing/futher processing to determine if further actions are required, or specific fees apply.

                ShortThe coded reason for the appointment being cancelled
                Control0..1
                BindingFor example codes, see AppointmentCancellationReason
                (example to http://hl7.org/fhir/ValueSet/appointment-cancellation-reason)
                TypeCodeableConcept
                Is Modifierfalse
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                56. Appointment.serviceCategory
                Definition

                A broad categorization of the service that is to be performed during this appointment.

                ShortA broad categorization of the service that is to be performed during this appointment
                Control0..*
                BindingFor example codes, see ServiceCategory
                (example to http://hl7.org/fhir/ValueSet/service-category)
                TypeCodeableConcept
                Is Modifierfalse
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                58. Appointment.serviceType
                Definition

                The specific service that is to be performed during this appointment.

                ShortThe specific service that is to be performed during this appointment
                Comments

                For a provider to provider appointment the code "FOLLOWUP" may be appropriate, as this is expected to be discussing some patient that was seen in the past.

                Control1..*
                BindingFor example codes, see ServiceType
                (example to http://hl7.org/fhir/ValueSet/service-type)
                TypeCodeableConcept
                Is Modifierfalse
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                SlicingThis element introduces a set of slices on Appointment.serviceType. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ coding.code
                • 60. Appointment.serviceType:appointmentType
                  Slice NameappointmentType
                  Definition

                  The specific service that is to be performed during this appointment.

                  ShortThe specific service that is to be performed during this appointment
                  Comments

                  For a provider to provider appointment the code "FOLLOWUP" may be appropriate, as this is expected to be discussing some patient that was seen in the past.

                  Control1..1
                  BindingFor example codes, see ServiceType
                  (example to http://hl7.org/fhir/ValueSet/service-type)
                  TypeCodeableConcept
                  Is Modifierfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  62. Appointment.serviceType:appointmentType.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
                  64. Appointment.serviceType:appointmentType.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 Appointment.serviceType.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 66. Appointment.serviceType:appointmentType.coding
                    Definition

                    A reference to a code defined by a terminology system.

                    ShortCode defined by a terminology system
                    Comments

                    Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                    Control0..*
                    BindingThe codes SHALL be taken from Appointment Service Type
                    (required to http://ehealth.sundhed.dk/vs/appointment-servicetype)
                    TypeCoding
                    Is Modifierfalse
                    Summarytrue
                    Requirements

                    Allows for alternative encodings within a code system, and translations to other code systems.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    68. Appointment.serviceType:appointmentType.coding.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
                    70. Appointment.serviceType:appointmentType.coding.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 Appointment.serviceType.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 72. Appointment.serviceType:appointmentType.coding.system
                      Definition

                      The identification of the code system that defines the meaning of the symbol in the code.

                      ShortIdentity of the terminology system
                      Comments

                      The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                      Control0..1
                      Typeuri
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      Need to be unambiguous about the source of the definition of the symbol.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      74. Appointment.serviceType:appointmentType.coding.version
                      Definition

                      The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                      ShortVersion of the system - if relevant
                      Comments

                      Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                      NoteThis is a business version Id, not a resource version Id (see discussion)
                      Control0..1
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      76. Appointment.serviceType:appointmentType.coding.code
                      Definition

                      A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                      ShortSymbol in syntax defined by the system
                      Control1..1
                      Typecode
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      Need to refer to a particular code in the system.

                      Fixed Valuegroup-video
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      78. Appointment.serviceType:appointmentType.coding.display
                      Definition

                      A representation of the meaning of the code in the system, following the rules of the system.

                      ShortRepresentation defined by the system
                      Control0..1
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      80. Appointment.serviceType:appointmentType.coding.userSelected
                      Definition

                      Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                      ShortIf this coding was chosen directly by the user
                      Comments

                      Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                      Control0..1
                      Typeboolean
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      82. Appointment.serviceType:appointmentType.text
                      Definition

                      A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                      ShortPlain text representation of the concept
                      Comments

                      Very often the text is the same as a displayName of one of the codings.

                      Control0..1
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      84. Appointment.specialty
                      Definition

                      The specialty of a practitioner that would be required to perform the service requested in this appointment.

                      ShortThe specialty of a practitioner that would be required to perform the service requested in this appointment
                      Control0..*
                      BindingThe codes SHOULD be taken from PracticeSettingCodeValueSet
                      (preferred to http://hl7.org/fhir/ValueSet/c80-practice-codes)
                      TypeCodeableConcept
                      Is Modifierfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      86. Appointment.appointmentType
                      Definition

                      The style of appointment or patient that has been booked in the slot (not service type).

                      ShortThe style of appointment or patient that has been booked in the slot (not service type)
                      Control1..1
                      BindingThe codes SHALL be taken from Appointment Type Codes
                      (required to http://ehealth.sundhed.dk/vs/appointmenttype-codes)
                      TypeCodeableConcept
                      Is Modifierfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      88. Appointment.reasonCode
                      Definition

                      The coded reason that this appointment is being scheduled. This is more clinical than administrative.

                      ShortCoded reason this appointment is scheduled
                      Control0..1
                      BindingThe codes SHALL be taken from Appointment Reason
                      (required to http://ehealth.sundhed.dk/vs/appointment-reason)
                      TypeCodeableConcept
                      Is Modifierfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      90. Appointment.reasonReference
                      Definition

                      Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.

                      ShortReason the appointment is to take place (resource)
                      Control0..*
                      TypeReference(Condition, Procedure, Observation, ImmunizationRecommendation)
                      Is Modifierfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      92. Appointment.priority
                      Definition

                      The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority).

                      ShortUsed to make informed decisions if needing to re-prioritize
                      Comments

                      Seeking implementer feedback on this property and how interoperable it is.

                      Using an extension to record a CodeableConcept for named values may be tested at a future connectathon.

                      Control0..1
                      TypeunsignedInt
                      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()))
                      94. Appointment.description
                      Definition

                      The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field.

                      ShortShown on a subject line in a meeting request, or appointment list
                      Control1..1
                      Typestring
                      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()))
                      96. Appointment.supportingInformation
                      Definition

                      Additional information to support the appointment provided when making the appointment.

                      ShortAdditional information to support the appointment
                      Control0..1
                      TypeReference(ehealth-episodeofcare, ehealth-careplan)referenced
                      Is Modifierfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      98. Appointment.start
                      Definition

                      Date/Time that the appointment is to take place.

                      ShortWhen appointment is to take place
                      Control1..1
                      Typeinstant
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      100. Appointment.end
                      Definition

                      Date/Time that the appointment is to conclude.

                      ShortWhen appointment is to conclude
                      Control1..1
                      Typeinstant
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      102. Appointment.minutesDuration
                      Definition

                      Number of minutes that the appointment is to take. This can be less than the duration between the start and end times. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end.

                      ShortCan be less than start/end (e.g. estimate)
                      Control0..1
                      TypepositiveInt
                      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()))
                      104. Appointment.slot
                      Definition

                      The slots from the participants' schedules that will be filled by the appointment.

                      ShortThe slots that this appointment is filling
                      Control0..*
                      TypeReference(Slot)
                      Is Modifierfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      106. Appointment.created
                      Definition

                      The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment.

                      ShortThe date that this appointment was initially created
                      Comments

                      This property is required for many use cases where the age of an appointment is considered in processing workflows for scheduling and billing of appointments.

                      Control0..1
                      TypedateTime
                      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()))
                      108. Appointment.comment
                      Definition

                      Additional comments about the appointment.

                      ShortAdditional comments
                      Comments

                      Additional text to aid in facilitating the appointment. For instance, a comment might be, "patient should proceed immediately to infusion room upon arrival"

                      Where this is a planned appointment and the start/end dates are not set then this field can be used to provide additional guidance on the details of the appointment request, including any restrictions on when to book it.

                      Control0..1
                      Typestring
                      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()))
                      110. Appointment.patientInstruction
                      Definition

                      While Appointment.comment contains information for internal use, Appointment.patientInstructions is used to capture patient facing information about the Appointment (e.g. please bring your referral or fast from 8pm night before).

                      ShortDetailed information and instructions for the patient
                      Control0..1
                      Typestring
                      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()))
                      112. Appointment.basedOn
                      Definition

                      The service request this appointment is allocated to assess (e.g. incoming referral or procedure request).

                      ShortThe service request this appointment is allocated to assess
                      Control0..*
                      TypeReference(ServiceRequest)
                      Is Modifierfalse
                      Summaryfalse
                      Alternate NamesincomingReferral
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      114. Appointment.participant
                      Definition

                      List of participants involved in the appointment.

                      ShortParticipants involved in appointment
                      Control1..*
                      TypeBackboneElement
                      Is Modifierfalse
                      Summaryfalse
                      Invariantsapp-1: Either the type or actor on the participant SHALL be specified (type.exists() or actor.exists())
                      ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      116. Appointment.participant.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
                      118. Appointment.participant.extension
                      Definition

                      An Extension

                      ShortExtension
                      Control0..*
                      TypeExtension
                      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())
                      SlicingThis element introduces a set of slices on Appointment.participant.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 120. Appointment.participant.extension:careteam
                        Slice Namecareteam
                        Definition

                        Careteam

                        ShortCareteam
                        Control0..1
                        This element is affected by the following invariants: ele-1
                        TypeExtension(Careteam) (Extension Type: Reference(ehealth-careteam)referenced)
                        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())
                        122. Appointment.participant.extension:assigningCareteam
                        Slice NameassigningCareteam
                        Definition

                        An Extension

                        ShortAssigning careteam
                        Control0..1
                        This element is affected by the following invariants: ele-1
                        TypeExtension(Assigning careteam) (Extension Type: Reference(ehealth-careteam))
                        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())
                        124. Appointment.participant.modifierExtension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.

                        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                        ShortExtensions that cannot be ignored even if unrecognized
                        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 Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                        Summarytrue
                        Requirements

                        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                        Alternate Namesextensions, user content, modifiers
                        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())
                        126. Appointment.participant.type
                        Definition

                        Role of participant in the appointment.

                        ShortRole of participant in the appointment
                        Comments

                        The role of the participant can be used to declare what the actor will be doing in the scope of this appointment.

                        If the actor is not specified, then it is expected that the actor will be filled in at a later stage of planning.

                        This value SHALL be the same when creating an AppointmentResponse so that they can be matched, and subsequently update the Appointment.

                        Control0..*
                        BindingUnless not suitable, these codes SHALL be taken from ParticipantType
                        (extensible to http://hl7.org/fhir/ValueSet/encounter-participant-type)

                        Role of participant in encounter.

                        TypeCodeableConcept
                        Is Modifierfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        128. Appointment.participant.actor
                        Definition

                        A Person, Location/HealthcareService or Device that is participating in the appointment.

                        ShortPerson, Location/HealthcareService or Device
                        Control0..1
                        TypeReference(ehealth-patient, ehealth-practitioner, ehealth-relatedperson, Location)referenced, contained
                        Is Modifierfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        130. Appointment.participant.required
                        Definition

                        Whether this participant is required to be present at the meeting. This covers a use-case where two doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present.

                        Shortrequired | optional | information-only
                        Control0..1
                        BindingThe codes SHALL be taken from ParticipantRequired
                        (required to http://hl7.org/fhir/ValueSet/participantrequired|4.0.1)

                        Is the Participant required to attend the appointment.

                        Typecode
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        132. Appointment.participant.status
                        Definition

                        Participation status of the actor.

                        Shortaccepted | declined | tentative | needs-action
                        Control1..1
                        BindingThe codes SHALL be taken from ParticipationStatus
                        (required to http://hl7.org/fhir/ValueSet/participationstatus|4.0.1)

                        The Participation status of an appointment.

                        Typecode
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        134. Appointment.participant.period
                        Definition

                        Participation period of the actor.

                        ShortParticipation period of the actor
                        Control0..1
                        TypePeriod
                        Is Modifierfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        136. Appointment.requestedPeriod
                        Definition

                        A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within.

                        The duration (usually in minutes) could also be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. However, in other situations the duration may be calculated by the scheduling system.

                        ShortPotential date/time interval(s) requested to allocate the appointment within
                        Comments

                        This does not introduce a capacity for recurring appointments.

                        Control0..*
                        TypePeriod
                        Is Modifierfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))