RIVO-Noord Zorgviewer Implementation Guide
1.15.0 - sprint58 Netherlands flag

RIVO-Noord Zorgviewer Implementation Guide - Local Development build (v1.15.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Appointment - Detailed Descriptions

Draft as of 2025-05-12

Definitions for the Appointment resource profile.

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..*
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
app-3: Only proposed or cancelled appointments can be missing start/end dates ((start.exists() and end.exists()) or (status in ('proposed' | 'cancelled')))
app-2: Either start and end are specified, or neither (start.empty() xor end.exists())
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
app-3: Only proposed or cancelled appointments can be missing start/end dates ((start.exists() and end.exists()) or (status in ('proposed' | 'cancelled')))
app-2: Either start and end are specified, or neither (start.empty() xor end.exists())
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.

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.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

Control0..1
Typeuri
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
4. Appointment.extension:PatientInstructions
Slice NamePatientInstructions
Definition

Remarks associated with the appointment that are not part of the appointment and as such are not influenced by third party edits of the appointment.

ShortContactPatientInstructions
Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(eAfspraak Appointment Patient Instructions) (Extension Type: string)
Alternate NamesContactPatiëntInstructie
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
6. Appointment.extension:OnlineEditable
Slice NameOnlineEditable
Definition

Optional Extension Element - found in all resources.

ShortOptional Extensions Element
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(eAfspraak Appointment OnlineEditable) (Complex Extension)
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
8. Appointment.extension:OnlineEditable.extension:Indicator
Slice NameIndicator
Definition

An Extension

ShortExtensionAdditional Content defined by implementations
Control0..1*
TypeExtension
Alternate NamesOnlineWijzigbaarIndicator
10. Appointment.extension:OnlineEditable.extension:Indicator.url
Definition

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

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueIndicator
12. Appointment.extension:OnlineEditable.extension:Indicator.value[x]
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

ShortValue of extension
Control0..1
Typeboolean, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
SlicingThis element introduces a set of slices on Appointment.extension.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
  • 14. Appointment.extension:OnlineEditable.extension:Indicator.value[x]:valueBoolean
    Slice NamevalueBoolean
    Definition

    Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

    ShortValue of extension
    Control0..1
    Typeboolean, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    16. Appointment.extension:OnlineEditable.extension:OnlineEditableUntil
    Slice NameOnlineEditableUntil
    Definition

    An Extension

    ShortExtensionAdditional Content defined by implementations
    Control0..1*
    TypeExtension
    Alternate NamesOnlineWijzigbaarTot
    18. Appointment.extension:OnlineEditable.extension:OnlineEditableUntil.url
    Definition

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

    Shortidentifies the meaning of the extension
    Comments

    The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

    Control1..1
    Typeuri
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed ValueOnlineEditableUntil
    20. Appointment.extension:OnlineEditable.extension:OnlineEditableUntil.value[x]
    Definition

    Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

    ShortValue of extension
    Control0..1
    TypedateTime, date, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    SlicingThis element introduces a set of slices on Appointment.extension.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
    • type @ $this
    • 22. Appointment.extension:OnlineEditable.extension:OnlineEditableUntil.value[x]:valueDateTime
      Slice NamevalueDateTime
      Definition

      Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

      ShortValue of extension
      Control0..1
      TypedateTime, date, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      24. Appointment.extension:OnlineEditable.url
      Definition

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

      Shortidentifies the meaning of the extension
      Comments

      The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

      Control1..1
      Typeuri
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      Fixed Valuehttp://nictiz.nl/fhir/StructureDefinition/eAfspraak-Appointment-OnlineEditable
      26. Appointment.extension:OnlineEditable.value[x]
      Definition

      Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

      ShortValue of extension
      Control0..01
      TypeChoice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      28. 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. Usually modifier elements provide negation or qualification. In order 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.

      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 No Modifier Reason provideed in previous versions of FHIR
      Alternate Namesextensions, user content
      30. Appointment.identifier
      Definition

      Globally unique number that identifies the instantiation of the information model. The number is composed of an identification of the issuer organization and a unique number assigned by this organization


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

      ShortIdentificationNumberExternal Ids for this item
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control10..*
      TypeIdentifier
      Summarytrue
      Alternate NamesIdentificatienummer
      32. 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.

      ShortContactStatusproposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error
      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
      (required to http://hl7.org/fhir/ValueSet/appointmentstatus)

      The free/busy status of an appointment.

      Typecode
      Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Alternate NamesContactStatus
      34. Appointment.status.extension:OrderStatus
      Slice NameOrderStatus
      Definition

      Defines a more specific coded value for a code or string. Especially useful for FHIR's required ValueSets. These extensions are primarily used on codes bound to a required value set, where you would like to use a more specific code than the codes in the bounded value set.

      ShortOrderStatus
      Control0..1
      This element is affected by the following invariants: ele-1
      TypeExtension(HCIM extension code-specification) (Extension Type: CodeableConcept)
      Alternate NamesBevat de specifieke code conform de zib, bij een FHIR-element die een verplichte koppeling heeft met een bepaalde FHIR waardelijst of een FHIR element die niet gecodeerd is gedefinieerd, terwijl de zib dit wel doet.
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      36. Appointment.status.extension:OrderStatus.url
      Definition

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

      Shortidentifies the meaning of the extension
      Comments

      The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

      Control1..1
      Typeuri
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      Fixed Valuehttp://nictiz.nl/fhir/StructureDefinition/code-specification
      38. Appointment.status.extension:OrderStatus.value[x]
      Definition

      Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

      ShortValue of extension
      Control10..1
      TypeCodeableConcept, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      SlicingThis element introduces a set of slices on Appointment.status.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
      • type @ $this
      • 40. Appointment.status.extension:OrderStatus.value[x]:valueCodeableConcept
        Slice NamevalueCodeableConcept
        Definition

        Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

        ShortValue of extension
        Control10..1
        BindingUnless not suitable, these codes SHALL be taken from For codes, see OrderStatusCodelijst
        (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.16.1.2--20171231000000)

        The status of the order.

        TypeCodeableConcept, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        42. 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 Practice Setting Code Value Sethttp://hl7.org/fhir/ValueSet/c80-practice-codes
        (preferred to http://hl7.org/fhir/ValueSet/c80-practice-codes)
        TypeCodeableConcept
        Summarytrue
        Alternate NamesSpecialisme
        SlicingThis element introduces a set of slices on Appointment.specialty. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ coding.system
        • 44. Appointment.specialty:specialtyAGB
          Slice NamespecialtyAGB
          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 SHALL be taken from The codes SHOULD be taken from SpecialismeAGBCodelijsthttp://hl7.org/fhir/ValueSet/c80-practice-codes
          (required to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.1.7--20171231000000)

          Specific specialty associated with the agency

          TypeCodeableConcept
          Summarytrue
          46. Appointment.specialty:specialtyUZI
          Slice NamespecialtyUZI
          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 SHALL be taken from The codes SHOULD be taken from SpecialismeUZICodelijsthttp://hl7.org/fhir/ValueSet/c80-practice-codes
          (required to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.1.6--20171231000000)

          Specific specialty associated with the agency

          TypeCodeableConcept
          Summarytrue
          48. Appointment.participant
          Definition

          Participants involved in appointment. These may include persons, locations and means (devices and services). The specialty and role of the healthcare provider can be entered in the HealthcareProvider building block as well.


          List of participants involved in the appointment.

          ShortContactWithParticipants involved in appointment
          Control1..*
          TypeBackboneElement
          Alternate NamesContactMet
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
          app-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() | (children().count() > id.count()))
          app-1: Either the type or actor on the participant SHALL be specified (type.exists() or actor.exists())
          50. 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 that contains it. Usually modifier elements provide negation or qualification. In order 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.

          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 No Modifier Reason provideed in previous versions of FHIR
          Summarytrue
          Alternate Namesextensions, user content, modifiers
          52. Appointment.participant.status
          Definition

          Indicated presence of the ContactParty.


          Participation status of the actor.

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

          The Participation status of an appointment.

          Typecode
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Alternate NamesContactMetStatus

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

          0. Appointment

          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..*
          Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
          dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
          app-3: Only proposed or cancelled appointments can be missing start/end dates ((start.exists() and end.exists()) or (status in ('proposed' | 'cancelled')))
          app-2: Either start and end are specified, or neither (start.empty() xor end.exists())
          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
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          4. Appointment.meta
          Definition

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

          ShortMetadata about the resource
          Control0..1
          TypeMeta
          Summarytrue
          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.

          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.

          This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

          Control0..1
          Typeuri
          Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          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
          BindingUnless not suitable, these codes SHALL be taken from Common Languages
          (extensible to http://hl7.org/fhir/ValueSet/languages)

          A human language.

          Additional BindingsPurpose
          All LanguagesMax Binding
          Typecode
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          10. Appointment.text
          Definition

          A human-readable narrative that contains a summary of the resource, and may 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 in formation is added later.

          Control0..1
          This element is affected by the following invariants: dom-1
          TypeNarrative
          Alternate Namesnarrative, html, xhtml, display
          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.

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

          An Extension

          ShortExtension
          Control0..*
          TypeExtension
          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:PatientInstructions
            Slice NamePatientInstructions
            Definition

            Remarks associated with the appointment that are not part of the appointment and as such are not influenced by third party edits of the appointment.

            ShortContactPatientInstructions
            Control0..*
            This element is affected by the following invariants: ele-1
            TypeExtension(eAfspraak Appointment Patient Instructions) (Extension Type: string)
            Alternate NamesContactPatiëntInstructie
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            18. Appointment.extension:OnlineEditable
            Slice NameOnlineEditable
            Definition

            Optional Extension Element - found in all resources.

            ShortOptional Extensions Element
            Control0..1
            This element is affected by the following invariants: ele-1
            TypeExtension(eAfspraak Appointment OnlineEditable) (Complex Extension)
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            20. Appointment.extension:OnlineEditable.id
            Definition

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

            Shortxml:id (or equivalent in JSON)
            Control0..1
            Typestring
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            22. Appointment.extension:OnlineEditable.extension
            Definition

            An Extension

            ShortExtension
            Control0..*
            TypeExtension
            SlicingThis element introduces a set of slices on Appointment.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 24. Appointment.extension:OnlineEditable.extension:Indicator
              Slice NameIndicator
              Definition

              An Extension

              ShortExtension
              Control0..1
              TypeExtension
              Alternate NamesOnlineWijzigbaarIndicator
              26. Appointment.extension:OnlineEditable.extension:Indicator.id
              Definition

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

              Shortxml:id (or equivalent in JSON)
              Control0..1
              Typestring
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              28. Appointment.extension:OnlineEditable.extension:Indicator.extension
              Definition

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

              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
              Alternate Namesextensions, user content
              SlicingThis element introduces a set of slices on Appointment.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 30. Appointment.extension:OnlineEditable.extension:Indicator.url
                Definition

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

                Shortidentifies the meaning of the extension
                Comments

                The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                Control1..1
                Typeuri
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                Fixed ValueIndicator
                32. Appointment.extension:OnlineEditable.extension:Indicator.value[x]
                Definition

                Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

                ShortValue of extension
                Control0..1
                Typeboolean
                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                SlicingThis element introduces a set of slices on Appointment.extension.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                • type @ $this
                • 34. Appointment.extension:OnlineEditable.extension:Indicator.value[x]:valueBoolean
                  Slice NamevalueBoolean
                  Definition

                  Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

                  ShortValue of extension
                  Control0..1
                  Typeboolean
                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  36. Appointment.extension:OnlineEditable.extension:OnlineEditableUntil
                  Slice NameOnlineEditableUntil
                  Definition

                  An Extension

                  ShortExtension
                  Control0..1
                  TypeExtension
                  Alternate NamesOnlineWijzigbaarTot
                  38. Appointment.extension:OnlineEditable.extension:OnlineEditableUntil.id
                  Definition

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

                  Shortxml:id (or equivalent in JSON)
                  Control0..1
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  XML FormatIn the XML format, this property is represented as an attribute.
                  40. Appointment.extension:OnlineEditable.extension:OnlineEditableUntil.extension
                  Definition

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

                  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
                  Alternate Namesextensions, user content
                  SlicingThis element introduces a set of slices on Appointment.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 42. Appointment.extension:OnlineEditable.extension:OnlineEditableUntil.url
                    Definition

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

                    Shortidentifies the meaning of the extension
                    Comments

                    The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                    Control1..1
                    Typeuri
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Fixed ValueOnlineEditableUntil
                    44. Appointment.extension:OnlineEditable.extension:OnlineEditableUntil.value[x]
                    Definition

                    Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

                    ShortValue of extension
                    Control0..1
                    TypedateTime
                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    SlicingThis element introduces a set of slices on Appointment.extension.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                    • type @ $this
                    • 46. Appointment.extension:OnlineEditable.extension:OnlineEditableUntil.value[x]:valueDateTime
                      Slice NamevalueDateTime
                      Definition

                      Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

                      ShortValue of extension
                      Control0..1
                      TypedateTime
                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      48. Appointment.extension:OnlineEditable.url
                      Definition

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

                      Shortidentifies the meaning of the extension
                      Comments

                      The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                      Control1..1
                      Typeuri
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Fixed Valuehttp://nictiz.nl/fhir/StructureDefinition/eAfspraak-Appointment-OnlineEditable
                      50. Appointment.extension:OnlineEditable.value[x]
                      Definition

                      Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

                      ShortValue of extension
                      Control0..0
                      TypeChoice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      52. 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. Usually modifier elements provide negation or qualification. In order 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.

                      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 No Modifier Reason provideed in previous versions of FHIR
                      Alternate Namesextensions, user content
                      54. Appointment.identifier
                      Definition

                      Globally unique number that identifies the instantiation of the information model. The number is composed of an identification of the issuer organization and a unique number assigned by this organization

                      ShortIdentificationNumber
                      NoteThis is a business identifier, not a resource identifier (see discussion)
                      Control1..*
                      TypeIdentifier
                      Summarytrue
                      Alternate NamesIdentificatienummer
                      56. 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.

                      ShortContactStatus
                      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)

                      The free/busy status of an appointment.

                      Typecode
                      Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Alternate NamesContactStatus
                      58. Appointment.status.id
                      Definition

                      unique id for the element within a resource (for internal references)

                      Shortxml:id (or equivalent in JSON)
                      Control0..1
                      Typestring
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      XML FormatIn the XML format, this property is represented as an attribute.
                      60. Appointment.status.extension
                      Definition

                      An Extension

                      ShortExtension
                      Control0..*
                      TypeExtension
                      SlicingThis element introduces a set of slices on Appointment.status.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 62. Appointment.status.extension:OrderStatus
                        Slice NameOrderStatus
                        Definition

                        Defines a more specific coded value for a code or string. Especially useful for FHIR's required ValueSets. These extensions are primarily used on codes bound to a required value set, where you would like to use a more specific code than the codes in the bounded value set.

                        ShortOrderStatus
                        Control0..1
                        This element is affected by the following invariants: ele-1
                        TypeExtension(HCIM extension code-specification) (Extension Type: CodeableConcept)
                        Alternate NamesBevat de specifieke code conform de zib, bij een FHIR-element die een verplichte koppeling heeft met een bepaalde FHIR waardelijst of een FHIR element die niet gecodeerd is gedefinieerd, terwijl de zib dit wel doet.
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        64. Appointment.status.extension:OrderStatus.id
                        Definition

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

                        Shortxml:id (or equivalent in JSON)
                        Control0..1
                        Typestring
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        XML FormatIn the XML format, this property is represented as an attribute.
                        66. Appointment.status.extension:OrderStatus.extension
                        Definition

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

                        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
                        Alternate Namesextensions, user content
                        SlicingThis element introduces a set of slices on Appointment.status.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 68. Appointment.status.extension:OrderStatus.url
                          Definition

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

                          Shortidentifies the meaning of the extension
                          Comments

                          The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                          Control1..1
                          Typeuri
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Fixed Valuehttp://nictiz.nl/fhir/StructureDefinition/code-specification
                          70. Appointment.status.extension:OrderStatus.value[x]
                          Definition

                          Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

                          ShortValue of extension
                          Control1..1
                          TypeCodeableConcept
                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                          SlicingThis element introduces a set of slices on Appointment.status.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                          • type @ $this
                          • 72. Appointment.status.extension:OrderStatus.value[x]:valueCodeableConcept
                            Slice NamevalueCodeableConcept
                            Definition

                            Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

                            ShortValue of extension
                            Control1..1
                            BindingUnless not suitable, these codes SHALL be taken from OrderStatusCodelijst
                            (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.16.1.2--20171231000000)

                            The status of the order.

                            TypeCodeableConcept
                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                            74. Appointment.status.value
                            Definition

                            Primitive value for code

                            ShortPrimitive value for code
                            Control0..1
                            Typecode
                            XML FormatIn the XML format, this property is represented as an attribute.
                            76. Appointment.serviceCategory
                            Definition

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

                            ShortContactCategory
                            Control0..1
                            BindingFor example codes, see ServiceCategory
                            (example to http://hl7.org/fhir/ValueSet/service-category)
                            TypeCodeableConcept
                            Summarytrue
                            Alternate NamesContactCategorie
                            78. Appointment.serviceType
                            Definition

                            Type of procedure or service that is performed or is scheduled to be performed during the contract

                            ShortContactProcedureType
                            Control0..*
                            BindingFor example codes, see ServiceType
                            (example to http://hl7.org/fhir/ValueSet/service-type)
                            TypeCodeableConcept
                            Summarytrue
                            Alternate NamesContactVerrichtingType
                            80. 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 Practice Setting Code Value Set
                            (preferred to http://hl7.org/fhir/ValueSet/c80-practice-codes)
                            TypeCodeableConcept
                            Summarytrue
                            Alternate NamesSpecialisme
                            SlicingThis element introduces a set of slices on Appointment.specialty. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ coding.system
                            • 82. Appointment.specialty:specialtyAGB
                              Slice NamespecialtyAGB
                              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 SHALL be taken from SpecialismeAGBCodelijst
                              (required to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.1.7--20171231000000)

                              Specific specialty associated with the agency

                              TypeCodeableConcept
                              Summarytrue
                              84. Appointment.specialty:specialtyAGB.id
                              Definition

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

                              Shortxml:id (or equivalent in JSON)
                              Control0..1
                              Typestring
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              XML FormatIn the XML format, this property is represented as an attribute.
                              86. Appointment.specialty:specialtyAGB.extension
                              Definition

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

                              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
                              Alternate Namesextensions, user content
                              SlicingThis element introduces a set of slices on Appointment.specialty.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ url
                              • 88. Appointment.specialty:specialtyAGB.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..*
                                TypeCoding
                                Summarytrue
                                Requirements

                                Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

                                90. Appointment.specialty:specialtyAGB.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.

                                Shortxml:id (or equivalent in JSON)
                                Control0..1
                                Typestring
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                XML FormatIn the XML format, this property is represented as an attribute.
                                92. Appointment.specialty:specialtyAGB.coding.extension
                                Definition

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

                                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
                                Alternate Namesextensions, user content
                                SlicingThis element introduces a set of slices on Appointment.specialty.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                • value @ url
                                • 94. Appointment.specialty:specialtyAGB.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 de-reference to some definition that establish the system clearly and unambiguously.

                                  Control1..1
                                  Typeuri
                                  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.

                                  Fixed Valueurn:oid:2.16.840.1.113883.2.4.6.7
                                  96. Appointment.specialty:specialtyAGB.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
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  98. Appointment.specialty:specialtyAGB.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
                                  Control0..1
                                  Typecode
                                  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.

                                  100. Appointment.specialty:specialtyAGB.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
                                  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.

                                  102. Appointment.specialty:specialtyAGB.coding.userSelected
                                  Definition

                                  Indicates that this coding was chosen by a user directly - i.e. 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
                                  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.

                                  104. Appointment.specialty:specialtyAGB.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
                                  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.

                                  106. Appointment.specialty:specialtyUZI
                                  Slice NamespecialtyUZI
                                  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 SHALL be taken from SpecialismeUZICodelijst
                                  (required to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.1.6--20171231000000)

                                  Specific specialty associated with the agency

                                  TypeCodeableConcept
                                  Summarytrue
                                  108. Appointment.specialty:specialtyUZI.id
                                  Definition

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

                                  Shortxml:id (or equivalent in JSON)
                                  Control0..1
                                  Typestring
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  XML FormatIn the XML format, this property is represented as an attribute.
                                  110. Appointment.specialty:specialtyUZI.extension
                                  Definition

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

                                  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
                                  Alternate Namesextensions, user content
                                  SlicingThis element introduces a set of slices on Appointment.specialty.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                  • value @ url
                                  • 112. Appointment.specialty:specialtyUZI.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..*
                                    TypeCoding
                                    Summarytrue
                                    Requirements

                                    Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

                                    114. Appointment.specialty:specialtyUZI.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.

                                    Shortxml:id (or equivalent in JSON)
                                    Control0..1
                                    Typestring
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    XML FormatIn the XML format, this property is represented as an attribute.
                                    116. Appointment.specialty:specialtyUZI.coding.extension
                                    Definition

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

                                    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
                                    Alternate Namesextensions, user content
                                    SlicingThis element introduces a set of slices on Appointment.specialty.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                    • value @ url
                                    • 118. Appointment.specialty:specialtyUZI.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 de-reference to some definition that establish the system clearly and unambiguously.

                                      Control1..1
                                      Typeuri
                                      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.

                                      Fixed Valuehttp://fhir.nl/fhir/NamingSystem/uzi-rolcode
                                      120. Appointment.specialty:specialtyUZI.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
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      122. Appointment.specialty:specialtyUZI.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
                                      Control0..1
                                      Typecode
                                      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.

                                      124. Appointment.specialty:specialtyUZI.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
                                      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.

                                      126. Appointment.specialty:specialtyUZI.coding.userSelected
                                      Definition

                                      Indicates that this coding was chosen by a user directly - i.e. 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
                                      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.

                                      128. Appointment.specialty:specialtyUZI.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
                                      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.

                                      130. Appointment.appointmentType
                                      Definition

                                      The type of contact.

                                      ShortContactType
                                      Comments

                                      The ContactTypeCodelijst is the ValueSet used within an eAfspraak context. A .coding from NHG Table 14 SHOULD only be used when a semantically compatible .coding from ContactTypeCodelijst is present as well, to further specify the type of contact.

                                      Control0..1
                                      BindingUnless not suitable, these codes SHALL be taken from ContactTypeCodelijst_en_NHGTable14v7-ContactType
                                      (extensible to http://nictiz.nl/fhir/ValueSet/ContactTypeCodelijst-en-NHGTable14v7-ContactType)

                                      ContactType and NHGTable14v7-ContactType

                                      TypeCodeableConcept
                                      Summarytrue
                                      Alternate NamesContactType
                                      132. Appointment.reason
                                      Definition

                                      A deviating result which serves as the reason for the contact.

                                      ShortDeviatingResult
                                      Comments

                                      The three child elements of ContactReason (Problem, Procedure and DeviatingResult) are mapped to the FHIR elements reason and indication. The container concept ContactReason is omitted in the mapping. Both FHIR elements convey the information on the reason the appointment as been scheduled to take place, either as a Reference or a CodeableConcept. This is clarified in FHIR R4 becasue the element indication is renamed to reasonReference.

                                      Control0..*
                                      BindingThe codes SHOULD be taken from Encounter Reason Codes
                                      (preferred to http://hl7.org/fhir/ValueSet/encounter-reason)

                                      The Reason for the appointment to take place.

                                      TypeCodeableConcept
                                      Summarytrue
                                      Alternate NamesAfwijkendeUitslag
                                      134. Appointment.indication
                                      Definition

                                      Reason the appointment has been scheduled to take place, as specified using information from another resource. According to the dataset, this is either a Procedure or Problem.

                                      ShortProcedure | Problem
                                      Comments

                                      The three child elements of ContactReason (Problem, Procedure and DeviatingResult) are mapped to the FHIR elements reason and indication. The container concept ContactReason is omitted in the mapping. Both FHIR elements convey the information on the reason the appointment as been scheduled to take place, either as a Reference or a CodeableConcept. This is clarified in FHIR R4 becasue the element indication is renamed to reasonReference.

                                      Control0..*
                                      TypeReference(Condition, Procedure)
                                      Alternate NamesVerrichting, Probleem
                                      136. 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
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      138. 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.

                                      ShortContactSubject
                                      Control0..1
                                      Typestring
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Alternate NamesContactOnderwerp
                                      140. Appointment.supportingInformation
                                      Definition

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

                                      ShortAdditional information to support the appointment
                                      Control0..*
                                      TypeReference(Resource)
                                      142. Appointment.start
                                      Definition

                                      The date and time at which the contact took place.

                                      ShortStartDateTime
                                      Control0..1
                                      Typeinstant
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      Alternate NamesBeginDatumTijd
                                      144. Appointment.end
                                      Definition

                                      The date and time at which the contact ended. If the contact takes place over a period of time, this indicates the end of the period, in the case of an admission, for example.

                                      ShortEndDateTime
                                      Control0..1
                                      Typeinstant
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      Alternate NamesEindDatumTijd
                                      146. Appointment.minutesDuration
                                      Definition

                                      Appointment duration. The duration of a clinical appointment usually equals the difference between EndDateTime and StartDateTime. This is usually not the case in the care, e.g. home health. In a care setting there is usually a time range, for example between 12 and 2PM, for performing certain services within a maximum timespan of e.g. 15 minutes. The difference between end and Start of the appointment may be longer than the actual appointment, for example because of an extended visit at the previous client and/or busy traffic.

                                      ShortContactDuration
                                      Control0..1
                                      TypepositiveInt
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Alternate NamesContactDuur
                                      148. 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)
                                      150. Appointment.created
                                      Definition

                                      The date/time stamp that this appointment was initially created

                                      ShortDateTime
                                      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
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Alternate NamesDatumTijd
                                      152. Appointment.comment
                                      Definition

                                      Additional description about the appointment in free text.

                                      ShortContactDescription
                                      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
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Alternate NamesContactOmschrijving
                                      154. Appointment.incomingReferral
                                      Definition

                                      Referral that is the basis for requesting an appointment or planning one. A referral is required in some contexts to be eligible for a specific type of care. In a lot of cases this referral will be from the general practitioner.

                                      ShortThe ReferralRequest provided as information to allocate to the Encounter
                                      Control0..*
                                      TypeReference(ReferralRequest)
                                      Alternate NamesVerwijzing
                                      156. Appointment.participant
                                      Definition

                                      Participants involved in appointment. These may include persons, locations and means (devices and services). The specialty and role of the healthcare provider can be entered in the HealthcareProvider building block as well.

                                      ShortContactWith
                                      Control1..*
                                      TypeBackboneElement
                                      Alternate NamesContactMet
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                      app-1: Either the type or actor on the participant SHALL be specified (type.exists() or actor.exists())
                                      158. 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.

                                      Shortxml:id (or equivalent in JSON)
                                      Control0..1
                                      Typestring
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      XML FormatIn the XML format, this property is represented as an attribute.
                                      160. Appointment.participant.extension
                                      Definition

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

                                      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
                                      Alternate Namesextensions, user content
                                      162. 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 that contains it. Usually modifier elements provide negation or qualification. In order 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.

                                      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 No Modifier Reason provideed in previous versions of FHIR
                                      Summarytrue
                                      Alternate Namesextensions, user content, modifiers
                                      164. 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
                                      Summarytrue
                                      166. Appointment.participant.type.id
                                      Definition

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

                                      Shortxml:id (or equivalent in JSON)
                                      Control0..1
                                      Typestring
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      XML FormatIn the XML format, this property is represented as an attribute.
                                      168. Appointment.participant.type.extension
                                      Definition

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

                                      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
                                      Alternate Namesextensions, user content
                                      SlicingThis element introduces a set of slices on Appointment.participant.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                      • value @ url
                                      • 170. Appointment.participant.type.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..*
                                        TypeCoding
                                        Summarytrue
                                        Requirements

                                        Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

                                        SlicingThis element introduces a set of slices on Appointment.participant.type.coding. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                        • value @ $this
                                        • 172. Appointment.participant.type.coding:healthProfessionalRole
                                          Slice NamehealthProfessionalRole
                                          Definition

                                          The role the healthcare provider fulfils in the healthcare process. For healthcare providers, this could be for example main practitioner, referrer or general practitioner.

                                          ShortHealthProfessionalRole
                                          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 ZorgverlenerRolCodelijst
                                          (required to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.1.5--20171231000000)
                                          TypeCoding
                                          Summarytrue
                                          Requirements

                                          Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

                                          Alternate NamesZorgverlenerRol
                                          174. Appointment.participant.type.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
                                          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.

                                          176. Appointment.participant.actor
                                          Definition

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

                                          ShortPerson, Location/HealthcareService or Device
                                          Control0..1
                                          TypeReference(nl-core-patient, nl-core-practitioner, nl-core-relatedperson, Device, HealthcareService, nl-core-location)
                                          Summarytrue
                                          Alternate NamesContactpersoon, Patient, Zorgverlener, Locatie
                                          178. Appointment.participant.actor.id
                                          Definition

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

                                          Shortxml:id (or equivalent in JSON)
                                          Control0..1
                                          Typestring
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          XML FormatIn the XML format, this property is represented as an attribute.
                                          180. Appointment.participant.actor.extension
                                          Definition

                                          An Extension

                                          ShortExtension
                                          Control0..*
                                          TypeExtension
                                          SlicingThis element introduces a set of slices on Appointment.participant.actor.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                          • value @ url
                                          • 182. Appointment.participant.actor.extension:practitionerRole
                                            Slice NamepractitionerRole
                                            Definition

                                            Optional Extension Element - found in all resources.

                                            ShortOptional Extensions Element
                                            Control0..1
                                            TypeExtension(PractitionerRole Reference) (Extension Type: Reference)
                                            184. Appointment.participant.actor.reference
                                            Definition

                                            A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                            ShortLiteral reference, Relative, internal or absolute URL
                                            Comments

                                            Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                            Control0..1
                                            This element is affected by the following invariants: ref-1
                                            Typestring
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Summarytrue
                                            186. Appointment.participant.actor.identifier
                                            Definition

                                            An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                                            ShortLogical reference, when literal reference is not known
                                            Comments

                                            When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                            When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                            Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                            NoteThis is a business identifier, not a resource identifier (see discussion)
                                            Control0..1
                                            TypeIdentifier
                                            Summarytrue
                                            188. Appointment.participant.actor.display
                                            Definition

                                            Plain text narrative that identifies the resource in addition to the resource reference.

                                            ShortText alternative for the resource
                                            Comments

                                            This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                                            Control0..1
                                            Typestring
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Summarytrue
                                            190. Appointment.participant.required
                                            Definition

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

                                            ShortContactWithRequired
                                            Control0..1
                                            BindingThe codes SHALL be taken from ParticipantRequired
                                            (required to http://hl7.org/fhir/ValueSet/participantrequired)

                                            Is the Participant required to attend the appointment.

                                            Typecode
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Summarytrue
                                            Alternate NamesContactMetVereist
                                            192. Appointment.participant.status
                                            Definition

                                            Indicated presence of the ContactParty.

                                            ShortContactWithStatus
                                            Control1..1
                                            BindingThe codes SHALL be taken from ParticipationStatus
                                            (required to http://hl7.org/fhir/ValueSet/participationstatus)

                                            The Participation status of an appointment.

                                            Typecode
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Alternate NamesContactMetStatus
                                            194. Appointment.requestedPeriod
                                            Definition

                                            A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. When using these values, the minutes duration should be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time.

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

                                            This does not introduce a capacity for recurring appointments.

                                            Control0..*
                                            TypePeriod