Data Model Libraries
    Preparing search index...

    CareTeamParticipantComponent Class

    FHIR Specification

    • Short: Members of the team
    • Definition: Identifies all people and organizations who are expected to be involved in the care team.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    CareTeam.participant.role Element

    FHIR Specification

    • Short: Type of involvement
    • Definition: Indicates specific responsibility of an individual within the care team, such as "Primary care physician", "Trained social worker counselor", "Caregiver", etc.
    • Comment: Roles may sometimes be inferred by type of Practitioner. These are relationships that hold only within the context of the care team. General relationships should be handled as properties of the Patient resource directly. If a participant has multiple roles within the team, then there should be multiple participants.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    member?: Reference

    CareTeam.participant.member Element

    FHIR Specification

    onBehalfOf?: Reference

    CareTeam.participant.onBehalfOf Element

    FHIR Specification

    • Short: Organization of the practitioner
    • Definition: The organization of the practitioner.
    • Requirements: Practitioners can be associated with multiple organizations. This element indicates which organization they were acting on behalf of.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    coverage?: IDataType

    CareTeam.participant.coverage[x] Element

    @ChoiceDataTypesMeta('CareTeam.participant.coverage[x]', ['Period','Timing',]

    FHIR Specification

    • Short: When the member is generally available within this care team
    • Definition: When the member is generally available within this care team.
    • Comment: This is populated while creating / managing the CareTeam to ensure there is coverage when servicing CarePlan activities from the Schedule.
    • Requirements: To manage members who share the same role, but with different timing. For example, two physical therapists where one is available Monday through Friday whereas the other is available on the weekend.
    • FHIR Types: 'Period', 'Timing',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR CareTeamParticipantComponent

      • OptionaloptSourceField: string

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

      Returns undefined | CareTeamParticipantComponent

      CareTeamParticipantComponent data model or undefined for CareTeamParticipantComponent

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Member object value to the member property.

      Parameters

      • value: undefined | Reference

        the member object value

      Returns this

      this

      @ReferenceTargets('CareTeam.participant.member', ['Practitioner','PractitionerRole','RelatedPerson','Patient','Organization','CareTeam',])

      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 and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; false otherwise

    • Returns boolean

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