Data Model Libraries
    Preparing search index...

    AppointmentParticipantComponent Class

    FHIR Specification

    • Short: Participants involved in appointment
    • Definition: List of participants involved in the appointment.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    type_?: CodeableConcept[]

    Appointment.participant.type 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 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.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    actor?: Reference

    Appointment.participant.actor Element

    FHIR Specification

    participantrequiredEnum: ParticipantrequiredEnum

    FHIR CodeSystem: Participantrequired

    required?: EnumCodeType

    Appointment.participant.required Element

    FHIR Specification

    • Short: required | optional | information-only
    • 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.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: ParticipantrequiredEnum

    participationstatusEnum: ParticipationstatusEnum

    FHIR CodeSystem: Participationstatus

    status: null | EnumCodeType

    Appointment.participant.status Element

    FHIR Specification

    • Short: accepted | declined | tentative | needs-action
    • Definition: Participation status of the actor.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: ParticipationstatusEnum

    period?: Period

    Appointment.participant.period Element

    FHIR Specification

    • Short: Participation period of the actor
    • Definition: Participation period of the actor.
    • FHIR Type: Period
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR AppointmentParticipantComponent

      • OptionaloptSourceField: string

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

      Returns undefined | AppointmentParticipantComponent

      AppointmentParticipantComponent data model or undefined for AppointmentParticipantComponent

      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('Appointment.participant.actor', ['Patient','Practitioner','PractitionerRole','RelatedPerson','Device','HealthcareService','Location',])

      InvalidTypeError for invalid data type or reference value

    • 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; 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 modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Returns undefined | string

      the id property value

    • Assigns the provided value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid value

    • Returns boolean

      true if id exists and has a value; false otherwise

    • 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

    • Determines if the extension property exists.

      Parameters

      • url: string

        the url that identifies a specific Extension

      Returns undefined | IExtension

      an Extension having 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 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

    • Returns boolean

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