Da Vinci - Coverage Requirements Discovery
2.2.0-snapshot - STU 2.2 Peer Review United States of America flag

Da Vinci - Coverage Requirements Discovery, published by HL7 International / Financial Management. This guide is not an authorized publication; it is the continuous build for version 2.2.0-snapshot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-crd/ and changes regularly. See the Directory of published versions

Resource Profile: CRD Appointment without Order - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 1

Definitions for the profile-appointment-no-order resource profile

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

0. Appointment
Definition

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

ShortA booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
Control0..*
Is Modifierfalse
Summaryfalse
Invariantsapp-2: Either start and end are specified, or neither (start.exists() = end.exists())
app-3: Only proposed or cancelled appointments can be missing start/end dates ((start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist')))
app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show (Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled'))
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
crd-apt1: Must have either start or requestedPeriod.start (start.exists() or requestedPeriod.start.exists())
crd-apt2: Must have either end or requestedPeriod.end (end.exists() or requestedPeriod.end.exists())
app-2: Either start and end are specified, or neither (start.exists() = end.exists())
app-3: Only proposed or cancelled appointments can be missing start/end dates ((start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist')))
app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show (Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled'))
2. Appointment.implicitRules
Definition

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

ShortA set of rules under which this content was created
Comments

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

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

Any references found in this resource, with the exception of 'Patient' could potentially be resource-specific and thus transmitted as contained resources.


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

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

An Extension


May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortExtensionAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

    Indicates coverage information.

    ShortCoverageInfo
    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(Coverage Information) (Complex Extension)
    Is Modifierfalse
    Must Supporttrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    crd-ci-q1: Questionnaire is only allowed when doc-needed exists (extension.where(url='questionnaire').exists() implies extension.where(url = 'doc-needed').exists())
    crd-ci-q2: If covered is set to 'not-covered', then 'pa-needed' must not exist. (extension.where(url = 'covered' and value = 'not-covered').exists() implies extension.where(url = 'pa-needed').exists().not())
    crd-ci-q3: 'info-needed' SHALL exist if and only if at least one of 'covered', 'pa-needed', or 'doc-needed' is set to 'conditional'. (extension.where((url = 'covered' or url = 'pa-needed' or url = 'doc-needed') and value = 'conditional').count() >= 1 implies extension.where(url = 'info-needed').exists())
    crd-ci-q4: If 'pa-needed' is 'satisfied', 'noauth', or 'not-covered', then 'Doc-purpose' cannot be 'withpa'. (extension.where(url = 'pa-needed' and (value = 'satisfied' or value = 'noauth' or value = 'not-covered')) and extension.where(url = 'doc-purpose').exists() implies extension.where(url = 'doc-purpose').all(value != 'withpa'))
    crd-ci-q5: 'satisfied-pa-id' must exist if and only if 'pa-needed' is set to 'satisfied'. (extension.where(url = 'pa-needed' and value = 'satisfied').exists() = extension.where(url = 'satisfied-pa-id').exists())
    crd-ci-q6: If 'info-needed' is OTH, then reason must be specified (extension.where(url = 'info-needed' and value = 'OTH').exists() implies extension.where(url = 'reason').exists())
    crd-ci-q7: If reason.coding is present and is not from the extensible value set, then reason.text must be present (extension.where(url = 'reason').empty() or extension.where(url = 'reason').value.text.exists() or extension.where(url = 'reason').value.memberOf('http://hl7.org/fhir/us/davinci-crd/ValueSet/coverageAssertionReasons'))
    crd-ci-q8: If doc-purpose is present with a value other than 'conditional', then reason must be present (extension.where(url = 'doc-purpose' and value != 'conditional').exists() implies extension.where(url = 'reason').exists())
    10. Appointment.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

    ShortExtensions that cannot be ignored
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
    Summaryfalse
    Requirements

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

    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    12. Appointment.identifier
    Definition

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

    ShortExternal Ids for this item
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..*
    TypeIdentifier
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    14. 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.

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

    This will be 'proposed' when using an initial appointment-book, but may be 'booked' or other values for appointment-book representing edits to the appointment.


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

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

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

    The free/busy status of an appointment.

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

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

    ShortA broad categorization of the service that is to be performed during this appointment
    Control0..*
    BindingFor example codes, see ServiceCategoryhttp://hl7.org/fhir/ValueSet/service-category|4.0.1
    (example to http://hl7.org/fhir/ValueSet/service-category|4.0.1)
    TypeCodeableConcept
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    SlicingThis element introduces a set of slices on Appointment.serviceCategory. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ $this
    • 18. Appointment.serviceCategory:us-core
      Slice Nameus-core
      Definition

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

      ShortA broad categorization of the service that is to be performed during this appointment
      Control0..*
      BindingThe codes SHALL be taken from For example codes, see USCoreServiceRequestCategoryCodes (7.0.0)http://hl7.org/fhir/ValueSet/service-category|4.0.1
      (required to http://hl7.org/fhir/us/core/ValueSet/us-core-servicerequest-category|7.0.0)
      TypeCodeableConcept
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      20. Appointment.serviceCategory:encounterType
      Slice NameencounterType
      Definition

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

      Shortinpatient, outpatient, etc.A broad categorization of the service that is to be performed during this appointment
      Control0..1*
      BindingThe codes SHALL be taken from For example codes, see ActEncounterCode (3.0.0)http://hl7.org/fhir/ValueSet/service-category|4.0.1
      (required to http://terminology.hl7.org/ValueSet/v3-ActEncounterCode|3.0.0)
      TypeCodeableConcept
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      22. Appointment.serviceCategory:serviceType
      Slice NameserviceType
      Definition

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

      ShortX-ray, Lab, consulation, surgical, etc.A broad categorization of the service that is to be performed during this appointment
      Control0..1*
      BindingThe codes SHALL be taken from For example codes, see X12 Service Typehttp://hl7.org/fhir/ValueSet/service-category|4.0.1
      (required to http://hl7.org/fhir/us/davinci-crd/ValueSet/X12ServiceType)
      TypeCodeableConcept
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      24. Appointment.serviceType
      Definition

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

      ShortCodes to identify requested services. (CPT, SNOMED CT or LOINC)The specific service that is to be performed during this appointment
      Comments

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

      Control0..*
      BindingUnless not suitable, these codes SHALL be taken from For example codes, see CRD Service Request Codes Value Sethttp://hl7.org/fhir/ValueSet/service-type|4.0.1
      (extensible to http://hl7.org/fhir/us/davinci-crd/ValueSet/serviceRequestCodes)

      Codes describing the type of Service

      TypeCodeableConcept
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      26. Appointment.serviceType.extension:BillingOptions
      Slice NameBillingOptions
      Definition

      Identifies billing codes that could potentially be used for this clinical code

      ShortExpected Billing Code(s)
      Comments

      This will typically only be populated if the ordering and performing systems are the same

      Control0..*
      TypeExtension(Billing Options) (Extension Type: CodeableConcept)
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      28. 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 PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codes|4.0.1
      (preferred to http://hl7.org/fhir/ValueSet/c80-practice-codes|4.0.1)
      TypeCodeableConcept
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      30. Appointment.appointmentType
      Definition

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

      ShortThe style of appointment or patient that has been booked in the slot (not service type)
      Control0..1
      BindingThe codes SHOULD be taken from hl7VS-appointmentReasonCodeshttp://terminology.hl7.org/ValueSet/v2-0276
      (preferred to http://terminology.hl7.org/ValueSet/v2-0276)
      TypeCodeableConcept
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      32. Appointment.reasonReference
      Definition

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

      ShortReason the appointment is to take place (resource)
      Comments

      Potentially relevant for CRD in some situations.

      Control0..*
      TypeReference(Condition, Procedure, Observation, ImmunizationRecommendation)
      Is Modifierfalse
      Must Supporttrue
      Must Support TypesNo must-support rules about the choice of types/profiles
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      34. Appointment.start
      Definition

      Date/Time that the appointment is to take place.

      ShortWhen appointment is to take place
      Control0..1
      This element is affected by the following invariants: crd-apt1
      Typeinstant
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      36. Appointment.end
      Definition

      Date/Time that the appointment is to conclude.

      ShortWhen appointment is to conclude
      Control0..1
      This element is affected by the following invariants: crd-apt2
      Typeinstant
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      38. Appointment.participant
      Definition

      List of participants involved in the appointment.

      ShortParticipants involved in appointment
      Control21..*
      TypeBackboneElement
      Is Modifierfalse
      Summaryfalse
      Invariantsapp-1: Either the type or actor on the participant SHALL be specified (type.exists() or actor.exists())
      ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      app-1: Either the type or actor on the participant SHALL be specified (type.exists() or actor.exists())
      SlicingThis element introduces a set of slices on Appointment.participant. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ type
      • profile @ actor.resolve()
      • 40. Appointment.participant.modifierExtension
        Definition

        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

        ShortExtensions that cannot be ignored even if unrecognized
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

        Control0..*
        TypeExtension
        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
        Summarytrue
        Requirements

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

        Alternate Namesextensions, user content, modifiers
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        42. Appointment.participant.actor
        Definition

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

        ShortPerson, Location/HealthcareService or Device
        Control0..1
        TypeReference(Patient, Practitioner, PractitionerRole, RelatedPerson, Device, HealthcareService, Location)
        Is Modifierfalse
        Must Supporttrue
        Must Support TypesNo must-support rules about the choice of types/profiles
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        44. Appointment.participant.status
        Definition

        Participation status of the actor.

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

        The Participation status of an appointment.

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

        List of participants involved in the appointment.

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

        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

        ShortExtensions that cannot be ignored even if unrecognized
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

        Control0..*
        TypeExtension
        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
        Summarytrue
        Requirements

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

        Alternate Namesextensions, user content, modifiers
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        50. Appointment.participant:Patient.actor
        Definition

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

        ShortPerson, Location/HealthcareService or Device
        Control0..1
        TypeReference(CRD Patient, Patient, Practitioner, PractitionerRole, RelatedPerson, Device, HealthcareService, Location)
        Is Modifierfalse
        Must Supporttrue
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        52. Appointment.participant:Patient.status
        Definition

        Participation status of the actor.

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

        The Participation status of an appointment.

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

        List of participants involved in the appointment.

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

        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

        ShortExtensions that cannot be ignored even if unrecognized
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

        Control0..*
        TypeExtension
        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
        Summarytrue
        Requirements

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

        Alternate Namesextensions, user content, modifiers
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        58. Appointment.participant:PrimaryPerformer.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.

        Control10..1*
        BindingUnless not suitable, these codes SHALL be taken from ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type|4.0.1
        (extensible to http://hl7.org/fhir/ValueSet/encounter-participant-type|4.0.1)

        Role of participant in encounter.

        TypeCodeableConcept
        Is Modifierfalse
        Summarytrue
        Pattern Value{
          "coding" : [{
            "system" : "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
            "code" : "PPRF"
          }]
        }
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        60. Appointment.participant:PrimaryPerformer.actor
        Definition

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

        ShortPerson, Location/HealthcareService or Device
        Control0..1
        TypeReference(CRD Practitioner, HRex PractitionerRole Profile, CRD Location, Patient, Practitioner, PractitionerRole, RelatedPerson, Device, HealthcareService, Location)
        Is Modifierfalse
        Must Supporttrue
        Must Support TypesNo must-support rules about the choice of types/profiles
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        62. Appointment.participant:PrimaryPerformer.status
        Definition

        Participation status of the actor.

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

        The Participation status of an appointment.

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

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

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

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

        This does not introduce a capacity for recurring appointments.

        Control0..1*
        This element is affected by the following invariants: crd-apt1, crd-apt2
        TypePeriod
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

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

        0. Appointment
        2. Appointment.extension
        SlicingThis element introduces a set of slices on Appointment.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 4. Appointment.extension:Coverage-Information
          Slice NameCoverage-Information
          Control0..*
          TypeExtension(Coverage Information) (Complex Extension)
          Must Supporttrue
          6. Appointment.identifier
          NoteThis is a business identifier, not a resource identifier (see discussion)
          Must Supporttrue
          8. Appointment.serviceCategory
          Must Supporttrue
          SlicingThis element introduces a set of slices on Appointment.serviceCategory. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ $this
          • 10. Appointment.serviceCategory:us-core
            Slice Nameus-core
            Control0..*
            BindingThe codes SHALL be taken from USCoreServiceRequestCategoryCodes (7.0.0)
            (required to http://hl7.org/fhir/us/core/ValueSet/us-core-servicerequest-category|7.0.0)
            Must Supporttrue
            12. Appointment.serviceCategory:encounterType
            Slice NameencounterType
            Shortinpatient, outpatient, etc.
            Control0..1
            BindingThe codes SHALL be taken from ActEncounterCode (3.0.0)
            (required to http://terminology.hl7.org/ValueSet/v3-ActEncounterCode|3.0.0)
            Must Supporttrue
            14. Appointment.serviceCategory:serviceType
            Slice NameserviceType
            ShortX-ray, Lab, consulation, surgical, etc.
            Control0..1
            BindingThe codes SHALL be taken from X12 Service Type
            (required to http://hl7.org/fhir/us/davinci-crd/ValueSet/X12ServiceType)
            Must Supporttrue
            16. Appointment.serviceType
            ShortCodes to identify requested services. (CPT, SNOMED CT or LOINC)
            BindingUnless not suitable, these codes SHALL be taken from CRD Service Request Codes Value Set
            (extensible to http://hl7.org/fhir/us/davinci-crd/ValueSet/serviceRequestCodes)

            Codes describing the type of Service

            Must Supporttrue
            18. Appointment.serviceType.extension:BillingOptions
            Slice NameBillingOptions
            ShortExpected Billing Code(s)
            Control0..*
            TypeExtension(Billing Options) (Extension Type: CodeableConcept)
            Must Supporttrue
            20. Appointment.specialty
            Must Supporttrue
            22. Appointment.appointmentType
            Must Supporttrue
            24. Appointment.reasonReference
            Comments

            Potentially relevant for CRD in some situations.

            Must Supporttrue

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

            0. Appointment
            Definition

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

            ShortA booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
            Control0..*
            Is Modifierfalse
            Summaryfalse
            Invariantsapp-2: Either start and end are specified, or neither (start.exists() = end.exists())
            app-3: Only proposed or cancelled appointments can be missing start/end dates ((start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist')))
            app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show (Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled'))
            dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
            dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
            dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
            dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
            dom-6: A resource should have narrative for robust management (text.`div`.exists())
            crd-apt1: Must have either start or requestedPeriod.start (start.exists() or requestedPeriod.start.exists())
            crd-apt2: Must have either end or requestedPeriod.end (end.exists() or requestedPeriod.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
            Is Modifierfalse
            Summarytrue
            4. Appointment.meta
            Definition

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

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

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

            ShortA set of rules under which this content was created
            Comments

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

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

            The base language in which the resource is written.

            ShortLanguage of the resource content
            Comments

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

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

            A human language.

            Additional BindingsPurpose
            AllLanguagesMax Binding
            Typecode
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            10. Appointment.text
            Definition

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

            ShortText summary of the resource, for human interpretation
            Comments

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

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

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

            ShortContained, inline Resources
            Comments

            Any references found in this resource, with the exception of 'Patient' could potentially be resource-specific and thus transmitted as contained resources.

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

            An Extension

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

              Indicates coverage information.

              ShortCoverageInfo
              Control0..*
              This element is affected by the following invariants: ele-1
              TypeExtension(Coverage Information) (Complex Extension)
              Is Modifierfalse
              Must Supporttrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              crd-ci-q1: Questionnaire is only allowed when doc-needed exists (extension.where(url='questionnaire').exists() implies extension.where(url = 'doc-needed').exists())
              crd-ci-q2: If covered is set to 'not-covered', then 'pa-needed' must not exist. (extension.where(url = 'covered' and value = 'not-covered').exists() implies extension.where(url = 'pa-needed').exists().not())
              crd-ci-q3: 'info-needed' SHALL exist if and only if at least one of 'covered', 'pa-needed', or 'doc-needed' is set to 'conditional'. (extension.where((url = 'covered' or url = 'pa-needed' or url = 'doc-needed') and value = 'conditional').count() >= 1 implies extension.where(url = 'info-needed').exists())
              crd-ci-q4: If 'pa-needed' is 'satisfied', 'noauth', or 'not-covered', then 'Doc-purpose' cannot be 'withpa'. (extension.where(url = 'pa-needed' and (value = 'satisfied' or value = 'noauth' or value = 'not-covered')) and extension.where(url = 'doc-purpose').exists() implies extension.where(url = 'doc-purpose').all(value != 'withpa'))
              crd-ci-q5: 'satisfied-pa-id' must exist if and only if 'pa-needed' is set to 'satisfied'. (extension.where(url = 'pa-needed' and value = 'satisfied').exists() = extension.where(url = 'satisfied-pa-id').exists())
              crd-ci-q6: If 'info-needed' is OTH, then reason must be specified (extension.where(url = 'info-needed' and value = 'OTH').exists() implies extension.where(url = 'reason').exists())
              crd-ci-q7: If reason.coding is present and is not from the extensible value set, then reason.text must be present (extension.where(url = 'reason').empty() or extension.where(url = 'reason').value.text.exists() or extension.where(url = 'reason').value.memberOf('http://hl7.org/fhir/us/davinci-crd/ValueSet/coverageAssertionReasons'))
              crd-ci-q8: If doc-purpose is present with a value other than 'conditional', then reason must be present (extension.where(url = 'doc-purpose' and value != 'conditional').exists() implies extension.where(url = 'reason').exists())
              18. Appointment.modifierExtension
              Definition

              May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

              ShortExtensions that cannot be ignored
              Comments

              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

              Control0..*
              TypeExtension
              Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
              Summaryfalse
              Requirements

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

              Alternate Namesextensions, user content
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              20. Appointment.identifier
              Definition

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

              ShortExternal Ids for this item
              NoteThis is a business identifier, not a resource identifier (see discussion)
              Control0..*
              TypeIdentifier
              Is Modifierfalse
              Must Supporttrue
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              22. 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.

              ShortAppointment status
              Comments

              This will be 'proposed' when using an initial appointment-book, but may be 'booked' or other values for appointment-book representing edits to the appointment.

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

              The free/busy status of an appointment.

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

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

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

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

              ShortA broad categorization of the service that is to be performed during this appointment
              Control0..*
              BindingFor example codes, see ServiceCategory
              (example to http://hl7.org/fhir/ValueSet/service-category|4.0.1)
              TypeCodeableConcept
              Is Modifierfalse
              Must Supporttrue
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              SlicingThis element introduces a set of slices on Appointment.serviceCategory. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ $this
              • 28. Appointment.serviceCategory:us-core
                Slice Nameus-core
                Definition

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

                ShortA broad categorization of the service that is to be performed during this appointment
                Control0..*
                BindingThe codes SHALL be taken from USCoreServiceRequestCategoryCodes (7.0.0)
                (required to http://hl7.org/fhir/us/core/ValueSet/us-core-servicerequest-category|7.0.0)
                TypeCodeableConcept
                Is Modifierfalse
                Must Supporttrue
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                30. Appointment.serviceCategory:encounterType
                Slice NameencounterType
                Definition

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

                Shortinpatient, outpatient, etc.
                Control0..1
                BindingThe codes SHALL be taken from ActEncounterCode (3.0.0)
                (required to http://terminology.hl7.org/ValueSet/v3-ActEncounterCode|3.0.0)
                TypeCodeableConcept
                Is Modifierfalse
                Must Supporttrue
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                32. Appointment.serviceCategory:serviceType
                Slice NameserviceType
                Definition

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

                ShortX-ray, Lab, consulation, surgical, etc.
                Control0..1
                BindingThe codes SHALL be taken from X12 Service Type
                (required to http://hl7.org/fhir/us/davinci-crd/ValueSet/X12ServiceType)
                TypeCodeableConcept
                Is Modifierfalse
                Must Supporttrue
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                34. Appointment.serviceType
                Definition

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

                ShortCodes to identify requested services. (CPT, SNOMED CT or LOINC)
                Comments

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

                Control0..*
                BindingUnless not suitable, these codes SHALL be taken from CRD Service Request Codes Value Set
                (extensible to http://hl7.org/fhir/us/davinci-crd/ValueSet/serviceRequestCodes)

                Codes describing the type of Service

                TypeCodeableConcept
                Is Modifierfalse
                Must Supporttrue
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                36. Appointment.serviceType.id
                Definition

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

                ShortUnique id for inter-element referencing
                Control0..1
                Typestring
                Is Modifierfalse
                XML FormatIn the XML format, this property is represented as an attribute.
                Summaryfalse
                38. Appointment.serviceType.extension
                Definition

                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                ShortAdditional content defined by implementations
                Comments

                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

                  Identifies billing codes that could potentially be used for this clinical code

                  ShortExpected Billing Code(s)
                  Comments

                  This will typically only be populated if the ordering and performing systems are the same

                  Control0..*
                  TypeExtension(Billing Options) (Extension Type: CodeableConcept)
                  Is Modifierfalse
                  Must Supporttrue
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  42. Appointment.serviceType.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
                  Is Modifierfalse
                  Summarytrue
                  Requirements

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

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

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

                  ShortPlain text representation of the concept
                  Comments

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

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

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

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

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

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

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

                  ShortThe style of appointment or patient that has been booked in the slot (not service type)
                  Control0..1
                  BindingThe codes SHOULD be taken from hl7VS-appointmentReasonCodes
                  (preferred to http://terminology.hl7.org/ValueSet/v2-0276)
                  TypeCodeableConcept
                  Is Modifierfalse
                  Must Supporttrue
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  50. Appointment.reasonCode
                  Definition

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

                  ShortCoded reason this appointment is scheduled
                  Control0..*
                  BindingThe codes SHOULD be taken from EncounterReasonCodes
                  (preferred to http://hl7.org/fhir/ValueSet/encounter-reason|4.0.1)

                  The Reason for the appointment to take place.

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

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

                  ShortReason the appointment is to take place (resource)
                  Comments

                  Potentially relevant for CRD in some situations.

                  Control0..*
                  TypeReference(Condition, Procedure, Observation, ImmunizationRecommendation)
                  Is Modifierfalse
                  Must Supporttrue
                  Must Support TypesNo must-support rules about the choice of types/profiles
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  54. Appointment.priority
                  Definition

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

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

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

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

                  Control0..1
                  TypeunsignedInt
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  56. Appointment.description
                  Definition

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

                  ShortShown on a subject line in a meeting request, or appointment list
                  Control0..1
                  Typestring
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  58. Appointment.supportingInformation
                  Definition

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

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

                  Date/Time that the appointment is to take place.

                  ShortWhen appointment is to take place
                  Control0..1
                  This element is affected by the following invariants: crd-apt1
                  Typeinstant
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Must Supporttrue
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  62. Appointment.end
                  Definition

                  Date/Time that the appointment is to conclude.

                  ShortWhen appointment is to conclude
                  Control0..1
                  This element is affected by the following invariants: crd-apt2
                  Typeinstant
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Must Supporttrue
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  64. Appointment.minutesDuration
                  Definition

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

                  ShortCan be less than start/end (e.g. estimate)
                  Control0..1
                  TypepositiveInt
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  66. Appointment.slot
                  Definition

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

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

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

                  ShortThe date that this appointment was initially created
                  Comments

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

                  Control0..1
                  TypedateTime
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  70. Appointment.comment
                  Definition

                  Additional comments about the appointment.

                  ShortAdditional comments
                  Comments

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

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

                  Control0..1
                  Typestring
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  72. Appointment.patientInstruction
                  Definition

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

                  ShortDetailed information and instructions for the patient
                  Control0..1
                  Typestring
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  74. Appointment.basedOn
                  Definition

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

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

                  List of participants involved in the appointment.

                  ShortParticipants involved in appointment
                  Control2..*
                  TypeBackboneElement
                  Is Modifierfalse
                  Summaryfalse
                  Invariantsapp-1: Either the type or actor on the participant SHALL be specified (type.exists() or actor.exists())
                  ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  SlicingThis element introduces a set of slices on Appointment.participant. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ type
                  • profile @ actor.resolve()
                  • 78. Appointment.participant.id
                    Definition

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

                    ShortUnique id for inter-element referencing
                    Control0..1
                    Typestring
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    80. Appointment.participant.extension
                    Definition

                    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                    ShortAdditional content defined by implementations
                    Comments

                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                    Control0..*
                    TypeExtension
                    Is Modifierfalse
                    Summaryfalse
                    Alternate Namesextensions, user content
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    82. Appointment.participant.modifierExtension
                    Definition

                    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

                    ShortExtensions that cannot be ignored even if unrecognized
                    Comments

                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                    Control0..*
                    TypeExtension
                    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                    Summarytrue
                    Requirements

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

                    Alternate Namesextensions, user content, modifiers
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    84. 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|4.0.1)

                    Role of participant in encounter.

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

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

                    ShortPerson, Location/HealthcareService or Device
                    Control0..1
                    TypeReference(Patient, Practitioner, PractitionerRole, RelatedPerson, Device, HealthcareService, Location)
                    Is Modifierfalse
                    Must Supporttrue
                    Must Support TypesNo must-support rules about the choice of types/profiles
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    88. Appointment.participant.required
                    Definition

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

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

                    Is the Participant required to attend the appointment.

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

                    Participation status of the actor.

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

                    The Participation status of an appointment.

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

                    Participation period of the actor.

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

                    List of participants involved in the appointment.

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

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

                    ShortUnique id for inter-element referencing
                    Control0..1
                    Typestring
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    98. Appointment.participant:Patient.extension
                    Definition

                    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                    ShortAdditional content defined by implementations
                    Comments

                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                    Control0..*
                    TypeExtension
                    Is Modifierfalse
                    Summaryfalse
                    Alternate Namesextensions, user content
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    100. Appointment.participant:Patient.modifierExtension
                    Definition

                    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

                    ShortExtensions that cannot be ignored even if unrecognized
                    Comments

                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                    Control0..*
                    TypeExtension
                    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                    Summarytrue
                    Requirements

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

                    Alternate Namesextensions, user content, modifiers
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    102. Appointment.participant:Patient.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|4.0.1)

                    Role of participant in encounter.

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

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

                    ShortPerson, Location/HealthcareService or Device
                    Control0..1
                    TypeReference(CRD Patient)
                    Is Modifierfalse
                    Must Supporttrue
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    106. Appointment.participant:Patient.required
                    Definition

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

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

                    Is the Participant required to attend the appointment.

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

                    Participation status of the actor.

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

                    The Participation status of an appointment.

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

                    Participation period of the actor.

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

                    List of participants involved in the appointment.

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

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

                    ShortUnique id for inter-element referencing
                    Control0..1
                    Typestring
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    116. Appointment.participant:PrimaryPerformer.extension
                    Definition

                    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                    ShortAdditional content defined by implementations
                    Comments

                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                    Control0..*
                    TypeExtension
                    Is Modifierfalse
                    Summaryfalse
                    Alternate Namesextensions, user content
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    118. Appointment.participant:PrimaryPerformer.modifierExtension
                    Definition

                    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

                    ShortExtensions that cannot be ignored even if unrecognized
                    Comments

                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                    Control0..*
                    TypeExtension
                    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                    Summarytrue
                    Requirements

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

                    Alternate Namesextensions, user content, modifiers
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    120. Appointment.participant:PrimaryPerformer.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.

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

                    Role of participant in encounter.

                    TypeCodeableConcept
                    Is Modifierfalse
                    Summarytrue
                    Pattern Value{
                      "coding" : [{
                        "system" : "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
                        "code" : "PPRF"
                      }]
                    }
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    122. Appointment.participant:PrimaryPerformer.actor
                    Definition

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

                    ShortPerson, Location/HealthcareService or Device
                    Control0..1
                    TypeReference(CRD Practitioner, HRex PractitionerRole Profile, CRD Location)
                    Is Modifierfalse
                    Must Supporttrue
                    Must Support TypesNo must-support rules about the choice of types/profiles
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    124. Appointment.participant:PrimaryPerformer.required
                    Definition

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

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

                    Is the Participant required to attend the appointment.

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

                    Participation status of the actor.

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

                    The Participation status of an appointment.

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

                    Participation period of the actor.

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

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

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

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

                    This does not introduce a capacity for recurring appointments.

                    Control0..1
                    This element is affected by the following invariants: crd-apt1, crd-apt2
                    TypePeriod
                    Is Modifierfalse
                    Must Supporttrue
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))