Data Model Libraries
    Preparing search index...

    Class AppointmentResponse

    AppointmentResponse Class

    A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.

    FHIR Specification

    • Short: A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection
    • Definition: A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.
    • FHIR Version: 5.0.0

    FHIR AppointmentResponse

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? appointment proposedNewTime? start? end? participantType? actor? participantStatus comment? recurring? occurrenceDate? recurrenceId?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getAppointment setAppointment hasAppointment getProposedNewTimeElement setProposedNewTimeElement hasProposedNewTimeElement getProposedNewTime setProposedNewTime hasProposedNewTime getStartElement setStartElement hasStartElement getStart setStart hasStart getEndElement setEndElement hasEndElement getEnd setEnd hasEnd getParticipantType setParticipantType addParticipantType hasParticipantType getActor setActor hasActor getParticipantStatusElement setParticipantStatusElement hasParticipantStatusElement getParticipantStatus setParticipantStatus hasParticipantStatus getCommentElement setCommentElement hasCommentElement getComment setComment hasComment getRecurringElement setRecurringElement hasRecurringElement getRecurring setRecurring hasRecurring getOccurrenceDateElement setOccurrenceDateElement hasOccurrenceDateElement getOccurrenceDate setOccurrenceDate hasOccurrenceDate getRecurrenceIdElement setRecurrenceIdElement hasRecurrenceIdElement getRecurrenceId setRecurrenceId hasRecurrenceId fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initParticipantType

    Constructors

    Properties

    identifier?: Identifier[]

    AppointmentResponse.identifier Element

    FHIR Specification

    • Short: External Ids for this item
    • Definition: This records identifiers associated with this appointment response 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.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    appointment: null | Reference

    AppointmentResponse.appointment Element

    FHIR Specification

    proposedNewTime?: BooleanType

    AppointmentResponse.proposedNewTime Element

    FHIR Specification

    • Short: Indicator for a counter proposal
    • Definition: Indicates that the response is proposing a different time that was initially requested. The new proposed time will be indicated in the start and end properties.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    start?: InstantType

    AppointmentResponse.start Element

    FHIR Specification

    • Short: Time from appointment, or requested new start time
    • Definition: Date/Time that the appointment is to take place, or requested new start time.
    • Comment: This may be either the same as the appointment request to confirm the details of the appointment, or alternately a new time to request a re-negotiation of the start time.
    • FHIR Type: instant
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    end?: InstantType

    AppointmentResponse.end Element

    FHIR Specification

    • Short: Time from appointment, or requested new end time
    • Definition: This may be either the same as the appointment request to confirm the details of the appointment, or alternately a new time to request a re-negotiation of the end time.
    • FHIR Type: instant
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    participantType?: CodeableConcept[]

    AppointmentResponse.participantType Element

    FHIR Specification

    • Short: Role of participant in the appointment
    • Definition: Role of participant in the appointment.
    • Comment: The role of the participant can be used to declare what the actor will be doing in the scope of the referenced 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 as specified on the referenced Appointment so that they can be matched, and subsequently updated.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    actor?: Reference

    AppointmentResponse.actor Element

    FHIR Specification

    participantStatus: null | CodeType

    AppointmentResponse.participantStatus Element

    FHIR Specification

    • Short: accepted | declined | tentative | needs-action | entered-in-error
    • Definition: Participation status of the participant. When the status is declined or tentative if the start/end times are different to the appointment, then these times should be interpreted as a requested time change. When the status is accepted, the times can either be the time of the appointment (as a confirmation of the time) or can be empty.
    • Comment: This element is labeled as a modifier because the status contains the code entered-in-error that marks the participant as not currently valid.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: 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
    • isSummary: true
    comment?: MarkdownType

    AppointmentResponse.comment Element

    FHIR Specification

    • Short: Additional comments
    • Definition: Additional comments about the appointment.
    • Comment: This comment is particularly important when the responder is declining, tentatively accepting or requesting another time to indicate the reasons why.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    recurring?: BooleanType

    AppointmentResponse.recurring Element

    FHIR Specification

    • Short: This response is for all occurrences in a recurring request
    • Definition: Indicates that this AppointmentResponse applies to all occurrences in a recurring request.
    • Comment: When a recurring appointment is requested, the participant may choose to respond to each individual occurrence, in which case AppointmentResponse.recurring should be false. If the participant chooses to respond the same way for all occurrences, they may instead use a single AppointmentResponse with recurring set to true. These may be combined as the participant chooses. For example, they may accept all occurrences (recurring = true), but then send a decline for a specific occurrence (recurring=false).
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    occurrenceDate?: DateType

    AppointmentResponse.occurrenceDate Element

    FHIR Specification

    • Short: Original date within a recurring request
    • Definition: The original date within a recurring request. This could be used in place of the recurrenceId to be more direct (or where the template is provided through the simple list of dates in Appointment.occurrenceDate).
    • FHIR Type: date
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    recurrenceId?: PositiveIntType

    AppointmentResponse.recurrenceId Element

    FHIR Specification

    • Short: The recurrence ID of the specific recurring request
    • Definition: The recurrence ID (sequence number) of the specific appointment when responding to a recurring request.
    • Comment: If the recurrence template was defined using the list of occurrenceDates then this property might not be used.
    • FHIR Type: positiveInt
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

    • Parse the provided AppointmentResponse JSON to instantiate the AppointmentResponse data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR AppointmentResponse

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to AppointmentResponse

      Returns undefined | AppointmentResponse

      AppointmentResponse data model or undefined for AppointmentResponse

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Actor object value to the actor property.

      Parameters

      • value: undefined | Reference

        the actor object value

      Returns this

      this

      @ReferenceTargets('AppointmentResponse.actor', ['Patient','Group','Practitioner','PractitionerRole','RelatedPerson','Device','HealthcareService','Location',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetAppointmentsetAppointmenthasAppointmentgetProposedNewTimeElementsetProposedNewTimeElementhasProposedNewTimeElementgetProposedNewTimesetProposedNewTimehasProposedNewTimegetStartElementsetStartElementhasStartElementgetStartsetStarthasStartgetEndElementsetEndElementhasEndElementgetEndsetEndhasEndgetParticipantTypesetParticipantTypeaddParticipantTypehasParticipantTypegetActorsetActorhasActorgetParticipantStatusElementsetParticipantStatusElementhasParticipantStatusElementgetParticipantStatussetParticipantStatushasParticipantStatusgetCommentElementsetCommentElementhasCommentElementgetCommentsetCommenthasCommentgetRecurringElementsetRecurringElementhasRecurringElementgetRecurringsetRecurringhasRecurringgetOccurrenceDateElementsetOccurrenceDateElementhasOccurrenceDateElementgetOccurrenceDatesetOccurrenceDatehasOccurrenceDategetRecurrenceIdElementsetRecurrenceIdElementhasRecurrenceIdElementgetRecurrenceIdsetRecurrenceIdhasRecurrenceIdfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitParticipantType